SortPaths


Changes the order of paths from the input array according to an ascending/descending sequence of their computed feature values.

Syntax

C++
C#
Python
 
def SortPaths(
	inPaths: list[Path],
	/,
	*,
	inPathFilter: PathFilter = PathFilter.All,
	inFeature: PathFeature = PathFeature.BoundingBoxBottom,
	inSortingOrder: SortingOrder = SortingOrder.Ascending
)
-> (
	outSortedPaths: list[Path],
	outSortedValues: list[float]
)

Parameters

Name Type Default Description
Input value inPaths list[Path] Input paths
Input value inPathFilter PathFilter PathFilter.All Determines which paths will take part in computation
Input value inFeature PathFeature PathFeature.BoundingBoxBottom Path feature value to be computed
Input value inSortingOrder SortingOrder SortingOrder.Ascending Sorting order
Output value outSortedPaths list[Path] Paths sorted according to the computed feature values
Output value outSortedValues list[float] Computed feature values