LineGeometry.OffsetPointAlongLine Method
Returns a Point that has been orthogonally offset from the LineGeometry.
Thread safety: This method is not thread-safe. Show
OffsetPointAlongLine(System.Int32 startNode, System.Double distance, System.Double offset)
Returns a Point that has been orthogonally offset from the LineGeometry.Syntax
public Point OffsetPointAlongLine (
System.Int32 startNode,
System.Double distance,
System.Double offset
)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.
offset
Type: System.Double
The orthogonal offset from the line. A positive value will offset the point to the left of the line and a negative value will offset the point to the right of the line. Unit: same as the coordinates of the line geometry.
The orthogonal offset from the line. A positive value will offset the point to the left of the line and a negative value will offset the point to the right of the line. Unit: same as the coordinates of the line geometry.
Return Value
Type: Point
A point that has been offset from the current line. 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 has been offset from the current line. 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 starts by calculating where the point will be offset from using the PointAlongLine method and the startNode and distance parameters. Then the point is offset orthogonally from the line by the distance specified in offset.
This method throws an exception if there is less than two points in the geometry or if the index is out of bounds.
Note
This method operates on 2D geometries and all z-coordinate values are ignored.
Platforms
Windows, Linux, Android