EASY-ROB™ Application Programming Interface  v9.301
Static Public Member Functions | List of all members
ER_CAPI_USER_IO_PICK Class Reference

Method class to "pick" objects such as devices, tags, polygon, vertices, measure distances, ... More...

#include <ER_CAPI.H>

Inheritance diagram for ER_CAPI_USER_IO_PICK:
ER_CAPI_USER_IO ER_CAPI

Static Public Member Functions

static ER_DllExport int PickCruise (void)
 Enables cruise mode. More...
 
static ER_DllExport int PickBody (void)
 Enables the user to pick a body/geometry.
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport int PickTag (void)
 Enables the user to pick a tag.
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport int PickRobot (void)
 Enables the user to pick a robot or a device.
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport int PickPolyCenter (void)
 Enables the user to pick the center of a polygon.
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport int PickSnapDeviceTo (int SnapToMode=0)
 Enables the user to snap a Device to a polygon or a vertex.
Parameter SnapToMode can be one of the following values.
0 - snap device to a polygon
1 - snap device to a vertex
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport int PickSnapToolTo (int SnapToMode=0)
 Enables the user to snap a Tool to a polygon or a vertex.
Parameter SnapToMode can be one of the following values.
0 - snap device to a polygon
1 - snap device to a vertex
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport int PickSnapTagTo (int SnapToMode=0)
 Enables the user to snap a Tag to a polygon or a vertex.
Parameter SnapToMode can be one of the following values.
0 - snap device to a polygon
1 - snap device to a vertex
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport int PickSnapBodyTo (int SnapToMode=0)
 Enables the user to snap a Body to a polygon or a vertex.
Parameter SnapToMode can be one of the following values.
0 - snap device to a polygon
1 - snap device to a vertex
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport int PickPoint (void)
 Enables the user to pick a point or a vertex.
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport int PickDistancePolyCenter (int hold_first_point=0)
 Enables the user to measure the Distance between Polygons.
Parameter hold_first_point can be one of the following values.
0 - use last polygon for distance calculation
1 - keep first selected polygon for distance calculation
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport int PickDistancePoint (int hold_first_point=0)
 Enables the user to measure the Distance between Points/Vertices.
Parameter hold_first_point can be one of the following values.
0 - use last vertex for distance calculation
1 - keep first selected vertex for distance calculation
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport int PickDistanceDeviceMeasure (int hold_first_point=0)
 Enables the user to measure the Distance between Devices.
Parameter hold_first_point can be one of the following values.
0 - use last device for distance calculation
1 - keep first selected device for distance calculation
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport int PickDistanceTagMeasure (int hold_first_point=0)
 Enables the user to measure the Distance between Tags.
Parameter hold_first_point can be one of the following values.
0 - use last tag for distance calculation
1 - keep first selected tag for distance calculation
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport int Pick3PointCircleMeasure (int vertices=1, int second_circle_measure=0)
 Enables the user to measure a circle segment with three points.
Parameter vertices can be one of the following values.
1 - vertices
else - select other item such as polygon, corrsys
Parameter second_circle_measure can be one of the following values.
0 - measure first circle
1 - measure second circle
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport int PickTripplePlaneCircleMeasure (int hold_first_two_planes)
 Enables the user to measure a circle segment with three plane.
Parameter hold_first_two_planes can be one of the following values.
1 - keep the first two selected plane or poly center
0 - use last plane for intersection calculation
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport int PickDoublePlaneIntersectionLineMeasure (int hold_first_plane)
 Enables the user to measure the intersection line of two planes by picking 2 planes or poly center.
Parameter hold_first_plane can be one of the following values.
1 - keep the first selected plane or poly center
0 - use last plane for intersection calculation
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport int PickDoublePlaneEdgeFollowerMeasure (int hold_first_plane)
 Enables the user to start the edge follower by picking 2 planes or poly center.
