You are here: Start » AVL.NET » Function Reference » Path » Path Global Transforms » AVL.SegmentPath

AVL.SegmentPath

Splits a path into parts that can be approximated as segments or arcs.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void SegmentPath
(
	AvlNet.Path inPath,
	float inSmoothingStdDev,
	float inMaxDeviation,
	AvlNet.PathSegmentationMode inSegmentationMode,
	float? inMaxArcRadius,
	IList<AvlNet.Path> outStraight,
	IList<AvlNet.Path> outArciform,
	IList<AvlNet.Segment2D> outSegments,
	IList<AvlNet.Arc2D> outArcs
)

Parameters

Name Type Range Default Description
inPathAvlNet.PathPath to be segmented.
inSmoothingStdDevfloat<0.0f, INF>Standard deviation used for initial gaussian smoothing of the segmented path.
inMaxDeviationfloat<0.0f, INF>0.5fMaximal distance between any point of a classified segment to the abstract shape. Default value: 0.5f.
inSegmentationModeAvlNet.PathSegmentationModeWhether to use arcs for segmentation.
inMaxArcRadiusfloat?<0.0f, INF>10.0fMaximal radius of an arc fitted to segment. Default value: 10.0f.
outStraightSystem.Collections.Generic.IList<AvlNet.Path>Parts classified as straight segments.
outArciformSystem.Collections.Generic.IList<AvlNet.Path>Parts classified as arciform segments.
outSegmentsSystem.Collections.Generic.IList<AvlNet.Segment2D>Segments corresponding to sections of path from outStraight.
outArcsSystem.Collections.Generic.IList<AvlNet.Arc2D>Arcs corresponding to sections of path from outArciform.

Description

The operation segments the inPath into parts of preferably simple shape. Each of the resulting parts is classified as one of the following:

  • Straight section - in which case it is returned in outStraight output array
  • Arciform section - in which case it is returned in outArciform output array

The operation guarantees that the maximal distance from any of the resulting path section to the corresponding abstract shape (line segment or circular arc) is less than inMaxDeviation.

Examples

The resulting outStraight array (some of the paths in the picture have common ends but in fact each straight part is a separate path).

The resulting outArciform array.

Errors

List of possible exceptions:

Error type Description
DomainError Empty path on input in SegmentPath.

Function Overrides

See also