BooleanRegionSelect Class¶
-
class
NXOpen.GeometricUtilities.BooleanRegionSelect¶ Bases:
NXOpen.TaggedObject,NXOpen.GeometricUtilities.IComponentBuildera class which defines boolean region select.
New in version NX8.5.0.
Properties¶
| Property | Description |
|---|---|
| KeepRemoveTargetMethod | Returns or sets the boolean region to keep/remove method |
| KeepRemoveToolMethod | Returns or sets the boolean region to keep/remove method |
| SelectMethod | Returns or sets the boolean region selection method method |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| AppendOneRegionTracker | Create empty region tracker object and register it on the boolean region select builder @return |
| AssignTargets | Assigns the targets to be used for region selection |
| ClearAllRegionTrackers | Clears all region trackers currently registered on the feature |
| ClearRegions | Clears all preview regions and the current region trackers |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| BooleanRegionSelectKeepRemoveOption Enumeration | the keep/remove options for selected region |
| BooleanRegionSelectSelectOption Enumeration | the region selection method |
Property Detail¶
KeepRemoveTargetMethod¶
-
BooleanRegionSelect.KeepRemoveTargetMethod¶ Returns or sets the boolean region to keep/remove method
-------------------------------------Getter Method
Signature
KeepRemoveTargetMethod()Returns: Return type: NXOpen.GeometricUtilities.BooleanRegionSelectKeepRemoveOptionNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
KeepRemoveTargetMethod(targetOption)Parameters: targetOption ( NXOpen.GeometricUtilities.BooleanRegionSelectKeepRemoveOption) –New in version NX8.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
KeepRemoveToolMethod¶
-
BooleanRegionSelect.KeepRemoveToolMethod¶ Returns or sets the boolean region to keep/remove method
-------------------------------------Getter Method
Signature
KeepRemoveToolMethod()Returns: Return type: NXOpen.GeometricUtilities.BooleanRegionSelectKeepRemoveOptionNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
KeepRemoveToolMethod(toolOption)Parameters: toolOption ( NXOpen.GeometricUtilities.BooleanRegionSelectKeepRemoveOption) –New in version NX8.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SelectMethod¶
-
BooleanRegionSelect.SelectMethod¶ Returns or sets the boolean region selection method method
-------------------------------------Getter Method
Signature
SelectMethod()Returns: Return type: NXOpen.GeometricUtilities.BooleanRegionSelectSelectOptionNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SelectMethod(selectOption)Parameters: selectOption ( NXOpen.GeometricUtilities.BooleanRegionSelectSelectOption) –New in version NX8.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Method Detail¶
AppendOneRegionTracker¶
-
BooleanRegionSelect.AppendOneRegionTracker¶ Create empty region tracker object and register it on the boolean region select builder
Signature
AppendOneRegionTracker()Returns: Return type: NXOpen.GeometricUtilities.RegionTrackerNew in version NX8.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
AssignTargets¶
-
BooleanRegionSelect.AssignTargets¶ Assigns the targets to be used for region selection
Signature
AssignTargets(targets)Parameters: targets (list of NXOpen.TaggedObject) –New in version NX8.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ClearAllRegionTrackers¶
-
BooleanRegionSelect.ClearAllRegionTrackers¶ Clears all region trackers currently registered on the feature
Signature
ClearAllRegionTrackers()New in version NX8.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ClearRegions¶
-
BooleanRegionSelect.ClearRegions¶ Clears all preview regions and the current region trackers
Signature
ClearRegions()New in version NX8.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Validate¶
-
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.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.