Parameter hold_first_plane can be one of the following values.
1 - keep the first selected plane or poly center
0 - use last plane for intersection calculation
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport int PickTripplePlaneIntersectionCornerMeasure (int hold_first_two_planes)
 Enables the user to measure the intersection corner of three planes by picking 3 planes or poly center.
Parameter hold_first_two_planes can be one of the following values.
1 - keep the first two selected plane or poly center
0 - use last plane for intersection calculation
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport int Get_cPickMode (void)
 Return the current Picking Mode
See also Get_cPickMode_Chk_1(), Get_cPickMode_Chk_2()
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport int Get_cPickMode_Chk_1 (void)
 Returns the current Chk_1 box status in the Navigator Window
The content depends on the current Picking Mode.
See also Get_cPickMode(), Get_cPickedItem() More...
 
static ER_DllExport int Get_cPickMode_Chk_2 (void)
 Returns the current Chk_2 box status in the Navigator Window
The content depends on the current Picking Mode.
See also Get_cPickMode(), Get_cPickedItem() More...
 
static ER_DllExport int Get_cPickedItem (void)
 Returns picked item MP_HIT_INVALID ... MP_HIT_CADPREVIEW
The picked item can be one of the following values.
MP_HIT_INVALID invalid item picked
MP_HIT_ROBOT geometry from robot group picked
MP_HIT_TOOL geometry from tool group picked
MP_HIT_BODY geometry from body group picked
MP_HIT_TAG tag picked
MP_HIT_POLY center of polygon picked (normal available)
MP_HIT_LINE line picked
MP_HIT_POINT point picked
MP_HIT_COORSYS geometry coorsys or element picked
MP_HIT_CADPREVIEW geometry in CAD Preview picked
MP_HIT_MEASURE Coorsys picked
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 
static ER_DllExport float * Get_cPickResults (int result_idx)
 Returns the picking result
The result_idx can be one of the following values.
PICK_RESULT_DEFAULT same as iPOINTS
PICK_RESULT_oPOINTS position w.r.t. obj
PICK_RESULT_oNORMALS normal w.r.t. obj
PICK_RESULT_iPOINTS position w.r.t. inertia system
PICK_RESULT_iNORMALS normal w.r.t. inertia system
PICK_RESULT_idXYZ distance w.r.t. inertia system
PICK_RESULT_DISTANCE lengths of idXYZ
PICK_RESULT_CIRCLE_iCENTER circle center
PICK_RESULT_CIRCLE_iNORMAL circle normal
PICK_RESULT_CIRCLE_RADIUS circle radius
PICK_RESULT_CIRCLE_PHI circle phi
PICK_RESULT_CIRCLE_ARC circle arc
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults(). More...
 

Additional Inherited Members

- Static Public Attributes inherited from ER_CAPI_USER_IO
static ER_CAPI_USER_IO_FILE er_capi_user_io_file
 Method class to load and save work cells-, robots-, tool-files, etc. More...
 
static ER_CAPI_USER_IO_DIALOG er_capi_user_io_dialog
 Method class, supplies dialogs, i.e. to enter and show values. More...
 
static ER_CAPI_USER_IO_PICK er_capi_user_io_pick
 Method class to "pick" objects such as devices, tags, polygon, vertices, measure distances, ... More...
 
static ER_CAPI_USER_IO_CRUISE er_capi_user_io_cruise
 Method class to manipulate the 3D Scene. More...
 
static ER_CAPI_USER_IO_3DPDF er_capi_user_io_3dpdf
 Method class for 3D Pdf Export. More...
 
- Static Public Attributes inherited from ER_CAPI
static ER_CAPI_USER_IO er_capi_user_io
 Method class for interaction with EASY-ROB. More...
 
static ER_CAPI_DEVICES er_capi_devices
 Method class to create, attach, update devices, for kinematics calculations and for trajectory planning and -execution. More...
 
static ER_CAPI_SIM er_capi_sim
 Method class for simulation settings. More...
 
