Published Interface
- Last UpdatedMar 28, 2023
- 1 minute read
Similar to the pick data object, this 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.
Members
The following are the definition of the members:
|
Name |
Type |
Action |
|
.type |
STRING |
The is normally the same as the original type, but in certain instances the can be changed by some secondary process. |
|
.originalType |
STRING |
Basic type of pick on the graphics canvas, for example, ELEMENT, PLINE, PPOINT. |
|
.position |
POSITION |
Derived position. |
|
.direction |
DIRECTION |
Derived direction. |
|
.pointVector |
POINT- |
Pick vector when picking an item, as in, direction of view and the position of the direction on the viewing plane. |
|
.line |
LINE |
Picked element interpreted as a line. |
|
.plane |
PLANE |
Picked element interpreted as a plane. |
|
.arc |
ARC |
Picked element interpreted as a arc. |
|
.item |
DBREF |
Item picked, in case of multiple pick the last item. |
|
.items |
ARRAY |
All items picked in the pick. |
|
.ppoint |
REAL |
Ppoint or graphical aid number picked. |
|
.pline |
STRING |
Structural pline picked. |
|
.tubing |
STRING |
Tube type adjacent to the .item member, as in, HEAD or LEAVE. |
Methods
There are several methods avail these are:
|
Name |
Result |
Action |
|
.line() |
MODIFIES |
Evaluate line definition for current data. |
|
.arc() |
MODIFIES |
Evaluate arc definition for current data. |
|
.plane() |
MODIFIES |
Evaluate plane definition for current data. |
|
.getline() |
LINE |
Return evaluated line definition for current data, without modifying the member. |
|
.getarc() |
ARC |
Return evaluated arc definition for current data, without modifying the member. |
|
.getplane() |
PLANE |
Return evaluated plane definition for current data, without modifying the member. |