POSITION Object
- Last UpdatedMar 28, 2023
- 3 minute read
Members
|
Name |
Type |
Purpose |
|---|---|---|
|
East |
REAL Get/Set |
The East component. |
|
North |
REAL Get/Set |
The North component. |
|
Up |
REAL Get/Set |
The Up component. |
|
Origin |
DBREF Get/Set |
The DB element that is the origin. |
Methods
|
Name |
Result |
Purpose |
|---|---|---|
|
Position(STRING ) |
POSITION |
Creates a POSITION at the coordinates given in STRING. |
|
Position(STRING, FORMAT) |
POSITION |
Creates a POSITION at the coordinates given in STRING, with the specified FORMAT. |
|
Component(DIRECTION) |
REAL |
Magnitude of component in specified DIRECTION. |
|
EQ(POSITION) |
BOOLEAN |
TRUE if POSITIONS are the same. |
|
LT(POSITION) |
BOOLEAN |
TRUE if POSITION is less than argument. |
|
String(FORMAT) |
STRING |
Convert POSITION to a STRING. |
|
WRT(DBREF) |
POSITION |
Convert to a new POSITION with respect to given DB element. |
|
Angle (POSITION, POSITION) |
REAL |
Returns the angle between the passed two points about the position object. |
|
ArcCentre(POSITION, POSITION, POSITION, DIRECTION, REAL ) |
ARC |
Returns an arc using arc center technique. The direction is the ‘normal viewing’ direction. |
|
ArcCentre(POSITION, POSITION, POSITION, DIRECTION, REAL) |
ARC |
Returns an arc using arc center technique. The direction is the ‘normal viewing’ direction. Please see diagram for full explanation. |
|
Name |
Result |
Purpose |
|---|---|---|
|
ArcFillet( POSITION, POSITION, DIRECTION, REAL ) |
ARC |
Returns an arc using arc center technique. The direction is the ‘normal viewing’ direction. Please see diagram for full explanation. |
|
ArcRadius( POSITION, POSITION, DIRECTION, REAL, BOOLEAN ) |
ARC |
Returns an arc using arc radius technique. The direction is the ‘normal viewing’ direction. The boolean selects the minor (FALSE) or major (TRUE) arc. For a full explanation, see the diagram. |
Figure 2:3. !Arc = !posX.ArcRadius(!posA,!posB,!dir,radius,!major)
|
Name |
Result |
Purpose |
|---|---|---|
|
ArcThru( POSITION, |
ARC |
Returns an arc using arc through 3 points technique. The direction is the ‘normal viewing’ direction. For a full explanation, see the diagram. |
|
Name |
Result |
Purpose |
|---|---|---|
|
ArcThru( POSITION, POSITION, DIRECTION, REAL ) |
ARC |
Returns an arc using arc through 3 points and radius technique. The direction is the ‘normal viewing’ direction. For a full explanation, see the diagram. |
|
Name |
Result |
Purpose |
|---|---|---|
|
Arc3Lines( LINE, LINE, LINE, DIRECTION ) |
ARC |
Returns a circle through the 3 line tangent points. The 'this' position refers to the zone in which the circle lies. |
|
Direction(POSITION) |
BOOLEAN |
Returns the direction between the position and the supplied position. |
|
Distance(ARC) |
REAL |
Returns the distance between the position and the nearest point on the arc line of the passed arc definition. |
|
MidPoint(POSITION) |
POSITION |
Returns the mid point between the two positions. |
|
Near(POSITION, REAL) |
BOOLEAN |
Returns true if the passed position is within the passed distance from the position object. |
|
Offset(DIRECTION, REAL) |
POSITION |
Returns a position offset by the supplied length in the supplied direction. |
|
Plane(POSITION, POSITION) |
PLANE |
Returns a plane in which each of the supplied points lie. |
|
Distance(LINE) |
REAL |
Returns the distance between the position and the nearest point on the passed infinite line definition. |
|
Distance(PLANE) |
REAL |
Returns the distance between the position and the nearest point on the passed plane definition. |
|
Distance(POSITION) |
REAL |
Returns the distance between the two positions. |
|
Line(POSITION) |
LINE |
Returns a line between the two positions, starting at the position object. |
|
MidPoint(POSITION) |
POSITION |
Returns the mid point between the two positions. |
|
Near(POSITION, REAL) |
BOOLEAN |
Returns true if the passed position is within the passed distance from the position object. |
|
Offset(DIRECTION, REAL) |
POSITION |
Returns a position offset by the supplied length in the supplied direction. |
|
Plane(POSITION, POSITION) |
PLANE |
Returns a plane in which each of the supplied points lie. |