Published Interface
- Last UpdatedMar 28, 2023
- 2 minute read
The pick data object can be classed as being only a read-only objects, as setting the members within the object will have no effect on the operation of the event picking.
Method
The pick data object only has one method, this returns the pick data object as a picked position object.
|
Name |
Result |
Action |
|
.positionData() |
edgPositionData |
Converts the pick data into a standard event position data object. |
Members (General Picks)
The following are the definition of the members that are common to all the available picking types:
|
Name |
Type |
Action |
|
.type |
STRING |
Basic type of pick on the graphics canvas, for example, ELEMENT, PLINE, PPOINT. |
|
.tubing |
STRING |
Tube type adjacent to the .item member, as in, HEAD or LEAVE. |
|
.item |
DBREF |
Database element picked. |
|
.point |
REAL |
Ppoint or graphical aid number picked. |
|
.pline |
STRING |
Structural pline picked. |
|
.aidType |
STRING |
Basic graphical aid type picked, for example, LINE, CYLINDER. |
|
.pickLine |
POINT- |
Pick vector when picking an item, as in, direction of view and the position of the direction on the viewing plane. |
Members (Graphic Entity Picks)
The following are the definition of the members that are only populated by the graphical entity picks, these members define the basic graphical components of the item under the pick cursor:
|
Name |
Type |
Action |
|
.vertexCount |
REAL |
Number of vertices, usually only 1, zero if a graphical edge or facet is picked. |
|
.vertices |
ARRAY |
Position of vertex picked. |
|
.lineCount |
REAL |
Number of edges/lines at the vertex point, 1 if only a graphical edge is picked, zero if a facet is picked. |
|
.lines |
ARRAY |
Paired positions defining each edge/line. |
|
.facetCount |
REAL |
Number of facets bounding the picked line or vertex, 1 if only a facet is picked. |
|
.facets |
ARRAY |
Positions of each of the corners of the facets, four per facet. |