a class which defines boolean region select. More...

Inheritance diagram for NXOpen::GeometricUtilities::BooleanRegionSelect:

Public Types
enum	KeepRemoveOption { KeepRemoveOptionKeep, KeepRemoveOptionRemove }
	the keep/remove options for selected region More...

enum	SelectOption { SelectOptionNone, SelectOptionKeepOrRemove, SelectOptionKeepAndRemove }
	the region selection method More...

Public Member Functions
NXOpen::GeometricUtilities::RegionTracker *	AppendOneRegionTracker ()
	Create empty region tracker object and register it on the boolean region select builder.

void	AssignTargets (const std::vector< NXOpen::TaggedObject * > &targets)
	Assigns the targets to be used for region selection Created in NX8.5.0.

void	ClearAllRegionTrackers ()
	Clears all region trackers currently registered on the feature Created in NX8.5.0.

void	ClearRegions ()
	Clears all preview regions and the current region trackers Created in NX8.5.0.

NXOpen::GeometricUtilities::BooleanRegionSelect::KeepRemoveOption	KeepRemoveTargetMethod ()
	Returns the boolean region to keep/remove method Created in NX8.5.0.

NXOpen::GeometricUtilities::BooleanRegionSelect::KeepRemoveOption	KeepRemoveToolMethod ()
	Returns the boolean region to keep/remove method Created in NX8.5.0.

NXOpen::GeometricUtilities::BooleanRegionSelect::SelectOption	SelectMethod ()
	Returns the boolean region selection method method Created in NX8.5.0.

void	SetKeepRemoveTargetMethod (NXOpen::GeometricUtilities::BooleanRegionSelect::KeepRemoveOption targetOption)
	Sets the boolean region to keep/remove method Created in NX8.5.0.

void	SetKeepRemoveToolMethod (NXOpen::GeometricUtilities::BooleanRegionSelect::KeepRemoveOption toolOption)
	Sets the boolean region to keep/remove method Created in NX8.5.0.

void	SetSelectMethod (NXOpen::GeometricUtilities::BooleanRegionSelect::SelectOption selectOption)
	Sets the boolean region selection method method Created in NX8.5.0.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

a class which defines boolean region select.

Created in NX8.5.0.

Member Enumeration Documentation

enum NXOpen::GeometricUtilities::BooleanRegionSelect::KeepRemoveOption

the keep/remove options for selected region

Enumerator:

KeepRemoveOptionKeep

Selected region will be kept.

Default set.

KeepRemoveOptionRemove

Selected reg ion will be removed.

enum NXOpen::GeometricUtilities::BooleanRegionSelect::SelectOption

the region selection method

Enumerator:

SelectOptionNone	No regions to pick.
SelectOptionKeepOrRemove	Keep or remove regions.
SelectOptionKeepAndRemove	Keep and remove regions.

Member Function Documentation

NXOpen::GeometricUtilities::RegionTracker* NXOpen::GeometricUtilities::BooleanRegionSelect::AppendOneRegionTracker ( )

Create empty region tracker object and register it on the boolean region select builder.

Returns: Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::GeometricUtilities::BooleanRegionSelect::AssignTargets ( const std::vector< NXOpen::TaggedObject * > & targets )

Assigns the targets to be used for region selection
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

targets targets

void NXOpen::GeometricUtilities::BooleanRegionSelect::ClearAllRegionTrackers ( )

Clears all region trackers currently registered on the feature
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::GeometricUtilities::BooleanRegionSelect::ClearRegions ( )

Clears all preview regions and the current region trackers
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

NXOpen::GeometricUtilities::BooleanRegionSelect::KeepRemoveOption NXOpen::GeometricUtilities::BooleanRegionSelect::KeepRemoveTargetMethod ( )

Returns the boolean region to keep/remove method
Created in NX8.5.0.

License requirements : None

NXOpen::GeometricUtilities::BooleanRegionSelect::KeepRemoveOption NXOpen::GeometricUtilities::BooleanRegionSelect::KeepRemoveToolMethod ( )

Returns the boolean region to keep/remove method
Created in NX8.5.0.

License requirements : None

NXOpen::GeometricUtilities::BooleanRegionSelect::SelectOption NXOpen::GeometricUtilities::BooleanRegionSelect::SelectMethod ( )

Returns the boolean region selection method method
Created in NX8.5.0.

License requirements : None

void NXOpen::GeometricUtilities::BooleanRegionSelect::SetKeepRemoveTargetMethod ( NXOpen::GeometricUtilities::BooleanRegionSelect::KeepRemoveOption targetOption )

Sets the boolean region to keep/remove method
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

targetOption targetoption

void NXOpen::GeometricUtilities::BooleanRegionSelect::SetKeepRemoveToolMethod ( NXOpen::GeometricUtilities::BooleanRegionSelect::KeepRemoveOption toolOption )

Sets the boolean region to keep/remove method
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

toolOption tooloption

void NXOpen::GeometricUtilities::BooleanRegionSelect::SetSelectMethod ( NXOpen::GeometricUtilities::BooleanRegionSelect::SelectOption selectOption )

Sets the boolean region selection method method
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

selectOption selectoption

virtual bool NXOpen::GeometricUtilities::BooleanRegionSelect::Validate ( )

virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns: Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

The documentation for this class was generated from the following file:

GeometricUtilities_BooleanRegionSelect.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation