You are here: Start » Function Reference » Path » Path Classification » GetMaximumPath

GetMaximumPath

Returns the path from the input array that corresponds to the largest computed feature value.

Applications: Use this filter when you have an array of paths and you want to select one of them that best matches some criterion.

Syntax

void fil::GetMaximumPath
(
	const ftl::Array<fil::Path>& inPaths,
	fil::PathFeature::Type inFeature,
	fil::Path& outPath,
	ftl::Optional<float&> outValue = ftl::NIL,
	ftl::Optional<int&> outIndex = ftl::NIL
)

Parameters

	Name	Type	Default	Description
	inPaths	const Array<Path>&		Input paths
	inFeature	PathFeature::Type		Path feature value to be computed
	outPath	Path&		Output path
	outValue	Optional<float&>	NIL	Computed feature value of the output path
	outIndex	Optional<int&>	NIL

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outValue, outIndex.

Read more about Optional Outputs.

Errors