CIP C++ documentation for class "pfcSelectionEvaluator"

Class pfcSelectionEvaluator

# include <pfcInterference.h> class pfcSelectionEvaluator : public virtual pfcObject { xaideclare(pfcSelectionEvaluator) ... };

Description

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

Method Summary


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

`optional pfcInterferenceVolume_ptr`	`ComputeInterference (xbool SolidOnly)`
	Enables the user to measure the interference between the two specified parts.

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

`pfcSelectionPair_ptr`	`GetSelections ()`
`void`	`SetSelections (pfcSelectionPair_ptr value)`
	The SelectionPair: the pair of selected objects.

Method Detail

`pfcSelectionPair_ptr`	`GetSelections`	`()`
`void`	`SetSelections`	`(pfcSelectionPair_ptr value)`

The SelectionPair: the pair of selected objects.

Manual References:: Geometry Evaluation: Analyzing Interference Information, Geometry Evaluation: Analyzing Interference Information, Geometry Evaluation: Analyzing Interference Information, Geometry Evaluation: Analyzing Interference Information

optional pfcInterferenceVolume_ptr ComputeInterference (xbool SolidOnly)

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

Exceptions thrown (but not limited to):

pfcXInvalidSelection - Selections are not valid

Manual References:: Geometry Evaluation: Analyzing Interference Information, Geometry Evaluation: Analyzing Interference Information

Parameters:

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

pfcClearanceData_ptr 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

Manual References:: Geometry Evaluation: Analyzing Interference Information, Geometry Evaluation: Analyzing Interference Information

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).

pfcCriticalDistanceData_ptr 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.