这个类是RoboDK API的接口。使用RoboDK API，您可以自动执行某些任务并对项目进行操作。与站点树中的项目的交互是通过items (IItem）.item是RoboDK树中的对象(它可以是机器人、对象、工具、框架、程序等)。更多…

# include <irobodk.h>

公共类型
枚举	｛ INS_TYPE_INVALID= -1，INS_TYPE_MOVE= 0，INS_TYPE_MOVEC= 1，INS_TYPE_CHANGESPEED= 2， INS_TYPE_CHANGEFRAME= 3，INS_TYPE_CHANGETOOL= 4，INS_TYPE_CHANGEROBOT= 5;INS_TYPE_PAUSE= 6， INS_TYPE_EVENT= 7，INS_TYPE_CODE= 8，INS_TYPE_PRINT= 9 }
	指令类型。更多…

枚举	｛ MOVE_TYPE_INVALID= -1，MOVE_TYPE_JOINT= 1，MOVE_TYPE_LINEAR= 2，MOVE_TYPE_CIRCULAR= 3， MOVE_TYPE_LINEARSEARCH= 4 }
	运动类型。更多…

枚举	｛ RUNMODE_SIMULATE= 1，RUNMODE_QUICKVALIDATE= 2，RUNMODE_MAKE_ROBOTPROG= 3，RUNMODE_MAKE_ROBOTPROG_AND_UPLOAD= 4， RUNMODE_MAKE_ROBOTPROG_AND_START= 5;RUNMODE_RUN_ROBOT= 6 }
	使用的脚本执行类型IRoboDK.setRunMode和IRoboDK。RunMode．更多…

枚举	｛PROGRAM_RUN_ON_SIMULATOR= 1，PROGRAM_RUN_ON_ROBOT= 2}
	程序执行类型。更多…

枚举	｛CALIBRATE_TCP_BY_POINT= 0，CALIBRATE_TCP_BY_PLANE= 1}
	TCP校准类型。更多…

枚举	｛ CALIBRATE_FRAME_3P_P1_ON_X= 0，CALIBRATE_FRAME_3P_P1_ORIGIN= 1，CALIBRATE_FRAME_6P= 2，CALIBRATE_TURNTABLE= 3， CALIBRATE_TURNTABLE_2X= 4 }
	参考系校准类型。更多…

枚举	｛ PROJECTION_NONE= 0，PROJECTION_CLOSEST= 1，PROJECTION_ALONG_NORMAL= 2，PROJECTION_ALONG_NORMAL_RECALC= 3， PROJECTION_CLOSEST_RECALC= 4，PROJECTION_RECALC= 5 }
	投影类型(用于AddCurve)更多…

枚举	｛ JOINT_FORMAT= -1，EULER_RX_RYp_RZpp= 0，EULER_RZ_RYp_RXpp= 1，EULER_RZ_RYp_RZpp= 2， EULER_RZ_RXp_RZpp= 3，EULER_RX_RY_RZ= 4，EULER_RZ_RY_RX= 5;EULER_QUEATERNION= 6 }
	欧拉类型。更多…

枚举	｛ WINDOWSTATE_HIDDEN= -1，WINDOWSTATE_SHOW= 0，WINDOWSTATE_MINIMIZED= 1，WINDOWSTATE_NORMAL= 2， WINDOWSTATE_MAXIMIZED= 3，WINDOWSTATE_FULLSCREEN= 4，WINDOWSTATE_CINEMA= 5;WINDOWSTATE_FULLSCREEN_CINEMA= 6， WINDOWSTATE_VIDEO= 7 }
	RoboDK窗口状态。更多…

枚举	｛ INSTRUCTION_CALL_PROGRAM= 0，INSTRUCTION_INSERT_CODE= 1，INSTRUCTION_START_THREAD= 2，INSTRUCTION_COMMENT= 3， INSTRUCTION_SHOW_MESSAGE= 4 }
	指令程序调用类型:更多…

枚举	｛FEATURE_NONE= 0，FEATURE_SURFACE= 1，FEATURE_CURVE= 2，FEATURE_POINT= 3}
	对象选择功能:更多…

枚举	｛SPRAY_OFF= 0，SPRAY_ON= 1}
	喷枪模拟:更多…

枚举	｛COLLISION_OFF= 0，COLLISION_ON= 1}
	碰撞检查状态。更多…

枚举	｛ FLAG_ROBODK_TREE_ACTIVE= 1，FLAG_ROBODK_3DVIEW_ACTIVE= 2，FLAG_ROBODK_LEFT_CLICK= 4，FLAG_ROBODK_RIGHT_CLICK= 8， FLAG_ROBODK_DOUBLE_CLICK= 16;FLAG_ROBODK_MENU_ACTIVE= 32;FLAG_ROBODK_MENUFILE_ACTIVE= 64;FLAG_ROBODK_MENUEDIT_ACTIVE= 128; FLAG_ROBODK_MENUPROGRAM_ACTIVE= 256，FLAG_ROBODK_MENUTOOLS_ACTIVE= 512，FLAG_ROBODK_MENUUTILITIES_ACTIVE= 1024，FLAG_ROBODK_MENUCONNECT_ACTIVE= 2048; FLAG_ROBODK_WINDOWKEYS_ACTIVE= 4096，FLAG_ROBODK_TREE_VISIBLE= 8192，FLAG_ROBODK_REFERENCES_VISIBLE= 16384;FLAG_ROBODK_STATUSBAR_VISIBLE= 32768， FLAG_ROBODK_NONE= 0，FLAG_ROBODK_ALL= 0xFFFF，FLAG_ROBODK_MENU_ACTIVE_ALL= flag_robodk_menu_active \| flag_robodk_menufile_active \| flag_robodk_menuedit_active \| flag_robodk_menuprogram_active \| flag_robodk_menutools_active \| flag_robodk_menuutilitties_active \| flag_robodk_menuconnect_active }
	RoboDK窗口标志。更多…

枚举	｛ FLAG_ITEM_SELECTABLE= 1，FLAG_ITEM_EDITABLE= 2，FLAG_ITEM_DRAGALLOWED= 4，FLAG_ITEM_DROPALLOWED= 8， FLAG_ITEM_ENABLED= 32;FLAG_ITEM_AUTOTRISTATE= 64;FLAG_ITEM_NOCHILDREN= 128;FLAG_ITEM_USERTRISTATE= 256， FLAG_ITEM_NONE= 0，FLAG_ITEM_ALL= 64 + 32 + 8 + 4 + 2 + 1 }
	RoboDK项目标志。更多…

枚举	｛RenderNone= 0，RenderScreen= 1，RenderUpdateOnly= 2，RenderComplete= 0xff}
	不同的渲染级别来更新屏幕。更多…

枚举	｛DrawTriangles= 1，画直线= 2，DrawPoints= 3，DrawSpheres= 4}
	在三维显示几何形状，相对于站坐标系。这应该被称为使用DrawGeometry只有当类型为EventRender的PluginEvent被触发时。更多…

公共成员功能
虚拟项	getItem(const QString &name, int itemtype=-1)=0
	根据项的名称返回项。如果没有精确匹配，它将返回最近的匹配。更多…

虚拟QStringList	getItemListNames(int过滤器= 1)= 0
	返回RoboDK中当前开放站点中所有可用项目的项目列表(名称列表或项目列表)。可选地，使用过滤器返回特定项(例如:getItemListNames(filter = ITEM_TYPE_ROBOT))更多…

虚拟QList <项>	getItemList(int过滤器= 1)= 0
	返回RoboDK中当前打开的站点中所有可用项目的项目列表(名称或指针列表)。可选地，使用过滤器返回特定项(例如:getItemListNames(filter = ITEM_CASE_ROBOT))更多…

虚拟保龄球	有效的(常量项item_check) = 0
	检查一个项目是否有效(不是空的，在开放站点可用)更多…

虚拟项	ItemUserPick(const QString &message="选择一个项目"，int itemtype=-1)=0
	显示一个RoboDK弹出选择一个对象从开放的RoboDK站。可以指定项目类型来过滤所需的项目。如果没有指定类型，则所有项都是可选择的。更多…

虚拟项	ItemUserPickconst QString &message, const QList<项> &list_choices, int id_selected=-1)=0
	显示一个RoboDK弹出选择一个对象从开放的RoboDK站。您可以提供几个项目供您选择，也可以提供一个选定的索引。更多…

虚拟空	ShowRoboDK() = 0
	显示或抬起RoboDK窗口。

