AVEVA™ Engineering

PLANE Object

Save PDF

Save PDF

Members

Name	Type	Purpose
Orientation	ORIENTATION Get/Set	Orientation of plane.
Position	POSITION Get/Set	Origin of plane.

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	Z component of the orientation uses standard AVEVA E3D Design 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.

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.

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 1000 mm is returned with the start position being defined as described above.

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 1000 mm is returned with the start position being defined as described above.

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.