ORIENTATION Object
- Last UpdatedMar 28, 2023
- 1 minute read
This defines the orientation of a frame of reference (i.e. the directions of the XYZ axes) in the frame of reference of that defined by an origin database reference. It does not define a position.
Members
|
Name |
Type |
Purpose |
|---|---|---|
|
Alpha |
REAL Get/Set |
The Alpha component. |
|
Beta |
REAL Get/Set |
The Beta component. |
|
Gamma |
REAL Get/Set |
The Gamma component. |
|
Origin |
DBREF Get/Set |
The DB element which is the origin. |
Methods
None of these methods modifies the original object.
|
Name |
Result |
Purpose |
|---|---|---|
|
Orientation( STRING) |
ORIENTATION |
Creates an ORIENTATION from the values given. |
|
Orientation( STRING, FORMAT ) |
ORIENTATION |
Creates an ORIENTATION from the values given, in the specified FORMAT. |
|
EQ(ORIENTATION) |
BOOLEAN |
TRUE if ORIENTATIONS are equal. |
|
LT(ORIENTATION) |
BOOLEAN |
TRUE if ORIENTATION is less than argument. |
|
String(FORMAT) |
STRING |
Convert ORIENTATION to a STRING. |
|
WRT(DBREF) |
ORIENTATION |
Convert to a new ORIENTATION with respect to given DB element. |
|
XDir() |
DIRECTION |
Return X axis direction of the ORIENTATION as a DIRECTION. |
|
YDir() |
DIRECTION |
Return Y axis direction of the ORIENTATION as a DIRECTION. |
|
ZDir() |
DIRECTION |
Return Z axis direction of the ORIENTATION as a DIRECTION. |
Table 2: 1. ORIENTATION Object Methods