虚拟空	HideRoboDK() = 0
	隐藏RoboDK窗口。RoboDK将继续在后台运行。

虚拟空	CloseRoboDK() = 0
	关闭RoboDK窗口，完成RoboDK的执行

虚拟QString	版本() = 0
	返回RoboDK的版本为4位字符串:Major.Minor.Revision.Build

虚拟空	setWindowState(int windowstate =WINDOWSTATE_NORMAL) = 0
	设置“RoboDK”窗口的状态更多…

虚拟空	setFlagsRoboDK(int旗帜=FLAG_ROBODK_ALL) = 0
	更新RoboDK标志。RoboDK标志允许定义用户对某些RoboDK特性的访问权限。使用FLAG_ROBODK_*变量设置一个或多个标志。更多…

虚拟空	setFlagsItem(int旗帜=FLAG_ITEM_ALL，项项= nullptr) = 0
	更新项目标志。项标志允许定义用户对特定于项的特性的访问权限。使用FLAG_ITEM_* flags设置一个或多个标志。更多…

虚拟int	getFlagsItem（项项)= 0
	检索当前项目标志。项标志允许定义用户对特定于项的特性的访问权限。使用FLAG_ITEM_* flags设置一个或多个标志。更多…

虚拟空	ShowMessage(const QString &message, bool popup=true)=0
	在RoboDK中显示一条消息(它可以在状态栏中阻塞或非阻塞)更多…

虚拟项	AddFileconst QString &filename项父母= nullptr) = 0
	加载文件并将其附加到父文件。它可以是RoboDK支持的任何文件。更多…

虚拟空	保存const QString &filename项itemsave = nullptr) = 0
	将项目保存到文件中。如果没有提供项目，则保存打开的站点。更多…

虚拟项	AddShape(常量tMatrix2D* trianglePoints,项addTo=nullptr, bool shapeOverride=false，tColor*颜色= nullptr) = 0
	添加提供三角形坐标的形状。三角形必须以顶点列表的形式提供。可以选择性地提供顶点法线。更多…

虚拟项	AddCurve(常量tMatrix2D* curvePoints,项referenceObject=nullptr, bool addToRef=false, int ProjectionType=PROJECTION_ALONG_NORMAL_RECALC) = 0
	添加提供点坐标的曲线。所提供的点必须是一个顶点列表。可以选择性地提供顶点法线。更多…

虚拟项	AddPoints(常量tMatrix2D*点,项referenceObject=nullptr, bool addToRef=false, int ProjectionType=PROJECTION_ALONG_NORMAL_RECALC) = 0
	向对象添加点列表。所提供的点必须是一个顶点列表。可以选择性地提供顶点法线。更多…

虚拟保龄球	ProjectPoints（tMatrix2D*点,项objectProject, int ProjectionType=PROJECTION_ALONG_NORMAL_RECALC) = 0
	投影给定坐标的点列表。所提供的点必须是一个[XYZ]坐标列表。可选的，顶点法线可以提供[XYZijk]。更多…

虚拟空	CloseStation() = 0
	关闭当前站点而不要求保存。

虚拟项	AddTarget(const QString &name;项itemparent = nullptr,项itemrobot = nullptr) = 0
	增加一个可以用机器人到达的新目标。更多…

虚拟项	AddFrame(const QString &name;项itemparent = nullptr) = 0
	添加一个可以被机器人引用的新框架。更多…

虚拟项	AddProgram(const QString &name;项itemrobot = nullptr) = 0
	添加一个可以被机器人引用的新框架。更多…

虚拟项	AddStation(QString名称)= 0
	添加一个新的空车站。它返回添加的站点项。更多…

虚拟项	AddMachiningProject(QString name="Curve follow settings"， Item itemrobot=nullptr)=0
	添加一个新的机器人加工项目。加工项目也可用于3D打印，跟随曲线和跟随点。它返回新创建的包含项目设置的Item。提示:使用宏/RoboDK/Library/Macros/MoveRobotThroughLine.py来查看一个示例，该示例创建了一个新的“曲线跟随项目”，给出了要跟随的点列表(选项4)。更多…

虚拟QList <项>	getOpenStations() = 0
	返回RoboDK中开放站点的列表。更多…

虚拟空	setActiveStation（项stn) = 0
	设置活动站点(项目当前可见)。更多…

虚拟项	getActiveStation() = 0
	返回活动的站点项(当前可见的站点)。更多…

虚拟int	调用(const QString &function_w_params)=0
	在程序输出中添加函数调用。RoboDK将在为特定机器人生成代码时处理语法。如果程序存在，它也将在模拟模式下运行程序。更多…

虚拟int	RunCode(const QString &code, bool code_is_fcn_call=false)=0
	添加要在程序输出中运行的代码。如果程序存在，它也将在模拟模式下运行程序。更多…

虚拟空	RunMessage(const QString &message, bool message_is_comment=false)=0
	在输出机器人程序中显示消息或注释。更多…

虚拟空	渲染(int旗帜=RenderComplete) = 0
	更新场景。更多…

虚拟保龄球	IsInside（项object_inside,项object_parent) = 0
	检查一个对象是否完全在另一个对象内部。更多…

虚拟int	setCollisionActive(int check_state =COLLISION_ON) = 0
	根据碰撞图打开碰撞检查ON或OFF (COLLISION_OFF/COLLISION_OFF)。如果碰撞检查被激活，它将返回当前处于碰撞状态的对象对的数量。更多…

虚拟保龄球	setCollisionActivePair(int check_state项item1,项Item2, int id1=0, int id2=0)=0
	为特定的一对对象设置碰撞检查ON或OFF (COLLISION_ON/COLLISION_OFF)。这允许更改碰撞映射以进行碰撞检查。指定机器人或移动机构的链接id (id 0是基数)。更多…

虚拟int	碰撞() = 0
	返回当前处于碰撞状态的对象对的数目。如果碰撞检查不是活动的，它将计算碰撞检查。更多…

虚拟int	碰撞（项item1,项第二条)= 0
	如果item1和item2碰撞，返回1。否则返回0。更多…

虚拟QList <项>	getCollisionItems(QList< int > *link_id_list=nullptr)=0
	返回处于冲突状态的项目列表。此函数可在调用后使用碰撞()检索处于冲突状态的项。更多…

虚拟空	setSimulationSpeed(双速)= 0
	设置当前模拟速度。将速度设置为1进行实时模拟。允许的最慢速度是实际速度的0.001倍。设置一个高值(>100)以获得快速的模拟结果。更多…

虚拟双	SimulationSpeed() = 0
	获取当前模拟速度。将速度设置为1进行实时模拟。更多…

虚拟空	setRunMode(int run_mode = 1) = 0
	设置RoboDK API的行为。默认情况下，RoboDK显示移动指令的路径模拟(run_mode=1=RUNMODE_SIMULATE)。将run_mode设置为RUNMODE_QUICKVALIDATE允许执行快速检查，以查看路径是否可行。如果使用robot.Connect()，则自动选择RUNMODE_RUN_FROM_PC。更多…

虚拟int	RunMode() = 0
	返回RoboDK API的行为。默认情况下，RoboDK显示运动指令的路径模拟(run_mode=1)。更多…

virtual QList< QPair< QString, QString > >	getParams() = 0
	从打开的RoboDK站获取所有用户参数。也可通过右键单击站点，选择“共享参数”进行参数修改。用户参数可由用户自行添加或修改更多…

虚拟QString	getParam(const QString ¶m)=0
	从打开的RoboDK站获取全局参数或用户参数。也可以通过右键单击站点，选择“共享参数”来修改参数。一些可用的参数:PATH_OPENSTATION =当前。stn文件的文件夹路径FILE_OPENSTATION =当前。stn文件的文件路径PATH_DESKTOP =用户文件夹的文件夹路径其他参数可以由用户添加或修改更多…

虚拟空	setParam(常量QString ¶m，常量QString &value)=0
	从RoboDK站设置一个全局参数。如果参数存在，则会被修改。如果没有，它将被添加到站点。也可以通过右键单击该站，选择“共享参数”来修改参数。更多…

虚拟QString	命令(const QString &cmd, const QString &value="")=0
	发送特殊命令。这些命令意味着在RoboDK中具有特定的效果，例如更改特定设置或引发特定事件。更多…

虚拟保龄球	LaserTrackerMeasure(tXYZ, const tXYZ估计，bool搜索=false)=0
	采用激光跟踪仪测量相对于它自己的参考系。如果提供了一个估计点，激光跟踪器将首先移动到这些坐标。如果search为True，跟踪器将搜索目标。更多…