static ER_CAPI_TARGETS er_capi_targets
 Method class for paths and tags. More...
 
static ER_CAPI_CAD er_capi_cad
 Method class for for 3D CAD Data import and -export, changing attributes and positions. More...
 
static ER_CAPI_SYS er_capi_sys
 Method class for mathematical calculations, simulation status, units. More...
 

Detailed Description

Method class to "pick" objects such as devices, tags, polygon, vertices, measure distances, ...

Member Function Documentation

◆ Get_cPickedItem()

static ER_DllExport int ER_CAPI_USER_IO_PICK::Get_cPickedItem ( void  )
static

Returns picked item MP_HIT_INVALID ... MP_HIT_CADPREVIEW
The picked item can be one of the following values.
MP_HIT_INVALID invalid item picked
MP_HIT_ROBOT geometry from robot group picked
MP_HIT_TOOL geometry from tool group picked
MP_HIT_BODY geometry from body group picked
MP_HIT_TAG tag picked
MP_HIT_POLY center of polygon picked (normal available)
MP_HIT_LINE line picked
MP_HIT_POINT point picked
MP_HIT_COORSYS geometry coorsys or element picked
MP_HIT_CADPREVIEW geometry in CAD Preview picked
MP_HIT_MEASURE Coorsys picked
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

// Example:
char *PickedItem[] = {"0-MP_HIT_INVALID" , "1-MP_HIT_ROBOT" , "2-MP_HIT_TOOL" , "3-MP_HIT_BODY" ,
"4-MP_HIT_TAG" , "5-MP_HIT_POLY", "6-MP_HIT_LINE", "7-MP_HIT_POINT", "8-MP_HIT_COORSYS",
"9-MP_HIT_CADPREVIEW", "10-MP_HIT_MEASURE", "?", "?"};
char *PickMode[] = {"0-MP_INVALID" , "1-MP_SEL_BODY" , "2-MP_POINT" , "3-MP_DISTANCE",
"4-MP_DISTANCE_DEVICE", "5-MP_CIRCLE_CENTER",
"6-MP_TRIPPLE_PLANE_CIRCLE", "7-MP_DOUBLE_PLANE_LINE", "8-MP_DOUBLE_PLANE_EDGE_FOLLOWER", "9-MP_TRIPPLE_PLANE_CORNER", "?", "?"};
int cPickItem = er_user_io_pick.Get_cPickedItem();
int cPickMode = er_user_io_pick.Get_cPickMode();
er_user_io_dialog._info_line_msg(0,"cPickedItem= %s cPickMode= %s chk_1 %d Chk_2 %d",
PickedItem[cPickItem],PickMode[cPickMode],chk_1,chk_2);
if (cPickItem==MP_HIT_POINT)
{
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POINT opos",opos,DIM,m2mm);
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POINT ipos",ipos,DIM,m2mm);
if (cPickMode==MP_DISTANCE)
{
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POINT dxyz",dxyz,DIM,m2mm);
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POINT dist",dist,1,m2mm);
}
else if (cPickMode==MP_CIRCLE_CENTER)
{
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POINT $iCxyz",icc,DIM,m2mm);
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POINT $iCnorm",icn,DIM,1);
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POINT $CRadius",cradius,1,m2mm);
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POINT $CPhi",cphi,1,DEG);
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POINT $CArc",carc,1,m2mm);
}
}
else if (cPickItem==MP_HIT_POLY)
{
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POLY opos",opos,DIM,m2mm);
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POLY onorm",onorm,DIM,m2mm);
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POLY ipos",ipos,DIM,m2mm);
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POLY inorm",inorm,DIM,m2mm);
if (cPickMode==MP_DISTANCE)
{
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POLY dxyz",dxyz,DIM,m2mm);
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POLY dist",dist,1,m2mm);
}
else if (cPickMode==MP_CIRCLE_CENTER || cPickMode==MP_TRIPPLE_PLANE_CIRCLE)
{
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POLY $iCxyz",icc,DIM,m2mm);
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POLY $iCnorm",icn,DIM,1);
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POLY $CRadius",cradius,1,m2mm);
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POLY $CPhi",cphi,1,DEG);
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_POLY $CArc",carc,1,m2mm);
}
else if (cPickMode==MP_DOUBLE_PLANE_LINE)
{
}
else if (cPickMode==MP_DOUBLE_PLANE_EDGE_FOLLOWER)
{
}
else if (cPickMode==MP_TRIPPLE_PLANE_CORNER)
{
}
}
else if (cPickItem==MP_HIT_ROBOT)
{
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_ROBOT ipos",ipos,DIM,m2mm);
}
else if (cPickItem==MP_HIT_TOOL)
{
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_TOOL ipos",ipos,DIM,m2mm);
}
else if (cPickItem==MP_HIT_BODY)
{
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_BODY ipos",ipos,DIM,m2mm);
}
else if (cPickItem==MP_HIT_TAG)
{
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_TAG ipos",ipos,DIM,m2mm);
}
else if (cPickItem==MP_HIT_LINE)
{
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_LINE ipos",ipos,DIM,m2mm);
}
else if (cPickItem==MP_HIT_COORSYS)
{
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_COORSYS ipos",ipos,DIM,m2mm);
}
else if (cPickItem==MP_HIT_CADPREVIEW)
{
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_CADPREVIEW ipos",ipos,DIM,m2mm);
}
else if (cPickItem==MP_HIT_MEASURE)
{
er_user_io_dialog._info_line_msg_v(0,"MP_HIT_MEASURE ipos",ipos,DIM,m2mm);
}
else
er_user_io_dialog.AfxMessageBox("Select a Vertex");
...
Return values
0- ER_OK

