Get Line Properties

Retrieves the properties of a line.

 

Input Arguments

 

0

Collection Object Name

Line Name

The name of the line to examine.

 

Return Arguments

 

1

Vector

Begin Coordinate

The coordinate of the start of the line, in the active coordinate frame.

2

Vector

End Coordinate

The coordinate of the end of the line, in the active

coordinate frame.

3

Vector

Delta Components

The delta from the start to the end of the line, in the active coordinate frame.

4

Double

Length

The length of the line.

5

Double

Angle about +X from +Y in YZ plane

The angle of the line about the X axis (from the +Y axis) projected into the YZ plane.

6

Double

Angle about +Y from +Z in XZ

plane

The angle of the line about the Y axis (from the +Z

axis) projected into the XZ plane.

7

Double

Angle about +Z from +X in XY plane

The angle of the line about the Z axis (from the +X axis) projected into the XY plane.

 

Returned Status

 

SUCCESS

The line properties were retrieved successfully.

FAILURE

The specified line was not found.

 

Remarks

Sign conventions for the projected angles follow the right hand rule.