虚拟保龄球	MeasurePose（垫*姿态，双数据[10]，int目标=-1,int time_avg_ms=0, const tXYZ tool_tip=nullptr)=0
	进行姿势测量(需要支持的测量系统)。更多…

虚拟保龄球	CollisionLine(const tXYZ p1, const tXYZ p2)=0
	检查线路与站内任何物体之间的碰撞。这条线由两个点组成。返回碰撞项。使用Item.Valid()检查是否存在有效的碰撞。更多…

虚拟空	CalibrateTool(常量tMatrix2Dposes_joint, tXYZ tcp_xyz, int format=EULER_RX_RY_RZ， int算法=CALIBRATE_TCP_BY_POINT，项Robot =nullptr, double error_stats=nullptr)=0
	给定一些点或校准接头，校准工具(TCP)。重要提示:如果对机器人进行了校准，请提供关节值以最大限度地提高精度。更多…

虚拟垫	CalibrateReference(常量tMatrix2D* poses_关节，int方法=CALIBRATE_FRAME_3P_P1_ON_X， bool use_joint =false;项机器人= nullptr) = 0
	给定一列点或关节值，校准参考系。重要提示:如果对机器人进行了校准，请提供关节值以最大限度地提高精度。更多…

虚拟保龄球	ProgramStart(const QString & programname, const QString &defaultfolder=""， const QString &postprocessor=""，项机器人= nullptr) = 0
	在程序生成时定义程序的名称。也可以指定后处理器的名称以及保存程序的文件夹。这个方法必须在生成任何程序输出之前调用(在任何机器人运动或其他指令之前)。更多…

虚拟空	setViewPose(常量垫姿势)= 0
	设置世界参考框架相对于用户视图(相机/屏幕)的姿态。更多…

虚拟垫	ViewPose() = 0
	获取世界参考框架相对于用户视图(相机/屏幕)的姿态。更多…

虚拟保龄球	SetRobotParams（项机器人,tMatrix2Ddhm,垫poseBase,垫poseTool) = 0
	设置机器人标称参数。更多…

虚拟项	getCursorXYZ(int x=-1, int y=-1, tXYZ xyzStation=nullptr)=0
	将光标的位置返回为XYZ坐标(默认情况下)，或窗口给定的一组2D坐标的3D位置(从左上角以像素表示的x & y坐标)。返回的XYZ坐标是相对于RoboDK站(绝对参考)给出的。如果没有提供坐标，则检索光标的当前位置。更多…

虚拟QString	许可证() = 0
	以可读字符串的形式返回许可证(与主菜单顶部的RoboDK标题栏中显示的名称相同)。更多…

虚拟QList <项>	选择() = 0
	返回所选项目的列表(可以是一个或多个项目)。更多…

虚拟项	Popup_ISO9283_CubeProgram（项机器人=nullptr, tXYZ中心=nullptr，双面=-1)=0
	显示弹出菜单创建ISO9283路径的位置精度，可重复性和路径精度性能测试。更多…

虚拟QByteArray	getData(const QString ¶m)=0
	从打开的RoboDK站获取插件定义的参数。右键单击站点，选择“共享参数”，可以查看或删除保存的参数。更多…

虚拟空	setData(const QString ¶m, const QByteArray &value)=0
	设置RoboDK站保存的数据参数。如果参数存在，则更新参数。如果没有，它将被添加到站点。右键单击站点，选择“共享参数”，可以查看或删除保存的参数。更多…

虚拟int	CollisionActive() = 0
	返回碰撞检查的状态(如果用户想要进行碰撞检查，COLLISION_ON=1;如果用户禁用碰撞检查，COLLISION_OFF=0)。更多…

虚拟保龄球	DrawGeometry(int drawtype, float vtx_pointer, int vtx_size, float color[4]， float geo_size=2.0, float vtx_normals=nullptr)=0
	在RoboDK的3D视图中绘制几何图形。这个函数只能在EventRender类型的PluginEvent中被调用。更多…

虚拟保龄球	DrawTexture(const QImage image, const float vtx_pointer, const float * texture_coordds, int num_triangle, float *vtx_normals=nullptr)=0
	在RoboDK的3D视图中绘制纹理。这个函数只能在EventRender类型的PluginEvent中被调用。更多…

虚拟空	setSelection(const QList <项> listitem) = 0
	在树中设置选择

虚拟空	setInteractiveMode/ / / / / / / / / / / /项> *custom_object=nullptr, int custom_ref_flags=0)=0
	设置交互模式来定义在RoboDK的3D视图中导航和选择项目时的行为。更多…

虚拟空	PluginLoad(const QString &plugin_name=""， int load=1)=0
	加载或卸载指定的插件(DLL、dylib或SO文件的路径)。如果插件已经加载，它将卸载插件并重新加载。传递一个空的plugin_name来重新加载所有插件。更多…

虚拟QString	PluginCommand(const QString &plugin_name=""， const QString &plugin_command=""， const QString &value="")=0
	向RoboDK插件发送特定命令。命令和值(可选)必须由插件处理。它以字符串的形式返回结果。更多…

虚拟QByteArray	getParamBytes(const QString ¶m)=0
	从打开的RoboDK站获取用户参数(字节类型)。特殊的QByteArray参数可以通过插件和脚本添加或修改(而不是由用户)。更多…

虚拟空	setParamBytes(const QString ¶m, const QByteArray &value)=0
	从打开的RoboDK站获取用户参数(字节类型)。特殊的QByteArray参数可以通过插件和脚本添加或修改(而不是由用户)。更多…

虚拟int	StereoCamera_Measure（垫pose1,垫pos2, int &npoints1, int &npoints2, double *data=nullptr, float time_avg=0, const tXYZ tip_xyz=nullptr)=0
	使用6D测量仪进行测量。它返回两个姿态，基准参考系和被测物体参考系。如果测量失败，状态为负。额外的数据是[error_avg, error_max]在毫米，如果我们平均一个姿势。更多…

虚拟项	BuildMechanism(int类型，常量QList<项> &list_obj, const双*形参tJoints&joints_build,常量tJoints&joints_home,常量tJoints&joints_senses,常量tJoints&joints_lim_low,常量tJoints&joints_lim_high,常量垫基地,常量垫工具，const QString &name项机器人= nullptr) = 0
	使用6D测量仪进行测量。它返回两个姿态，基准参考系和被测物体参考系。如果测量失败，状态为负。额外的数据是[error_avg, error_max]在毫米，如果我们平均一个姿势。更多…

虚拟项	Cam2D_Add(常量项attach_to, const QString ¶ms="")=0
	打开一个模拟的2D摄像机视图。返回一个句柄指针，在使用多个模拟视图时可以使用该句柄指针。更多…

虚拟打印大师	Cam2D_Snapshotconst QString &file项camera=nullptr, const QString ¶ms="")=0
	从模拟相机视图中获取快照并将其保存到文件中。如果成功返回1，否则返回0。更多…

虚拟项	MergeItems(const QList <项> listitem) = 0
	将多个对象项合并为一个。不删除源对象，而是创建新对象。

详细描述