◆ Get_cPickMode()

static ER_DllExport int ER_CAPI_USER_IO_PICK::Get_cPickMode ( void  )
static

Return the current Picking Mode
See also Get_cPickMode_Chk_1(), Get_cPickMode_Chk_2()
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Return values
0- MP_INVALID (Cruise Mode)
1- MP_SEL_BODY
2- MP_POINT
3- MP_DISTANCE
4- MP_DISTANCE_DEVICE
5- MP_CIRCLE_CENTER
6- MP_TRIPPLE_PLANE_CIRCLE
7- MP_DOUBLE_PLANE_LINE
8- MP_DOUBLE_PLANE_EDGE_FOLLOWER
9- MP_TRIPPLE_PLANE_CORNER

◆ Get_cPickMode_Chk_1()

static ER_DllExport int ER_CAPI_USER_IO_PICK::Get_cPickMode_Chk_1 ( void  )
static

Returns the current Chk_1 box status in the Navigator Window
The content depends on the current Picking Mode.
See also Get_cPickMode(), Get_cPickedItem()

Return values
0- not checked
1- checked

◆ Get_cPickMode_Chk_2()

static ER_DllExport int ER_CAPI_USER_IO_PICK::Get_cPickMode_Chk_2 ( void  )
static

Returns the current Chk_2 box status in the Navigator Window
The content depends on the current Picking Mode.
See also Get_cPickMode(), Get_cPickedItem()

Return values
0- not checked
1- checked

◆ Get_cPickResults()

static ER_DllExport float* ER_CAPI_USER_IO_PICK::Get_cPickResults ( int  result_idx)
static

Returns the picking result
The result_idx can be one of the following values.
PICK_RESULT_DEFAULT same as iPOINTS
PICK_RESULT_oPOINTS position w.r.t. obj
PICK_RESULT_oNORMALS normal w.r.t. obj
PICK_RESULT_iPOINTS position w.r.t. inertia system
PICK_RESULT_iNORMALS normal w.r.t. inertia system
PICK_RESULT_idXYZ distance w.r.t. inertia system
PICK_RESULT_DISTANCE lengths of idXYZ
PICK_RESULT_CIRCLE_iCENTER circle center
PICK_RESULT_CIRCLE_iNORMAL circle normal
PICK_RESULT_CIRCLE_RADIUS circle radius
PICK_RESULT_CIRCLE_PHI circle phi
PICK_RESULT_CIRCLE_ARC circle arc
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Parameters
[in]result_idx
Return values
pickingresult

