Published Interface
- Last UpdatedMar 28, 2023
- 3 minute read
The following are the main basic types of method interface into the pick type object.
All "<prompts>" are secondary prompts, these are displayed on the prompt line of the graphic views after the primary prompt which is defined in the pick packet object. These are used to signify which prompt within the prompt sequence you are up to.
Position Picking
The following methods are used to define a specific type of filtered pick which returns an edgPositionData object, the position member of the return object is populated:
|
Name |
Action |
|
stdPosition(<prompt>) |
Standard positioning pick type, derives the position from the graphical pick (pick type and method are controlled by the positioning control form). The initial position derived, will then be mapped against the active working plane (when set) then the currently defined offset method will be applied to the position. |
|
positionLinear(<prompt>) |
Positioning pick for linear elements, converts picked item into a linear element, then derives the position on the linear item. |
|
positionArc(<prompt>) |
Positioning pick for arc elements, converts the picked item into an arc, then derives the position on the arc. |
|
positionPlane(<prompt>) |
Positioning pick for plane elements, converts the picked item into a plane, then derives the position onto the plane. |
General Item Picking
The following methods are used to define a specific type of filtered pick which returns an edgPickData object.
|
Name |
Action |
|
stdElement(<prompt>) |
Standard element pick type, this will only pick database element in the graphic views. By default the standard element filters will be applied to the pick, only allowing those elements that conform to the define rule for the filter. |
|
stdAny(<prompt>) |
Standard any pick type, this will allow elements, plines, ppoints and graphical aids to be in the graphic views. By default all the standard filters will be applied to the pick. |
|
stdPpoint(<prompt>) |
Standard element pick type, this will only allow elements containing ppoints or design points to be picked in the graphic views. By default the standard ppoint filters will be applied to the pick. |
|
stdPline(<prompt>) |
Standard element pline type, this will allow only elements that have plines to be picked from in the graphic views. By default the standard pline rules will be applied. |
|
stdAid(<prompt>) |
Standard Aid element pick type, this will allow all graphical aids to be picked from the graphical views. However, graphic aids not registered within the "Construction Aid" utility will return an error. |
|
stdScreen(<prompt>) |
Standard screen pick, this will allow a pick anywhere within the graphical view to be performed. This can considered as a 2D pick within the 3D view. |
|
stdGraphics(<prompt>) |
Standard graphics pick, this will allow any graphical entity to be picked within the graphics view, i.e. database element, graphical aid, ppoint or pline. All elements, will be decomposed into one of three basic types: vertex single point at the convergence of edges edge boundary between facets facet planar surface of an item |
Database Element Interpretation
The following methods are used to define a specific type of filtered pick which returns an edgPositionData object, however, the position member of the return object is not populated:
|
Name |
Action |
|
dbLine(STRING) |
Setup for picking a linear db item, this will always try and convert the picked database element into a line. The method will try and populate the .line member of the return object. |
|
dbCircle(STRING) |
Setup for picking a circular db item, this will always try and convert the picked database element into an arc. The method will try and populate the .arc member of the return object. |
|
dbPlane(STRING) |
Setup for picking a plane db item, this will always try and convert the picked database element into a plane. The method will try and populate the .plane member of the return object. |
Miscellaneous
The following methods are used to define a specific type of filtered pick which returns an edgPositionData object, however, the position member of the return object is not populated:
|
Name |
Action |
|
stdView(STRING) |
Standard view pick, this returns the view gadget the pick is performed in. |