这个类是RoboDK API的接口。使用RoboDK API，您可以自动执行某些任务并对项目进行操作。与站点树中的项目的交互是通过items (IItem）.item是RoboDK树中的对象(它可以是机器人、对象、工具、框架、程序等)。

行定义14的文件irobodk.h．

成员枚举文档

◆匿名的枚举

匿名的枚举

指令类型。

枚举器
INS_TYPE_INVALID	无效的指令。
INS_TYPE_MOVE	线性或关节运动指令。
INS_TYPE_MOVEC	圆周运动指令。
INS_TYPE_CHANGESPEED	设置速度指令。
INS_TYPE_CHANGEFRAME	设置参考帧指令。
INS_TYPE_CHANGETOOL	设置工具(TCP)指令。
INS_TYPE_CHANGEROBOT	设置机器人指令(过时)。
INS_TYPE_PAUSE	暂停指令。
INS_TYPE_EVENT	模拟事件指令。
INS_TYPE_CODE	程序调用或原始代码输出。
INS_TYPE_PRINT	在教学挂件上显示信息。

行定义23的文件irobodk.h．

◆匿名的枚举

匿名的枚举

指令程序调用类型:

枚举器
INSTRUCTION_CALL_PROGRAM	调用程序的指令。
INSTRUCTION_INSERT_CODE	插入原始代码的指令(这不会引发程序调用)。
INSTRUCTION_START_THREAD	启动并行线程的指令。程序将继续执行并触发一个线程。
INSTRUCTION_COMMENT	评论输出。
INSTRUCTION_SHOW_MESSAGE	指令会在机器人教学挂件上弹出一条消息。

行定义215的文件irobodk.h．

◆匿名的枚举

匿名的枚举

对象选择功能:

枚举器
FEATURE_NONE	没有选择。
FEATURE_SURFACE	表面的选择。
FEATURE_CURVE	曲线的选择。
FEATURE_POINT	点的选择。

行定义233的文件irobodk.h．

◆匿名的枚举

匿名的枚举

喷枪模拟:

枚举器
SPRAY_OFF	启动喷雾模拟。

行定义248的文件irobodk.h．

◆匿名的枚举

匿名的枚举

碰撞检查状态。

枚举器
COLLISION_OFF	不要使用碰撞检查。
COLLISION_ON	使用碰撞检查。

行定义255的文件irobodk.h．

◆匿名的枚举

匿名的枚举

RoboDK窗口标志。

枚举器
FLAG_ROBODK_TREE_ACTIVE	允许使用RoboDK站树。
FLAG_ROBODK_3DVIEW_ACTIVE	允许使用3D导航。
FLAG_ROBODK_LEFT_CLICK	允许在3D导航屏幕上左键点击。
FLAG_ROBODK_RIGHT_CLICK	允许在3D导航屏幕上右键单击。
FLAG_ROBODK_DOUBLE_CLICK	允许在3D导航屏幕上双击。
FLAG_ROBODK_MENU_ACTIVE	启用/显示菜单栏。
FLAG_ROBODK_MENUFILE_ACTIVE	启用文件菜单(FLAG_ROBODK_MENU_ACTIVE必须被允许)。
FLAG_ROBODK_MENUEDIT_ACTIVE	启用编辑菜单(FLAG_ROBODK_MENU_ACTIVE必须被允许)。
FLAG_ROBODK_MENUPROGRAM_ACTIVE	启用程序菜单(FLAG_ROBODK_MENU_ACTIVE必须被允许)。
FLAG_ROBODK_MENUTOOLS_ACTIVE	启用工具菜单(FLAG_ROBODK_MENU_ACTIVE必须被允许)。
FLAG_ROBODK_MENUUTILITIES_ACTIVE	启用实用程序菜单(FLAG_ROBODK_MENU_ACTIVE必须被允许)。
FLAG_ROBODK_MENUCONNECT_ACTIVE	启用连接菜单(必须允许FLAG_ROBODK_MENU_ACTIVE)。
FLAG_ROBODK_WINDOWKEYS_ACTIVE	允许使用键盘快捷键。
FLAG_ROBODK_TREE_VISIBLE	使树可见。
FLAG_ROBODK_REFERENCES_VISIBLE	使参照系可见。
FLAG_ROBODK_STATUSBAR_VISIBLE	使状态栏可见。
FLAG_ROBODK_NONE	禁止一切。
FLAG_ROBODK_ALL	允许一切(默认)。
FLAG_ROBODK_MENU_ACTIVE_ALL	允许使用完整菜单。

行定义264的文件irobodk.h．

◆匿名的枚举

匿名的枚举

RoboDK项目标志。

枚举器
FLAG_ITEM_SELECTABLE	允许选择RoboDK项目。
FLAG_ITEM_EDITABLE	允许修改RoboDK项目。
FLAG_ITEM_DRAGALLOWED	允许拖拽一个项目。
FLAG_ITEM_DROPALLOWED	允许掉落物品。
FLAG_ITEM_ENABLED	启用该项。
FLAG_ITEM_AUTOTRISTATE	允许有嵌套的项目，展开和折叠项目。
FLAG_ITEM_NOCHILDREN	不允许添加嵌套项。
FLAG_ITEM_NONE	禁止一切。
FLAG_ITEM_ALL	允许一切(默认)。

行定义324的文件irobodk.h．

◆匿名的枚举

匿名的枚举

不同的渲染级别来更新屏幕。

枚举器
RenderNone	不要渲染屏幕。
RenderScreen	重新显示屏幕。
RenderUpdateOnly	更新修改过的项目(机器人、参考和对象)及其子项目的所有位置。
RenderComplete	触发更新，然后屏幕显示(完整更新和呈现)。

行定义355的文件irobodk.h．

◆匿名的枚举

匿名的枚举

在三维显示几何形状，相对于站坐标系。这应该被称为使用DrawGeometry只有当类型为EventRender的PluginEvent被触发时。

枚举器
DrawTriangles	画的表面。
画直线	画线。
DrawPoints	画点。
DrawSpheres	画球体。

行定义370的文件irobodk.h．

◆匿名的枚举

匿名的枚举

运动类型。

枚举器
MOVE_TYPE_INVALID	无效的机器人运动。
MOVE_TYPE_JOINT	关节轴运动(MoveJ)。
MOVE_TYPE_LINEAR	直线运动(MoveL)。
MOVE_TYPE_CIRCULAR	圆周运动(MoveC)。
MOVE_TYPE_LINEARSEARCH	线性搜索功能。

行定义59的文件irobodk.h．

◆匿名的枚举

匿名的枚举

使用的脚本执行类型IRoboDK.setRunMode和IRoboDK。RunMode．

枚举器
RUNMODE_SIMULATE	执行移动机器人的模拟(默认)
RUNMODE_QUICKVALIDATE	执行快速检查以验证机器人的动作。
RUNMODE_MAKE_ROBOTPROG	使机器人程序。
RUNMODE_MAKE_ROBOTPROG_AND_UPLOAD	制作机器人程序并将其更新到机器人。
RUNMODE_MAKE_ROBOTPROG_AND_START	制作机器人程序并在机器人上启动(独立于PC)。
RUNMODE_RUN_ROBOT	将真正的机器人从PC移出(PC是客户端，机器人的行为像服务器)。

行定义77的文件irobodk.h．

◆匿名的枚举

匿名的枚举

程序执行类型。

枚举器
PROGRAM_RUN_ON_SIMULATOR	设置机器人程序在模拟器上运行。
PROGRAM_RUN_ON_ROBOT	设置机器人程序在机器人上运行。

行定义98的文件irobodk.h．

◆匿名的枚举

匿名的枚举

TCP校准类型。

枚举器
CALIBRATE_TCP_BY_POINT	通过接触同一点的姿势校准TCP。
CALIBRATE_TCP_BY_PLANE	通过接触同一平面的姿势校准TCP。

行定义107的文件irobodk.h．

◆匿名的枚举

匿名的枚举

参考系校准类型。

枚举器
CALIBRATE_FRAME_3P_P1_ON_X	校准3点:[X, X+， Y+] (X轴p1)。
CALIBRATE_FRAME_3P_P1_ORIGIN	校准3个点:[原点，X+， XY+] (p1为原点)。
CALIBRATE_FRAME_6P	校准6点。
CALIBRATE_TURNTABLE	调整转盘。
CALIBRATE_TURNTABLE_2X	校准一个2轴转盘。

行定义117的文件irobodk.h．

◆匿名的枚举

匿名的枚举

投影类型(用于AddCurve)

枚举器
PROJECTION_NONE	没有曲线投影。
PROJECTION_CLOSEST	投影将是表面上最近的点。
PROJECTION_ALONG_NORMAL	投影将沿着法线进行。
PROJECTION_ALONG_NORMAL_RECALC	投影将沿着法线进行。此外，法线将根据表面法线重新计算。
PROJECTION_CLOSEST_RECALC	投影将是表面上最近的点，法线将被重新计算。
PROJECTION_RECALC	根据最近投影的表面法线重新计算法线。点数不变。

行定义135的文件irobodk.h．

◆匿名的枚举

匿名的枚举

欧拉类型。

枚举器
JOINT_FORMAT	关节。
EULER_RX_RYp_RZpp	史陶比尔,Mecademic。
EULER_RZ_RYp_RXpp	ABB RobotStudio。
EULER_RZ_RYp_RZpp	川崎，爱德普，史陶比尔。
EULER_RZ_RXp_RZpp	CATIA, SolidWorks。
EULER_RX_RY_RZ	发那科，库卡，摩托曼，奈奇。
EULER_RZ_RY_RX	CRS。
EULER_QUEATERNION	ABB迅速。

行定义156的文件irobodk.h．

◆匿名的枚举

匿名的枚举

RoboDK窗口状态。

枚举器
WINDOWSTATE_HIDDEN	隐藏RoboDK窗口。RoboDK将作为一个进程继续运行。
WINDOWSTATE_SHOW	进入“RoboDK”界面。
WINDOWSTATE_MINIMIZED	最小化RoboDK窗口。
WINDOWSTATE_NORMAL	以正常状态显示RoboDK窗口(非最大化)
WINDOWSTATE_MAXIMIZED	最大化RoboDK窗口。
WINDOWSTATE_FULLSCREEN	使RoboDK窗口全屏。
WINDOWSTATE_CINEMA	显示RoboDK影院模式(隐藏工具栏和菜单)。
WINDOWSTATE_FULLSCREEN_CINEMA	显示RoboDK在影院模式和全屏。
WINDOWSTATE_VIDEO	以视频模式显示RoboDK。

行定义184的文件irobodk.h．

构造函数和析构函数文档

◆~ IRoboDK ()

虚拟~IRoboDK （）

内联虚拟

行定义18的文件irobodk.h．

成员功能文档

◆AddCurve ()

虚拟项AddCurve	（	常量tMatrix2D*	curvePoints，
		项	referenceObject＝`nullptr`，
		保龄球	addToRef＝`假`，
		int	ProjectionType＝`PROJECTION_ALONG_NORMAL_RECALC`
	）

纯虚拟

添加提供点坐标的曲线。所提供的点必须是一个顶点列表。可以选择性地提供顶点法线。

参数

curve_points	矩阵3xN或6xN -> N必须是3的倍数
reference_object	对象以添加曲线和/或将曲线投影到表面
add_to_ref	如果为True，曲线将被添加为RoboDK项目树中对象的一部分(必须提供参考对象)。
projection_type	投影类型。例如:PROJECTION_ALONG_NORMAL_RECALC将沿着点法线进行投影，并重新计算投影表面上的法向量。

返回: 添加对象/曲线(失败则为空)

◆AddFile ()

虚拟项AddFile	（	QString &	文件名，
		常量项	父＝`nullptr`
	）

纯虚拟

加载文件并将其附加到父文件。它可以是RoboDK支持的任何文件。

参数

文件名	文件的绝对路径。
父	附双亲。为新站点或在站点根加载对象保留空白。

返回: 新增对象。检查item.Valid()是否加载成功。

◆AddFrame ()

虚拟项AddFrame	（	QString &	名字，
		项	itemparent＝`nullptr`
	）

纯虚拟

添加一个可以被机器人引用的新框架。

参数

名字	参考系的名称。
itemparent	附加到的父组件(例如机器人的基础框架)。

返回: 创建新的参考系。

◆AddMachiningProject ()

虚拟项AddMachiningProject	（	QString	名字＝`“曲线跟随设置”`，
		项	itemrobot＝`nullptr`
	）

纯虚拟

添加一个新的机器人加工项目。加工项目也可用于3D打印，跟随曲线和跟随点。它返回新创建的包含项目设置的Item。提示:使用宏/RoboDK/Library/Macros/MoveRobotThroughLine.py来查看一个示例，该示例创建了一个新的“曲线跟随项目”，给出了要跟随的点列表(选项4)。

参数

名字	项目设置的名称。
itemrobot	用于项目设置的机器人(可选)。如果RoboDK站中只有一个机器人或机构可用，则不需要指定机器人。

返回

◆AddPoints ()

虚拟项AddPoints	（	常量tMatrix2D*	点，
		项	referenceObject＝`nullptr`，
		保龄球	addToRef＝`假`，
		int	ProjectionType＝`PROJECTION_ALONG_NORMAL_RECALC`
	）

纯虚拟

向对象添加点列表。所提供的点必须是一个顶点列表。可以选择性地提供顶点法线。

参数

点	作为矩阵的点列表(3xN矩阵，或6xN作为ijk向量提供点法线)
reference_object	附加新添加的几何图形的项目(可选)
add_to_ref	如果为True，这些点将作为RoboDK项目树中对象的一部分添加(必须提供参考对象)。
projection_type	投影类型。使用PROJECTION_*标志。

返回: 添加对象/形状(如果失败则为0)

◆AddProgram ()

虚拟项AddProgram	（	QString &	名字，
		项	itemrobot＝`nullptr`
	）

纯虚拟

添加一个可以被机器人引用的新框架。

参数

名字	程序的名称。
itemrobot	将要使用的机器人。

返回: 新创建的程序

◆AddShape ()

虚拟项AddShape	（	常量tMatrix2D*	trianglePoints，
		项	遭受＝`nullptr`，
		保龄球	shapeOverride＝`假`，
		tColor*	颜色＝`nullptr`
	）

纯虚拟

添加提供三角形坐标的形状。三角形必须以顶点列表的形式提供。可以选择性地提供顶点法线。

参数

trianglePoints	由三角形分组的顶点列表(3xN或6xN矩阵，N必须是3的倍数，因为顶点必须由3组堆叠)
遭受	附加新添加的几何图形的项(可选)。留空以创建新对象。
shapeOverride	设置为true以替换任何其他现有的几何图形
颜色	可选地指定颜色为RGBA [0-1]

返回: 新增或修改项目

◆AddStation ()

虚拟项AddStation （ QString 名字）

纯虚拟

添加一个新的空车站。它返回添加的站点项。

参数

名字	站点名称(标题栏将被重命名以匹配站点名称)。

◆AddTarget ()

虚拟项AddTarget	（	QString &	名字，
		项	itemparent＝`nullptr`，
		项	itemrobot＝`nullptr`
	）

纯虚拟

增加一个可以用机器人到达的新目标。

参数

名字	目标器的名称。
itemparent	附加到的父元素(如框架)。
itemrobot	主机器人，将被用来去自己的目标。

返回: 创建的新目标

◆BuildMechanism ()

虚拟项BuildMechanism	（	int	类型，
		const QList <项> &	list_obj，
		Const double *	参数，
		常量tJoints&	joints_build，
		常量tJoints&	joints_home，
		常量tJoints&	joints_senses，
		常量tJoints&	joints_lim_low，
		常量tJoints&	joints_lim_high，
		常量垫	基地，
		常量垫	工具，
		QString &	名字，
		项	机器人＝`nullptr`
	）

纯虚拟

使用6D测量仪进行测量。它返回两个姿态，基准参考系和被测物体参考系。如果测量失败，状态为负。额外的数据是[error_avg, error_max]在毫米，如果我们平均一个姿势。

参数

类型	机构类型
list_obj	构建机器人的对象项列表
参数	机器人参数的顺序与RoboDK菜单中显示的相同:Utilities-Build Mechanism或robot
joints_build	机器人的当前状态(关节轴)来构建机器人
joints_home	关节为主位置(可稍后更改)
joints_senses	每个轴的旋转感(+1或-1)
joints_lim_low	关节下限
joints_lim_high	关节上限
基地	基础位姿偏移量(机器人位姿)
工具	工具法兰位姿偏移
名字	机器人的名字
机器人	修改现有机器人

返回: 创造了新的机器人或机构。

◆CalibrateReference ()

虚拟垫CalibrateReference	（	常量tMatrix2D*	poses_joints，
		int	方法＝`CALIBRATE_FRAME_3P_P1_ON_X`，
		保龄球	use_joints＝`假`，
		项	机器人＝`nullptr`
	）

纯虚拟

给定一列点或关节值，校准参考系。重要提示:如果对机器人进行了校准，请提供关节值以最大限度地提高精度。

参数

关节	点作为3xN矩阵或nDOFsxN) -点的列表或机器人关节的列表。
方法	算法类型(按点、按平面、按…)CALIBRATE_FRAME_……
use_joints	使用点或关节值。如果使用关节值，则必须提供机器人项目。
机器人	用于机器人识别(如使用关节值)。