◆ Pick3PointCircleMeasure()

static ER_DllExport int ER_CAPI_USER_IO_PICK::Pick3PointCircleMeasure ( int  vertices = 1,
int  second_circle_measure = 0 
)
static

Enables the user to measure a circle segment with three points.
Parameter vertices can be one of the following values.
1 - vertices
else - select other item such as polygon, corrsys
Parameter second_circle_measure can be one of the following values.
0 - measure first circle
1 - measure second circle
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Parameters
[in]vertices
[in]second_circle_measure
Return values
0- ER_OK

◆ PickBody()

static ER_DllExport int ER_CAPI_USER_IO_PICK::PickBody ( void  )
static

Enables the user to pick a body/geometry.
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Return values
0- ER_OK

◆ PickCruise()

static ER_DllExport int ER_CAPI_USER_IO_PICK::PickCruise ( void  )
static

Enables cruise mode.

Return values
0- ER_OK

◆ PickDistanceDeviceMeasure()

static ER_DllExport int ER_CAPI_USER_IO_PICK::PickDistanceDeviceMeasure ( int  hold_first_point = 0)
static

Enables the user to measure the Distance between Devices.
Parameter hold_first_point can be one of the following values.
0 - use last device for distance calculation
1 - keep first selected device for distance calculation
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Parameters
[in]hold_first_point
Return values
0- ER_OK

◆ PickDistancePoint()

static ER_DllExport int ER_CAPI_USER_IO_PICK::PickDistancePoint ( int  hold_first_point = 0)
static

Enables the user to measure the Distance between Points/Vertices.
Parameter hold_first_point can be one of the following values.
0 - use last vertex for distance calculation
1 - keep first selected vertex for distance calculation
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Parameters
[in]hold_first_point
Return values
0- ER_OK

◆ PickDistancePolyCenter()

static ER_DllExport int ER_CAPI_USER_IO_PICK::PickDistancePolyCenter ( int  hold_first_point = 0)
static

Enables the user to measure the Distance between Polygons.
Parameter hold_first_point can be one of the following values.
0 - use last polygon for distance calculation
1 - keep first selected polygon for distance calculation
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Parameters
[in]hold_first_point
Return values
0- ER_OK

◆ PickDistanceTagMeasure()

static ER_DllExport int ER_CAPI_USER_IO_PICK::PickDistanceTagMeasure ( int  hold_first_point = 0)
static

Enables the user to measure the Distance between Tags.
Parameter hold_first_point can be one of the following values.
0 - use last tag for distance calculation
1 - keep first selected tag for distance calculation
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Parameters
[in]hold_first_point
Return values
0- ER_OK

◆ PickDoublePlaneEdgeFollowerMeasure()

static ER_DllExport int ER_CAPI_USER_IO_PICK::PickDoublePlaneEdgeFollowerMeasure ( int  hold_first_plane)
static

Enables the user to start the edge follower by picking 2 planes or poly center.
Parameter hold_first_plane can be one of the following values.
1 - keep the first selected plane or poly center
0 - use last plane for intersection calculation
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Parameters
[in]hold_first_plane
Return values
0- ER_OK

◆ PickDoublePlaneIntersectionLineMeasure()

static ER_DllExport int ER_CAPI_USER_IO_PICK::PickDoublePlaneIntersectionLineMeasure ( int  hold_first_plane)
static

Enables the user to measure the intersection line of two planes by picking 2 planes or poly center.
Parameter hold_first_plane can be one of the following values.
1 - keep the first selected plane or poly center
0 - use last plane for intersection calculation
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Parameters
[in]hold_first_plane
Return values
0- ER_OK

