CIP JavaScript documentation for class " pfcSelectionEvaluator"

Class pfcSelectionEvaluator

Description

This class allows the computation of clearances and inteferences between two selected objects.

Property Summary


`pfcSelectionPair`	`Selections`
	The SelectionPair: the pair of selected objects.

Method Summary


`pfcClearanceData`	`ComputeClearance ()`
	Enables the user to compute the clearance between two selected parts or surfaces.

`/* optional */ pfcInterferenceVolume`	`ComputeInterference (boolean SolidOnly)`
	Enables the user to measure the interference between the two specified parts.

`pfcCriticalDistanceData`	`ComputeNearestCriticalDistance ()`
	Enables the user to find the nearest local minimum (not the absolute minimum) of the distance function between two selected objects.

Property Detail

pfcSelectionPair Selections

The SelectionPair: the pair of selected objects.

Method Detail

pfcClearanceData ComputeClearance ()

Enables the user to compute the clearance between two selected parts or surfaces.

Exceptions thrown (but not limited to):

pfcXInvalidSelection - Selections are not valid

Returns:: The ClearanceData object that represents the value of the computed clearance, indicates if interference is detected and the closest points (in the respective part's coordinate systems).

/* optional */ pfcInterferenceVolume ComputeInterference (boolean SolidOnly)

Enables the user to measure the interference between the two specified parts.

Exceptions thrown (but not limited to):

pfcXInvalidSelection - Selections are not valid

Parameters:

SolidOnly: Specifies whether to compute only solid interfaces or to also compute surface interfaces.

pfcCriticalDistanceData ComputeNearestCriticalDistance ()

Enables the user to find the nearest local minimum (not the absolute minimum) of the distance function between two selected objects.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - Not applicable to the input selections.

Returns:: The CriticalDistanceData object that represents the local minimum distance between two selected objects, two 3d points two surface UV-parameters where the distance is calculated.