返回

◆CalibrateTool ()

校准工具	（	常量tMatrix2D*	poses_joints，
		tXYZ	tcp_xyz，
		int	格式＝`EULER_RX_RY_RZ`，
		int	算法＝`CALIBRATE_TCP_BY_POINT`，
		项	机器人＝`nullptr`，
		双*	error_stats＝`nullptr`
	）

纯虚拟

给定一些点或校准接头，校准工具(TCP)。重要提示:如果对机器人进行了校准，请提供关节值以最大限度地提高精度。

参数

poses_joints	给定格式的姿势矩阵或关节列表
error_stats	stats[平均值，标准差，最大值]-输出错误统计汇总。
格式	欧拉格式。可选地，使用JOINT_FORMAT并提供机器人。
算法	算法类型(按点、按平面、按…)
机器人	用于机器人识别(如使用关节值)。

返回: TCP as [x, y, z] -计算TCP

◆Cam2D_Add ()

虚拟项Cam2D_Add	（	常量项	attach_to，
		QString &	参数个数＝`”“`
	）

纯虚拟

打开一个模拟的2D摄像机视图。返回一个句柄指针，在使用多个模拟视图时可以使用该句柄指针。

返回: 相机项目

◆Cam2D_Snapshot ()

虚拟QImage Cam2D_Snapshot	（	QString &	文件，
		常量项	相机＝`nullptr`，
		QString &	参数个数＝`”“`
	）

