Software Customisation
Reference Manual
Summary of Objects, Members and Methods
:
Object Type Details
: DIRECTION Object
DIRECTION Object
The direction object is a 3D vector defined in the frame of reference of either the world, or a database element.
Members
Name
Type
Purpose
East
REAL
Get/Set
EAST or X component direction vector in frame of reference of the Origin element
North
REAL
Get/Set
NORTH or Y component direction vector in frame of reference of the Origin element
Up
REAL
Get/Set
UP or Z component direction vector in frame of reference of the Origin element
Origin
DBREF
Get/Set
DB element that is the origin which defines the frame of reference DIRECTION
Methods
None of these methods modifies the original object.
Name
Result
Purpose
Direction( STRING )
DIRECTION
Creates a DIRECTION with the value given by STRING.
Direction( STRING, FORMAT )
DIRECTION
Creates a DIRECTION with the value given by STRING, in the format specified.
EQ(DIRECTION)
BOOLEAN
TRUE if two directions are the same
LT(DIRECTION)
BOOLEAN
TRUE if direction is less than argument
String(FORMAT)
STRING
Convert to STRING
WRT(DBREF)
DIRECTION
Convert to a new DIRECTION with respect to a given element.
Angle(DIRECTION)
REAL
Returns the angle between the two directions
Bisect(DIRECTION)
DIRECTION
Returns the direction which is half way between the two directions
Cross(DIRECTION)
DIRECTION
Returns the cross product of the two directions
Dot(DIRECTION)
REAL
Returns the dot product of the two directions
IsParallel(DIRECTION)
BOOLEAN
Returns true if the supplied directions are parallel, false otherwise.
IsParallel(DIRECTION, REAL)
BOOLEAN
Returns true if the supplied directions are parallel according to tolerance supplied, false otherwise.
Opposite()
DIRECTION
Returns the opposite direction
Orthogonal(DIRECTION)
DIRECTION
Returns the direction orthogonal between the two directions
Projected(PLANE)
DIRECTION
Returns a direction projected onto the passed plane.
IsPerpendicular(DIRECTION)
BOOLEAN
Returns true if the supplied directions are perpendicular, false otherwise.
IsPerpendicular(DIRECTION, REAL)
BOOLEAN
Returns true if the supplied directions are perpendicular according to tolerance supplied, false otherwise.
Magnitude()
REAL
Returns the magnitude of a given direction.
Normalise()
DIRECTION
Returns the direction with a magnitude of one.
1974 to current year.
AVEVA Solutions Limited and its subsidiaries. All rights reserved.