NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | Properties | List of all members
NXOpen.GeometricUtilities.BooleanRegionSelect Class Reference

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

Inheritance diagram for NXOpen.GeometricUtilities.BooleanRegionSelect:
NXOpen.GeometricUtilities.IComponentBuilder

Public Types

enum  SelectOption { None, KeepOrRemove, KeepAndRemove }
 the region selection method More...
 
enum  KeepRemoveOption { Keep, Remove }
 the keep/remove options for selected region More...
 

Public Member Functions

unsafe
NXOpen.GeometricUtilities.RegionTracker 
AppendOneRegionTracker ()
 Create empty region tracker object and register it on the boolean region select builder More...
 
unsafe void AssignTargets (NXOpen.TaggedObject[] targets)
 Assigns the targets to be used for region selection More...
 
unsafe void NotifyBodiesHaveChanged (NXOpen.ScCollector bodySelectionList)
 Notify that the bodies have changed More...
 
unsafe void ClearRegions ()
 Clears all preview regions and the current region trackers More...
 
unsafe void ClearAllRegionTrackers ()
 Clears all region trackers currently registered on the feature More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 

Properties

unsafe
NXOpen.GeometricUtilities.BooleanRegionSelect.KeepRemoveOption 
KeepRemoveTargetMethod [get, set]
 Returns or sets the boolean region to keep/remove method More...
 
unsafe
NXOpen.GeometricUtilities.BooleanRegionSelect.KeepRemoveOption 
KeepRemoveToolMethod [get, set]
 Returns or sets the boolean region to keep/remove method More...
 
unsafe
NXOpen.GeometricUtilities.BooleanRegionSelect.SelectOption 
SelectMethod [get, set]
 Returns or sets the boolean region selection method method More...
 

Detailed Description

a class which defines boolean region select.

Created in NX8.5.0

Member Enumeration Documentation

the keep/remove options for selected region

Enumerator
Keep 

Selected region will be kept.

Default set.

Remove 

Selected reg ion will be removed.

the region selection method

Enumerator
None 

No regions to pick

KeepOrRemove 

Keep or remove regions

KeepAndRemove 

Keep and remove regions

Member Function Documentation

unsafe NXOpen.GeometricUtilities.RegionTracker NXOpen.GeometricUtilities.BooleanRegionSelect.AppendOneRegionTracker ( )

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

Created in NX8.5.0

License requirements: solid_modeling ("SOLIDS MODELING")

Returns
unsafe void NXOpen.GeometricUtilities.BooleanRegionSelect.AssignTargets ( 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
unsafe 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")

unsafe 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")

unsafe void NXOpen.GeometricUtilities.BooleanRegionSelect.NotifyBodiesHaveChanged ( NXOpen.ScCollector  bodySelectionList)

Notify that the bodies have changed

Created in NX11.0.1

License requirements: solid_modeling ("SOLIDS MODELING")

Parameters
bodySelectionList
unsafe bool NXOpen.GeometricUtilities.BooleanRegionSelect.Validate ( )

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.

Created in NX3.0.1

License requirements: None.

Returns
Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.GeometricUtilities.BooleanRegionSelect.KeepRemoveOption NXOpen.GeometricUtilities.BooleanRegionSelect.KeepRemoveTargetMethod
getset

Returns or sets the boolean region to keep/remove method

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.GeometricUtilities.BooleanRegionSelect.KeepRemoveOption NXOpen.GeometricUtilities.BooleanRegionSelect.KeepRemoveToolMethod
getset

Returns or sets the boolean region to keep/remove method

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.GeometricUtilities.BooleanRegionSelect.SelectOption NXOpen.GeometricUtilities.BooleanRegionSelect.SelectMethod
getset

Returns or sets the boolean region selection method method

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.