纯虚拟

从模拟相机视图中获取快照并将其保存到文件中。如果成功返回1，否则返回0。

返回: 如果没有提供文件，则为有效QImage;如果将文件保存到磁盘，则为无效/空QImage

◆碰撞()

虚拟整型碰撞	（	项	item1，
		项	第二条
	）

纯虚拟

如果item1和item2碰撞，返回1。否则返回0。

参数

item1
第二条

返回: 如果没有发现碰撞，则返回0。

◆CollisionActive ()

虚拟int CollisionActive （）

纯虚拟

返回碰撞检查的状态(如果用户想要进行碰撞检查，COLLISION_ON=1;如果用户禁用碰撞检查，COLLISION_OFF=0)。

返回: COLLISION_ON=1或COLLISION_OFF=0

◆CollisionLine ()

virtual bool碰撞在线	（	const tXYZ	p1，
		const tXYZ	p2
	）

纯虚拟

检查线路与站内任何物体之间的碰撞。这条线由两个点组成。返回碰撞项。使用Item.Valid()检查是否存在有效的碰撞。

参数

p1	直线的起点(绝对坐标)。
p2	直线的终点(绝对坐标)。
xyz_collision	碰撞点。

返回: 如果发现碰撞，则返回。

◆碰撞()

虚整型碰撞（）

纯虚拟

返回当前处于碰撞状态的对象对的数目。如果碰撞检查不是活动的，它将计算碰撞检查。

返回: 如果没有发现碰撞，则返回0。

◆命令()

virtual QString命令	（	QString &	cmd，
		QString &	价值＝`”“`
	）

纯虚拟

发送特殊命令。这些命令意味着在RoboDK中具有特定的效果，例如更改特定设置或引发特定事件。

参数

cmd	命令名称，如跟踪、线程或窗口。
价值	命令值(可选，并非所有命令都需要值)

返回: 命令的结果。

◆DrawGeometry ()

虚拟bool DrawGeometry	（	int	drawtype，
		浮*	vtx_pointer，
		int	vtx_size，
		浮动	颜色[4],
		浮动	geo_size＝`2.0`，
		浮*	vtx_normals＝`nullptr`
	）

纯虚拟

在RoboDK的3D视图中绘制几何图形。这个函数只能在EventRender类型的PluginEvent中被调用。

参数

drawtype	几何类型(三角形、直线、点或球体)
vtx_pointer	指向以mm为单位的顶点数组的指针，相对于RoboDK站(绝对参考)
vtx_size	几何图形的大小(三角形的数量，顶点线的数量或点的数量)
颜色	颜色为RGBA [0,1]
geo_size	线或点的大小(对于曲面忽略)
vtx_normals	顶点法线作为统一向量(可选，仅用于绘制曲面)

返回: 如果成功则为True，如果输入不正确或构建不支持以双精度或单精度浮点绘制则为false

◆DrawTexture ()

虚拟bool DrawTexture	（	const QImage *	图像，
		Const float *	vtx_pointer，
		Const float *	texture_coords，
		int	num_triangles，
		浮*	vtx_normals＝`nullptr`
	）

纯虚拟

在RoboDK的3D视图中绘制纹理。这个函数只能在EventRender类型的PluginEvent中被调用。

参数

图像	指向RGBA格式的图像的指针(RGBA格式很重要)
vtx_pointer	指向以mm为单位的顶点数组的指针，相对于RoboDK站(绝对参考)
texture_coords	纹理坐标(每个顶点的二维坐标)
num_triangles	几何图形的大小(三角形的数量)
vtx_normals	作为单位向量的顶点法线(可选)

返回: 如果成功则为True，如果输入不正确或构建不支持以双精度或单精度浮点绘制则为false

◆getActiveStation ()

虚拟项getActiveStation （）

纯虚拟

返回活动的站点项(当前可见的站点)。

返回

◆getCollisionItems ()

虚拟QList <项> getCollisionItems （ QList< int > * link_id_list＝nullptr ）

纯虚拟

返回处于冲突状态的项目列表。此函数可在调用后使用碰撞()检索处于冲突状态的项。

参数

link_id_list 发生碰撞的机器人链接id列表(对象和工具为0)。

返回: 处于冲突状态的项列表。

◆getCursorXYZ ()

虚拟项getCursorXYZ	（	int	x＝`1`，
		int	y＝`1`，
		tXYZ	xyzStation＝`nullptr`
	）

纯虚拟

将光标的位置返回为XYZ坐标(默认情况下)，或窗口给定的一组2D坐标的3D位置(从左上角以像素表示的x & y坐标)。返回的XYZ坐标是相对于RoboDK站(绝对参考)给出的。如果没有提供坐标，则检索光标的当前位置。

参数

x	以像素为单位的X坐标
y	以像素为单位的Y坐标
xyzStation

返回: 项在鼠标光标下。

◆getData ()

虚拟QByteArray getData （ QString & 参数）

纯虚拟

从打开的RoboDK站获取插件定义的参数。右键单击站点，选择“共享参数”，可以查看或删除保存的参数。

参数

参数	RoboDK数据参数

返回: 数据值。

◆getFlagsItem ()

虚拟int getFlagsItem （项项）

纯虚拟

检索当前项目标志。项标志允许定义用户对特定于项的特性的访问权限。使用FLAG_ITEM_* flags设置一个或多个标志。

参数

项

返回

◆getItem ()

虚拟项getItem	（	QString &	名字，
		int	itemtype＝`1`
	）

纯虚拟

根据项的名称返回项。如果没有精确匹配，它将返回最近的匹配。

参数

名字	物品的名称
itemtype	按项目类型筛选RoboDK.ITEM_TYPE_…

返回: 如果没有找到任何项，则返回null

◆getItemList ()

虚拟QList <项> getItemList （ int 过滤器＝1 ）

纯虚拟

返回RoboDK中当前打开的站点中所有可用项目的项目列表(名称或指针列表)。可选地，使用过滤器返回特定项(例如:getItemListNames(filter = ITEM_CASE_ROBOT))

参数

过滤器 ITEM_TYPE

返回: 具有匹配项的列表

◆getItemListNames ()

gettitemlistnames （ int 过滤器＝1 ）

纯虚拟

返回RoboDK中当前开放站点中所有可用项目的项目列表(名称列表或项目列表)。可选地，使用过滤器返回特定项(例如:getItemListNames(filter = ITEM_TYPE_ROBOT))

参数

过滤器	ITEM_TYPE_……

返回: 项目名称列表

◆getOpenStations ()

虚拟QList <项> getOpenStations （）

纯虚拟

返回RoboDK中开放站点的列表。

返回

◆getParam ()

virtual QString getParam （ QString & 参数）

纯虚拟

从打开的RoboDK站获取全局参数或用户参数。也可以通过右键单击站点，选择“共享参数”来修改参数。一些可用的参数:PATH_OPENSTATION =当前。stn文件的文件夹路径FILE_OPENSTATION =当前。stn文件的文件路径PATH_DESKTOP =用户文件夹的文件夹路径其他参数可以由用户添加或修改

参数

参数 RoboDK参数

返回: 参数值。

◆getParamBytes ()

virtual QByteArray getParamBytes （ QString & 参数）

纯虚拟

从打开的RoboDK站获取用户参数(字节类型)。特殊的QByteArray参数可以通过插件和脚本添加或修改(而不是由用户)。

参数

参数 RoboDK参数

返回: 参数数据。

◆getParams ()

virtual QList< QPair< QString, QString > > getParams （）

纯虚拟

从打开的RoboDK站获取所有用户参数。也可通过右键单击站点，选择“共享参数”进行参数修改。用户参数可由用户自行添加或修改

返回: 作为形参值的字符串对的列表(列表的列表)

◆IsInside ()

virtual bool IsInside	（	项	object_inside，
		项	object_parent
	）

纯虚拟

检查一个对象是否完全在另一个对象内部。

参数

object_inside
object_parent

