AVEVA™ Engineering

LINE Object

Save PDF

Save PDF

See also the POINTVECTOR object.

Members

Name	Type	Purpose
StartPosition	POSITION Get/Set	Start position of line.
EndPosition	POSITION Get/Set	End position of line.

Definition Methods

None of these methods modifies the original object.

Name	Result	Purpose
Line( POSITION first, POSITION second)	LINE	Creates a LINE between the given positions, first and second.
String()	STRING	Returns the line as a STRING.
Direction()	DIRECTION	Returns a DIRECTION representing the direction of the line.
Direction(DIRECTION way)	LINE	Creates a new line with the same start position and length but in the direction given by way.

LINE Object Methods that Return BOOLEANs

None of these methods modifies the original object.

Name	Result	Purpose
On(POSITION where)	BOOLEAN	Returns TRUE if where lies on the unbounded line.
On(POSITION where,BOOLEAN bounded)	BOOLEAN	Returns TRUE if where lies on the line, bounded indicates if the point is also checked to be on the bounded line segment.
OnProjected(POSITION where)	BOOLEAN	Returns TRUE if where, when projected onto the line, lies within the bounded line.

LINE Object Methods that Return POSITIONs

None of these methods modifies the original object.

Name	Result	Purpose
Intersection(LINE other)	POSITION	Returns the intersection point of the passed LINE on the line definition.
Intersection(POINT point, VECTOR vector)	POSITION	Returns the intersection point of the passed POINTVECTOR on the line definition.
Intersection(PLANE plane)	LINE	Returns the intersection line of plane on the line definition.
Intersections(ARC arc)	ARRAY OF POSITIONS	Returns the intersection points of arc on the line definition.
Near(POSITION position)	POSITION	Returns the nearest position on the line definition to position.
Proportion(REAL proportion)	POSITION	Returns the position at proportion along the "bounded" line from the StartPosition. Values > 1 will give positions off the end of the line. Values < 0 will give positions off the start of the line.

LINE Object Methods that Return REALs

None of these methods modifies the original object.

Name	Result	Purpose
Length()	REAL	Returns the length of the line.
Distance(LINE other)	REAL	Returns the minimum distance between the line definition and other.
Distance(POSITION position)	REAL	Returns the minimum distance between the line definition and position.

Figure 2:2. Table -48: LINE Object Methods that Return REALs

LINE Object: Miscellaneous Methods

None of these methods modifies the original object.

Name	Result	Purpose
Plane()	PLANE	Returns a plane object, using the StartPosition and Direction of line object.
Pointvector()	POINTVECTOR	Returns a POINTVECTOR object, using the StartPosition and Direction of line object.

LINE Object Methods that Return LINEs (a)

None of these methods modifies the original object.

Name	Result	Purpose
SetLengthStart(REAL length)	LINE	Returns a new line, maintaining the original StartPosition and direction, with an EndPosition to match length.
SetLengthEnd(REAL length)	LINE	Returns a new line, maintaining the original EndPosition and direction, with a StartPosition to match length.
Towards(POSITION position)	LINE	Returns a new line object with the same StartPosition and the same relative EndPosition (Length) of the original line, but the direction is from the start position to position.
From(POSITION position)	LINE	Returns a line, where the StartPosition is set position, maintaining the original EndPosition.
To(POSITION position)	LINE	Returns a line, where the EndPosition is set to position, maintaining the original StartPosition.
ExtendStart(REAL distance)	LINE	Returns a new LINE, where the StartPosition has been extended in the opposite direction of line by distance.
ExtendEnd(REAL distance)	LINE	Returns a new LINE, where the EndPosition has been extended in the direction of the line by distance.

LINE Object Methods that Return Lines (b)

Name	Result	Purpose
ExtendStart(PLANE plane)	LINE	Returns a new LINE, where the StartPosition has been extended to plane.
ExtendEnd(PLANE plane)	LINE	Returns a new LINE, where the EndPosition has been extended to plane.
ReverseSense()	LINE	Returns a line, where the StartPosition and EndPosition have been transposed.
Projected(PLANE plane)	LINE	Returns a LINE definition normalised onto plane. See picture.
Parallel(POSITION position)	LINE	Returns a parallel to the line definition of the line object, through position. All other members are copied. See picture.
Offset(DIRECTION direction, REAL offset)	LINE	Returns a parallel line to the LINE object, offset by offset from the original in the given direction. See picture.

LINE Object Methods that Return Lines (c)

Name	Result	Purpose
Overlap(LINE other)	LINE	Returns the overlapping line of two parallel lines. All positions are return projected onto the original object. See picture.
Union(LINE other)	LINE	Returns the union of LINE and other. The two are parallel lines, all positions are return projected onto the original object. See picture.

LINEARGRID Object Construction Aids

Members

Definition Methods

These methods do not modify the original object.

Name	Result	Purpose
Lineargrid( POSITION, ORIENTATION, REAL, REAL)	LINEARGRID	Creates a grid with the given POSITION, ORIENTATION, and X and Y spacing.
String()	STRING	Returns the grid as a string.

LINEARGRID Object Methods that Return POSITIONs

None of these methods modifies the original object.

Name	Result	Purpose
GridPoint(REAL, REAL)	POSITION	Returns the position at the intersection of the passed X and Y lines from the origin of the grid. Values can be +ve or -ve depending on the side of the origin.
Snap(POSITION)	POSITION	Returns the nearest intersection point to the passed position, when mapped onto the grid plane.
Snap(LINE)	POSITION	Returns the nearest intersection point to the intersection of the passed line and the grid plane.
Snap(POINTVECTOR)	POSITION	Returns the nearest intersection point to the intersection of the passed point vector and the grid plane.
SnaptoCentre(POSITION)	POSITION	Returns the nearest mesh cell center point to the passed position, when mapped onto the grid plane.
SnaptoCentre(LINE)	POSITION	Returns the nearest mesh cell center point to the intersection of the passed line and the grid plane.
SnaptoCentre(POINTVECTOR)	POSITION	Returns the nearest mesh cell center point to the intersection of the passed point vector and the grid plane.