LineGeometry.PointAlongLine3D Methods
Returns a Point along the LineGeometry.
Thread safety: This method is not thread-safe. Show
Overload List
| Name | Description | |
|---|---|---|
| Public method | PointAlongLine3D(System.Int32 startNode, System.Double distance) | Returns a Point along the LineGeometry. |
 Public method | PointAlongLine3D(System.Int32 startNode, System.Double distance, out System.Int32 segment, out System.Double angle, out System.Double pitch) | Returns a Point along the LineGeometry. |
PointAlongLine3D(System.Int32 startNode, System.Double distance)
Returns a Point along the LineGeometry.Syntax
public Point PointAlongLine3D (
System.Int32 startNode,
System.Double distance
)Parameters
startNode
Type: System.Int32
The index of the node that distance is specified from.
The index of the node that distance is specified from.
distance
Type: System.Double
Distance from startNode along the line where the point will be offset. A negative value means moving backwards along the line from startNode. Unit: same as the coordinates of the line geometry.
Distance from startNode along the line where the point will be offset. A negative value means moving backwards along the line from startNode. Unit: same as the coordinates of the line geometry.
Return Value
Type: Point
A point that lies distance along the line from startNode. The point will be clamped to the start or end of the line if distance added to the distance to the startNode is less than 0 or greater than the length of the line.
A point that lies distance along the line from startNode. The point will be clamped to the start or end of the line if distance added to the distance to the startNode is less than 0 or greater than the length of the line.
Remarks
This method throws an exception if there is less than two points in the geometry or if the index is out of bounds.
PointAlongLine3D(System.Int32 startNode, System.Double distance, out System.Int32 segment, out System.Double angle, out System.Double pitch)
Returns a Point along the LineGeometry.Syntax
public Point PointAlongLine3D (
System.Int32 startNode,
System.Double distance,
out System.Int32 segment,
out System.Double angle,
out System.Double pitch
)Parameters
startNode
Type: System.Int32
The index of the node that distance is specified from.
The index of the node that distance is specified from.
distance
Type: System.Double
Distance from startNode along the line where the point will be offset. A negative value means moving backwards along the line from startNode. Unit: same as the coordinates of the line geometry.
Distance from startNode along the line where the point will be offset. A negative value means moving backwards along the line from startNode. Unit: same as the coordinates of the line geometry.
segment
Type: System.Int32
Will be set to the index of the segment that contains the returned point.
Will be set to the index of the segment that contains the returned point.
angle
Type: System.Double
Will be set to the horizontal direction of the segment that contains the returned point. Unit: Radians counterclockwise from right.
Will be set to the horizontal direction of the segment that contains the returned point. Unit: Radians counterclockwise from right.
pitch
Type: System.Double
Will be set to the pitch of the segment that contains the returned point. Unit: Radians; a horizontal segment has zero pitch and a segment going straight up has pitch pi/2.
Will be set to the pitch of the segment that contains the returned point. Unit: Radians; a horizontal segment has zero pitch and a segment going straight up has pitch pi/2.
Return Value
Type: Point
A point that lies distance along the line from startNode. The point will be clamped to the start or end of the line if distance added to the distance to the startNode is less than 0 or greater than the length of the line.
A point that lies distance along the line from startNode. The point will be clamped to the start or end of the line if distance added to the distance to the startNode is less than 0 or greater than the length of the line.
Remarks
This method throws an exception if there is less than two points in the geometry or if the index is out of bounds.
Platforms
Windows, Linux, Android