返回: 如果object_inside在object_parent中，则返回true

◆ItemUserPick ()(1/2)

虚拟项ItemUserPick	（	QString &	消息，
		const QList <项> &	list_choices，
		int	id_selected＝`1`
	）

纯虚拟

显示一个RoboDK弹出选择一个对象从开放的RoboDK站。您可以提供几个项目供您选择，也可以提供一个选定的索引。

参数

消息	要在弹出窗口中显示的消息
list_choices	可供选择的项目
id_selected	如果要选择一个项目，则从list_choices中选择id

返回: 如果用户选择了取消，则为选中项或nullptr

◆ItemUserPick ()(2/2)

虚拟项ItemUserPick	（	QString &	消息＝`“选一件”`，
		int	itemtype＝`1`
	）

纯虚拟

显示一个RoboDK弹出选择一个对象从开放的RoboDK站。可以指定项目类型来过滤所需的项目。如果没有指定类型，则所有项都是可选择的。

参数

消息	要在弹出窗口中显示的消息
itemtype	RoboDK可选过滤。ITEM_TYPE_ *

返回: 如果用户选择了取消，则为选中项或nullptr

◆LaserTrackerMeasure ()

虚拟bool LaserTrackerMeasure	（	tXYZ	xyz，
		const tXYZ	估计，
		保龄球	搜索＝`假`
	）

纯虚拟

采用激光跟踪仪测量相对于它自己的参考系。如果提供了一个估计点，激光跟踪器将首先移动到这些坐标。如果search为True，跟踪器将搜索目标。

参数

xyz
估计
搜索	True表示在估计值附近搜索。

返回: 如果成功，那是真的。

◆许可证()

virtual QString License （）

纯虚拟

以可读字符串的形式返回许可证(与主菜单顶部的RoboDK标题栏中显示的名称相同)。

返回

◆MeasurePose ()

virtual bool测量姿势	（	垫*	构成，
		双	数据[10],
		int	目标＝`1`，
		int	time_avg_ms＝`0`，
		const tXYZ	tool_tip＝`nullptr`
	）

纯虚拟

进行姿势测量(需要支持的测量系统)。

参数

构成	测量姿势
构成	附加返回数据[可见目标，按钮状态，平均误差，最大误差]
目标	目标类型
time_avg_ms	从缓冲中取pose的平均值
tool_tip	用于平均计算的工具尖端的XYZ位置

返回: 真则成功，假则无法衡量。

◆PluginCommand ()

virtual QString PluginCommand	（	QString &	plugin_name＝`”“`，
		QString &	plugin_command＝`”“`，
		QString &	价值＝`”“`
	）

纯虚拟

向RoboDK插件发送特定命令。命令和值(可选)必须由插件处理。它以字符串的形式返回结果。

参数

plugin_name	插件名必须与RoboDK插件中的PluginName()实现匹配。
plugin_command	插件处理的特定命令。
价值	插件处理的特定值(可选)。

◆PluginLoad ()

插件加载	（	QString &	plugin_name＝`”“`，
		int	负载＝`1`
	）

纯虚拟

加载或卸载指定的插件(DLL、dylib或SO文件的路径)。如果插件已经加载，它将卸载插件并重新加载。传递一个空的plugin_name来重新加载所有插件。

参数

plugin_name	插件的名称或路径(如果不在默认目录中)。
负载	加载插件(1/默认)或卸载(0)

◆Popup_ISO9283_CubeProgram ()

虚拟项Popup_ISO9283_CubeProgram	（	项	机器人＝`nullptr`，
		tXYZ	中心＝`nullptr`，
		双	一边＝`1`
	）

纯虚拟

显示弹出菜单创建ISO9283路径的位置精度，可重复性和路径精度性能测试。

参数

机器人
中心	立方体的中心相对于机器人基座的XYZ位置，单位是mm。
一边	立方体的边长，单位是毫米。

返回: IS9283如果用户取消，程序或nullptr。

◆ProgramStart ()

虚拟bool	（	QString &	progname，
		QString &	defaultfolder＝`”“`，
		QString &	后处理程序＝`”“`，
		项	机器人＝`nullptr`
	）

纯虚拟

在程序生成时定义程序的名称。也可以指定后处理器的名称以及保存程序的文件夹。这个方法必须在生成任何程序输出之前调用(在任何机器人运动或其他指令之前)。

参数

progname	程序的名称。
defaultfolder	文件夹保存程序，留空以使用默认的程序文件夹。
后处理程序	后处理器的名称(对于C:/RoboDK/Posts/Fanuc_post.py中的后处理器，可以提供“Fanuc_post.py”或简单地“Fanuc_post”)。
机器人	机器人连接。

返回

◆ProjectPoints ()

virtual bool项目点数	（	tMatrix2D*	点，
		项	objectProject，
		int	ProjectionType＝`PROJECTION_ALONG_NORMAL_RECALC`
	）

纯虚拟

投影给定坐标的点列表。所提供的点必须是一个[XYZ]坐标列表。可选的，顶点法线可以提供[XYZijk]。

参数

点	矩阵3xN或6xN:要投影的点的列表。这个矩阵将包含投影后的修改点。
object_project	对项目的反对。
projection_type	投影类型。例如:PROJECTION_ALONG_NORMAL_RECALC将沿着点法线进行投影，并重新计算投影表面上的法向量。

返回: 如果投影成功则为True，如果输入不正确则为False

◆呈现()

虚拟虚空渲染（ int 旗帜＝RenderComplete ）

纯虚拟

更新场景。

参数

旗帜	设置为RenderComplete进行完整的更新，或者设置为RenderScreen重新绘制场景，而不需要内部更新依赖项。

◆RunCode ()

virtual int RunCode	（	QString &	代码，
		保龄球	code_is_fcn_call＝`假`
	）

纯虚拟

添加要在程序输出中运行的代码。如果程序存在，它也将在模拟模式下运行程序。

参数

代码
code_is_fcn_call

返回

◆RunMessage ()

virtual void RunMessage	（	QString &	消息，
		保龄球	message_is_comment＝`假`
	）

纯虚拟

在输出机器人程序中显示消息或注释。

参数

消息
message_is_comment

◆RunMode ()

virtual int RunMode （）

纯虚拟

返回RoboDK API的行为。默认情况下，RoboDK显示运动指令的路径模拟(run_mode=1)。

返回: int = RUNMODE RUNMODE_SIMULATE=1执行模拟移动机器人(默认)RUNMODE_QUICKVALIDATE=2执行快速检查以验证机器人的运动RUNMODE_MAKE_ROBOTPROG=3使机器人程序RUNMODE_RUN_REAL=4移动真实机器人

◆调用()

虚拟int运行程序（ QString & function_w_params ）

纯虚拟

在程序输出中添加函数调用。RoboDK将在为特定机器人生成代码时处理语法。如果程序存在，它也将在模拟模式下运行程序。

参数

function_w_params 带参数的函数名(如果有的话)。

返回

◆Save ()

虚拟无效保存	（	QString &	文件名，
		常量项	itemsave＝`nullptr`
	）

纯虚拟

将项目保存到文件中。如果没有提供项目，则保存打开的站点。

参数

文件名	保存文件的绝对路径
itemsave	要保存的对象或站点。留空将自动保存当前站点。

◆选择()

虚拟QList <项>选择（）

纯虚拟

返回所选项目的列表(可以是一个或多个项目)。

返回: 所选项目的列表。

◆setActiveStation ()

虚拟无效setActiveStation （项 stn ）

纯虚拟

设置活动站点(项目当前可见)。

参数

站	站项，它可以预先作为RDK文件加载。

◆setCollisionActive ()

虚拟int setCollisionActive （ int check_state＝COLLISION_ON ）

纯虚拟

根据碰撞图打开碰撞检查ON或OFF (COLLISION_OFF/COLLISION_OFF)。如果碰撞检查被激活，它将返回当前处于碰撞状态的对象对的数量。

参数

check_state

返回: 处于碰撞状态的对象对数(如果没有碰撞则为0)。

◆setCollisionActivePair ()

虚拟bool setCollisionActivePair	（	int	check_state，
		项	item1，
		项	第二条，
		int	id1＝`0`，
		int	id2下＝`0`
	）

纯虚拟

为特定的一对对象设置碰撞检查ON或OFF (COLLISION_ON/COLLISION_OFF)。这允许更改碰撞映射以进行碰撞检查。指定机器人或移动机构的链接id (id 0是基数)。

参数