◆ PickPoint()

static ER_DllExport int ER_CAPI_USER_IO_PICK::PickPoint ( void  )
static

Enables the user to pick a point or a vertex.
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Return values
0- ER_OK

◆ PickPolyCenter()

static ER_DllExport int ER_CAPI_USER_IO_PICK::PickPolyCenter ( void  )
static

Enables the user to pick the center of a polygon.
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Return values
0- ER_OK

◆ PickRobot()

static ER_DllExport int ER_CAPI_USER_IO_PICK::PickRobot ( void  )
static

Enables the user to pick a robot or a device.
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Return values
0- ER_OK

◆ PickSnapBodyTo()

static ER_DllExport int ER_CAPI_USER_IO_PICK::PickSnapBodyTo ( int  SnapToMode = 0)
static

Enables the user to snap a Body to a polygon or a vertex.
Parameter SnapToMode can be one of the following values.
0 - snap device to a polygon
1 - snap device to a vertex
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Parameters
[in]SnapToMode
Return values
0- ER_OK

◆ PickSnapDeviceTo()

static ER_DllExport int ER_CAPI_USER_IO_PICK::PickSnapDeviceTo ( int  SnapToMode = 0)
static

Enables the user to snap a Device to a polygon or a vertex.
Parameter SnapToMode can be one of the following values.
0 - snap device to a polygon
1 - snap device to a vertex
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Parameters
[in]SnapToMode
Return values
0- ER_OK

◆ PickSnapTagTo()

static ER_DllExport int ER_CAPI_USER_IO_PICK::PickSnapTagTo ( int  SnapToMode = 0)
static

Enables the user to snap a Tag to a polygon or a vertex.
Parameter SnapToMode can be one of the following values.
0 - snap device to a polygon
1 - snap device to a vertex
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Parameters
[in]SnapToMode
Return values
0- ER_OK

◆ PickSnapToolTo()

static ER_DllExport int ER_CAPI_USER_IO_PICK::PickSnapToolTo ( int  SnapToMode = 0)
static

Enables the user to snap a Tool to a polygon or a vertex.
Parameter SnapToMode can be one of the following values.
0 - snap device to a polygon
1 - snap device to a vertex
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Parameters
[in]SnapToMode
Return values
0- ER_OK

◆ PickTag()

static ER_DllExport int ER_CAPI_USER_IO_PICK::PickTag ( void  )
static

Enables the user to pick a tag.
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Return values
0- ER_OK

◆ PickTripplePlaneCircleMeasure()

static ER_DllExport int ER_CAPI_USER_IO_PICK::PickTripplePlaneCircleMeasure ( int  hold_first_two_planes)
static

Enables the user to measure a circle segment with three plane.
Parameter hold_first_two_planes can be one of the following values.
1 - keep the first two selected plane or poly center
0 - use last plane for intersection calculation
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Parameters
[in]hold_first_two_planes
Return values
0- ER_OK

◆ PickTripplePlaneIntersectionCornerMeasure()

static ER_DllExport int ER_CAPI_USER_IO_PICK::PickTripplePlaneIntersectionCornerMeasure ( int  hold_first_two_planes)
static

Enables the user to measure the intersection corner of three planes by picking 3 planes or poly center.
Parameter hold_first_two_planes can be one of the following values.
1 - keep the first two selected plane or poly center
0 - use last plane for intersection calculation
Remarks
The exported function EXPORT_C AuxUpdate(int idx) is called from EASY-ROB with the idx AUX_UPDATE_IDX_SELECTION_HIT or AUX_UPDATE_IDX_SELECTION_NOHIT
In case of AUX_UPDATE_IDX_SELECTION_HIT the picked item can be obtained using Get_cPickedItem() and Get_cPickResults().

Parameters
[in]hold_first_two_planes
Return values
0- ER_OK

The documentation for this class was generated from the following file: