Functions
static Array< Path >	oevislib_net.Path.ExtractOpenPaths (Array< Path > inPaths)
	Selects open paths from an input array.
static Array< Path >	oevislib_net.Path.ExtractClosedPaths (Array< Path > inPaths)
	Selects closed paths from an input array.
static Array< Path >	oevislib_net.Path.ExtractExternalPaths (Array< Path > inPaths, Point2D inCenterPoint, float inTolerance)
	Selects paths that do not obstruct the external visibility of other objects, given a reference point.
static Array< Path >	oevislib_net.Path.ExtractInternalPaths (Array< Path > inPaths, Point2D inCenterPoint, float inTolerance)
	Selects paths that are visible from a reference point.
static Array< Path >	oevislib_net.Path.ExtractPaths (Array< Path > inPaths, PathFeature inPathFeature, PathFilter inPathFilter, Optional< float > inMinValue, Optional< float > inMaxValue, Optional< Array< Path > > outRejected, Optional< Array< Path > > outBelow, Optional< Array< Path > > outAbove, Optional< Array< float > > outValues)
	Filters an array of paths based on the provided feature.
static void	oevislib_net.Path.MakePathConditional (Path inPath, PathFeature inFeature, Optional< float > inMinimum, Optional< float > inMaximum, Conditional< Path > outConditionalPath)
	Computes a path feature, checks whether its value is in range and creates an optional path on this basis.
static Array< Path >	oevislib_net.Path.SortPaths (Array< Path > inPaths, PathFeature inPathFeature, PathFilter inPathFilter, SortingOrder inSortingOrder, Optional< Array< float > > outSortedValues)
	Returns the input path array sorted based on the requested feature.
static Path	oevislib_net.Path.FindMinPath (Array< Path > inPaths, PathFeature inPathFeature, Optional< float > outValue, Optional< int > outIndex)
	Returns the path with the minimum value of the requested feature.
static Path	oevislib_net.Path.FindMaxPath (Array< Path > inPaths, PathFeature inPathFeature, Optional< float > outValue, Optional< int > outIndex)
	Returns the path with the maximum value of the requested feature.

Detailed Description

Function Documentation

◆ ExtractClosedPaths()

Array< Path > oevislib_net.Path.ExtractClosedPaths ( Array< Path > inPaths )

inlinestatic

Selects closed paths from an input array.

Parameters

inPaths Input paths.

Returns: Closed paths.

◆ ExtractExternalPaths()

Array< Path > oevislib_net.Path.ExtractExternalPaths	(	Array< Path >	inPaths,
		Point2D	inCenterPoint,
		float	inTolerance )

inlinestatic

Selects paths that do not obstruct the external visibility of other objects, given a reference point.

Parameters

inPaths	Input paths.
inCenterPoint	Point used to determine visibility.
inTolerance	Fraction of the path allowed to obstruct other paths. Range: [0, 1].

Returns: External paths.

◆ ExtractInternalPaths()

Array< Path > oevislib_net.Path.ExtractInternalPaths	(	Array< Path >	inPaths,
		Point2D	inCenterPoint,
		float	inTolerance )

inlinestatic

Selects paths that are visible from a reference point.

Parameters

inPaths	Input paths.
inCenterPoint	Point used to determine visibility.
inTolerance	Fraction of the path allowed to be obstructed by other paths. Range: [0, 1].

Returns: Internal paths.

◆ ExtractOpenPaths()

Array< Path > oevislib_net.Path.ExtractOpenPaths ( Array< Path > inPaths )

inlinestatic

Selects open paths from an input array.

Parameters

inPaths Input paths.

Returns: Open paths.

◆ ExtractPaths()

Array< Path > oevislib_net.Path.ExtractPaths	(	Array< Path >	inPaths,
		PathFeature	inPathFeature,
		PathFilter	inPathFilter,
		Optional< float >	inMinValue,
		Optional< float >	inMaxValue,
		Optional< Array< Path > >	outRejected,
		Optional< Array< Path > >	outBelow,
		Optional< Array< Path > >	outAbove,
		Optional< Array< float > >	outValues )

inlinestatic

Filters an array of paths based on the provided feature.

Parameters

inPaths	Input paths.
inPathFeature	Feature used to filter paths.
inPathFilter	Type of filter considered in the algorithm.
inMinValue	Feature minimum accepted value.
inMaxValue	Feature maximum accepted value.
outRejected	Array containing the rejected paths.
outBelow	Array containing the paths that have a feature value below the accepted minimum.
outAbove	Array containing the paths that have a feature value above the accepted maximum.
outValues	Array containing the feature values for each input path.

Returns: an array containing the accepted paths.

◆ FindMaxPath()

Path oevislib_net.Path.FindMaxPath	(	Array< Path >	inPaths,
		PathFeature	inPathFeature,
		Optional< float >	outValue,
		Optional< int >	outIndex )

inlinestatic

Returns the path with the maximum value of the requested feature.

Parameters

inPaths	Input paths.
inPathFeature	Feature used to compare the paths.
outValue	Value of the feature for the found path.
outIndex	Index of the found path in the original array.

Returns: The path with the maximum value of the requested feature.

◆ FindMinPath()

Path oevislib_net.Path.FindMinPath	(	Array< Path >	inPaths,
		PathFeature	inPathFeature,
		Optional< float >	outValue,
		Optional< int >	outIndex )

inlinestatic

Returns the path with the minimum value of the requested feature.

Parameters

inPaths	Input paths.
inPathFeature	Feature used to compare the paths.
outValue	Value of the feature for the found path.
outIndex	Index of the found path in the original array.

Returns: The path with the minimum value of the requested feature.

◆ MakePathConditional()

void oevislib_net.Path.MakePathConditional	(	Path	inPath,
		PathFeature	inFeature,
		Optional< float >	inMinimum,
		Optional< float >	inMaximum,
		Conditional< Path >	outConditionalPath )

inlinestatic

Computes a path feature, checks whether its value is in range and creates an optional path on this basis.

Parameters

inPath	Input path.
inFeature	Path feature value to be computed.
inMinimum	Lowest value of the range. Default value: Null.
inMaximum	Highest value of the range. Default value: Null.
outConditionalPath	The path if the condition is met or nothing otherwise.

◆ SortPaths()

Array< Path > oevislib_net.Path.SortPaths	(	Array< Path >	inPaths,
		PathFeature	inPathFeature,
		PathFilter	inPathFilter,
		SortingOrder	inSortingOrder,
		Optional< Array< float > >	outSortedValues )

inlinestatic

Returns the input path array sorted based on the requested feature.

Parameters

inPaths	Input paths.
inPathFeature	Feature used to sort the paths.
inPathFilter	Type of filter considered in the sorting algorithm.
inSortingOrder	Sorting order.
outSortedValues	All the computed feature values, sorted.

Returns: The input path array sorted based on the requested feature.

Functions

Detailed Description

Function Documentation

◆ ExtractClosedPaths()

◆ ExtractExternalPaths()

◆ ExtractInternalPaths()

◆ ExtractOpenPaths()

◆ ExtractPaths()

◆ FindMaxPath()

◆ FindMinPath()

◆ MakePathConditional()

◆ SortPaths()