check_state	设置为COLLISION_ON或COLLISION_OFF
item1	第一项
第二条	第二项
id1	项目1的关节id(如果项目1是机器人或机构)
id2下	项目2的关节id(如果项目2是机器人或机构)

返回: 如果成功返回true。如果设置pair失败(提供了错误的id)则返回false

◆setData ()

虚拟void setData	（	QString &	参数，
		QByteArray &	价值
	）

纯虚拟

设置RoboDK站保存的数据参数。如果参数存在，则更新参数。如果没有，它将被添加到站点。右键单击站点，选择“共享参数”，可以查看或删除保存的参数。

参数

参数	RoboDK数据参数名称
价值	数据值

返回

◆setFlagsItem ()

虚拟无效setFlagsItem	（	int	旗帜＝`FLAG_ITEM_ALL`，
		项	项＝`nullptr`
	）

纯虚拟

更新项目标志。项标志允许定义用户对特定于项的特性的访问权限。使用FLAG_ITEM_* flags设置一个或多个标志。

参数

项
旗帜	新国旗

◆setFlagsRoboDK ()

setFlagsRoboDK （ int 旗帜＝FLAG_ROBODK_ALL ）

纯虚拟

更新RoboDK标志。RoboDK标志允许定义用户对某些RoboDK特性的访问权限。使用FLAG_ROBODK_*变量设置一个或多个标志。

参数

旗帜	窗口状态(FLAG_ROBODK_*)

◆setInteractiveMode ()

setInteractiveMode	（	int	mode_type，
		int	default_ref_flags，
		const QList <项> *	custom_object＝`nullptr`，
		int	custom_ref_flags＝`0`
	）

纯虚拟

设置交互模式来定义在RoboDK的3D视图中导航和选择项目时的行为。

参数

mode_type	模式类型定义了当3D视图被选中时发生的动作(选择对象、平移、旋转、缩放、移动对象等)。
default_ref_flags	当指定运动时，我们可以提供相对于坐标系统默认允许的运动(设置适当的标志)。
custom_object	提供一个可选项列表来定制这些特定项的移动行为(重要:custom_ref_flags的长度必须匹配)
custom_ref_flags	提供一个匹配的标志列表，以自定义特定项目的移动行为

◆setParam ()

虚拟无效setParam	（	QString &	参数，
		QString &	价值
	）

纯虚拟

从RoboDK站设置一个全局参数。如果参数存在，则会被修改。如果没有，它将被添加到站点。也可以通过右键单击该站，选择“共享参数”来修改参数。

参数

参数	RoboDK参数
价值	价值

返回

◆setParamBytes ()

虚拟无效setParamBytes	（	QString &	参数，
		QByteArray &	价值
	）

纯虚拟

从打开的RoboDK站获取用户参数(字节类型)。特殊的QByteArray参数可以通过插件和脚本添加或修改(而不是由用户)。

参数

参数	RoboDK参数
价值	数据值

◆SetRobotParams ()

虚拟bool SetRobotParams	（	项	机器人，
		tMatrix2D	dhm，
		垫	poseBase，
		垫	poseTool
	）

纯虚拟

设置机器人标称参数。

参数

机器人
dhm	D-H修改表(Denavit Hartenberg修改)
poseBase
poseTool

返回

◆setRunMode ()

虚拟无效setRunMode （ int run_mode＝1 ）

纯虚拟

设置RoboDK API的行为。默认情况下，RoboDK显示移动指令的路径模拟(run_mode=1=RUNMODE_SIMULATE)。将run_mode设置为RUNMODE_QUICKVALIDATE允许执行快速检查，以查看路径是否可行。如果使用robot.Connect()，则自动选择RUNMODE_RUN_FROM_PC。

参数

run_mode int = RUNMODE RUNMODE_SIMULATE=1执行模拟移动机器人(默认)RUNMODE_QUICKVALIDATE=2执行快速检查以验证机器人的运动RUNMODE_MAKE_ROBOTPROG=3使机器人程序RUNMODE_RUN_REAL=4移动真实机器人

◆setSimulationSpeed ()

设置模拟速度（双速度）

纯虚拟

设置当前模拟速度。将速度设置为1进行实时模拟。允许的最慢速度是实际速度的0.001倍。设置一个高值(>100)以获得快速的模拟结果。

参数

速度	仿真速比(1表示实时仿真)

◆setViewPose ()

虚拟无效setViewPose （常量垫& 构成）

纯虚拟

设置世界参考框架相对于用户视图(相机/屏幕)的姿态。

参数

构成视图构成。

◆setWindowState ()

settwindowstate （ int windowstate＝WINDOWSTATE_NORMAL ）

纯虚拟

设置“RoboDK”窗口的状态

参数

windowstate

◆ShowMessage ()

virtual void ShowMessage	（	QString &	消息，
		保龄球	弹出＝`真正的`
	）

纯虚拟

在RoboDK中显示一条消息(它可以在状态栏中阻塞或非阻塞)

参数

消息	要显示的消息
弹出	设置为true使消息阻塞，或设置为false使消息非阻塞

◆SimulationSpeed ()

虚拟双仿真速度（）

纯虚拟

获取当前模拟速度。将速度设置为1进行实时模拟。

返回: 仿真速比(1表示实时仿真)

◆StereoCamera_Measure ()

虚拟int StereoCamera_Measure	（	垫	pose1，
		垫	pose2，
		int &	npoints1，
		int &	npoints2，
		双*	数据＝`nullptr`，
		浮动	time_avg＝`0`，
		const tXYZ	tip_xyz＝`nullptr`
	）

纯虚拟

使用6D测量仪进行测量。它返回两个姿态，基准参考系和被测物体参考系。如果测量失败，状态为负。额外的数据是[error_avg, error_max]在毫米，如果我们平均一个姿势。

参数

pose1	主对象的姿态
pose2	参考对象的位姿
npoints1	物体1的可见点数
npoints2	物体2t可见的点数
状态	状态标志
数据	来自设备的其他数据
time_avg	测量一段时间，取平均值。
tip_xyz	将测量量偏移到尖端。

返回: 状态标志。

◆有效的()

virtual bool有效（常量项 item_check ）

纯虚拟

检查一个项目是否有效(不是空的，在开放站点可用)

参数

item_check 检查项目

返回: 如果条目存在，则为True，否则为false

◆ViewPose ()

虚拟垫ViewPose （）

纯虚拟

获取世界参考框架相对于用户视图(相机/屏幕)的姿态。

返回: 视图构成。

该类的文档是从以下文件生成的:

irobodk.h

公共类型

公共成员功能

详细描述

成员枚举文档

◆匿名的枚举

◆匿名的枚举

◆匿名的枚举

◆匿名的枚举

◆匿名的枚举

◆匿名的枚举

◆匿名的枚举

◆匿名的枚举

◆匿名的枚举

◆匿名的枚举

◆匿名的枚举

◆匿名的枚举

◆匿名的枚举

◆匿名的枚举

◆匿名的枚举

◆匿名的枚举

◆匿名的枚举

构造函数和析构函数文档

◆~ IRoboDK ()

成员功能文档

◆AddCurve ()

◆AddFile ()

◆AddFrame ()

◆AddMachiningProject ()

◆AddPoints ()

◆AddProgram ()

◆AddShape ()

◆AddStation ()

◆AddTarget ()

◆BuildMechanism ()

◆CalibrateReference ()

◆CalibrateTool ()

◆Cam2D_Add ()

◆Cam2D_Snapshot ()

◆碰撞()

◆CollisionActive ()

◆CollisionLine ()

◆碰撞()

◆命令()

◆DrawGeometry ()

◆DrawTexture ()

◆getActiveStation ()

◆getCollisionItems ()

◆getCursorXYZ ()

◆getData ()

◆getFlagsItem ()

◆getItem ()

◆getItemList ()

◆getItemListNames ()

◆getOpenStations ()

◆getParam ()

◆getParamBytes ()

◆getParams ()

◆IsInside ()

◆ItemUserPick ()(1/2)

◆ItemUserPick ()(2/2)

◆LaserTrackerMeasure ()

◆许可证()

◆MeasurePose ()

◆PluginCommand ()

◆PluginLoad ()

◆Popup_ISO9283_CubeProgram ()

◆ProgramStart ()

◆ProjectPoints ()

◆呈现()

◆RunCode ()

◆RunMessage ()

◆RunMode ()

◆调用()

◆Save ()

◆选择()

◆setActiveStation ()

◆setCollisionActive ()

◆setCollisionActivePair ()

◆setData ()

◆setFlagsItem ()