Software Customisation Reference Manual
Summary of Objects, Members and Methods : Object Type Details : PLANE Object
PLANE Object
Members
 
Name
Type
Purpose
Orientation
ORIENTATION Get/Set
Orientation of plane.
Position
POSITION Get/Set
Origin of plane.
Table 2: 75.
PLANE Object Members
Definition Methods
None of these methods modifies the original object.
Name
Result
Purpose
Plane(POSITION, ORIENTATION)
PLANE
Creates a PLANE with the given POSITION and ORIENTATION.
String()
STRING
Returns the plane as a string.
Direction(DIRECTION)
DIRECTION
Z component of the orientation uses standard AVEVA E3D™ method of maintaining X and Y components of the orientation.
Towards(POSITION)
NO RESULT
Modifies the direction (Z component of the orientation) member of the plane so it is directed to the position.
Table 2: 76.
PLANE Object Definition Methods
Figure 2:41.
PLANE Object Definition
PLANE Object: Methods that Return POSITIONs
 
Name
Result
Purpose
Intersection(LINE)
POSITION
Returns the intersection point of the passed infinite line on the plane definition.
Intersection(POINT
VECTOR)
POSITION
Returns the intersection point of the passed point vector on the plane definition.
Intersections(ARC)
ARRAY OF POSITIONS
Returns the intersection point of the passed arc on the plane definition.
Intersection(PLANE, PLANE)
POSITION
Returns intersection position of the three planes.
PointVector()
POINT-VECTOR
Returns a point vector at the origin of the plane with a direction equal to the normal of the plane.
ThreeDPosition(XYPOSITION)
POSITION
Returns 3D position of the XYPOSITION offset from the plane origin.
Near(POSITION)
POSITION
Returns the nearest position on the plane definition of the passed position.
Table 2: 77.
PLANE Object Methods that Return POSITIONs
Figure 2:42.
POSITIONs returned by PLANE Object Methods
PLANE Object: Methods that Return LINEs
 
Name
Result
Purpose
Line(REAL)
LINE
Returns a line of the given length in the direction of the plane normal.
Intersection(PLANE)
LINE
Returns the intersection line of the passed plane on the plane definition. The start position of the line is the origin of the plane definition projected onto the passed plane. The direction of the line is from the start to the position of the passed plane projected onto the reference plane. If the start and end points are coincident, a line of length 1000mm is returned with the start position being defined as described above.
Table 2: 78.
PLANE Object Methods that Return LINEs
Figure 2:43.
LINEs Returned from PLANE Object Methods
PLANE Object: Methods that Return XYOffsets
 
Name
Result
Purpose
XYOffset(Position)
XYPOSITION
Returns the position, mapped onto the plane, in term of an XY offset from the plane origin.
Figure 2:44.
PLANE Object Methods that Return XYOffsets
Figure 2:45.
XYPositions Returned from PLANE Object Methods
1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA Logo