BooleanBuilder Class¶
-
class
NXOpen.Features.BooleanBuilder¶ Bases:
NXOpen.Features.FeatureBuilderRepresents a boolean feature builder.
To create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateBooleanBuilderUsingCollectorNew in version NX4.0.0.
Properties¶
| Property | Description |
|---|---|
| BooleanRegionSelect | Returns the boolean region select object |
| ConvertToSew | Returns or sets the convert to sew flag |
| CopyTargets | Returns or sets the copy targets flag |
| CopyTools | Returns or sets the copy tools flag |
| Operation | Returns or sets the boolean operation |
| ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
| PatchSolutionFlag | Returns or sets the patch solution flag |
| PatchSurfaceFilename | Returns or sets the patch surface filename |
| RetainTarget | Returns or sets the retain target flag |
| RetainTool | Returns or sets the retain tool flag |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| Tag | Returns the Tag for this object. |
| Target | Returns or sets the target body |
| Targets | Returns the target bodies for the boolean operation |
| Tolerance | Returns or sets the tolerance |
| Tool | Returns or sets the tool body |
| ToolBodyCollector | Returns or sets the tool body collector for the boolean operation |
| Tools | Returns the tool bodies for the boolean operation |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| CommitFeature | Commits the feature parameters and creates the feature @return |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetFeature | Returns the feature currently being edited by this builder. |
| GetObject | Returns the object currently being edited by this builder. |
| HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
| SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
| ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
BooleanRegionSelect¶
-
BooleanBuilder.BooleanRegionSelect¶ Returns the boolean region select object
-------------------------------------Getter Method
Signature
BooleanRegionSelect()Returns: Return type: NXOpen.GeometricUtilities.BooleanRegionSelectNew in version NX8.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ConvertToSew¶
-
BooleanBuilder.ConvertToSew¶ Returns or sets the convert to sew flag
-------------------------------------Getter Method
Signature
ConvertToSew()Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ConvertToSew(convertToSew)Parameters: convertToSew (bool) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
CopyTargets¶
-
BooleanBuilder.CopyTargets¶ Returns or sets the copy targets flag
-------------------------------------Getter Method
Signature
CopyTargets()Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CopyTargets(copyTargets)Parameters: copyTargets (bool) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
CopyTools¶
-
BooleanBuilder.CopyTools¶ Returns or sets the copy tools flag
-------------------------------------Getter Method
Signature
CopyTools()Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CopyTools(copyTools)Parameters: copyTools (bool) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Operation¶
-
BooleanBuilder.Operation¶ Returns or sets the boolean operation
-------------------------------------Getter Method
Signature
Operation()Returns: Type of boolean operation. Return type: NXOpen.Features.FeatureBooleanTypeNew in version NX4.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Operation(operation)Parameters: operation ( NXOpen.Features.FeatureBooleanType) – Type of boolean operation.New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
RetainTarget¶
-
BooleanBuilder.RetainTarget¶ Returns or sets the retain target flag
-------------------------------------Getter Method
Signature
RetainTarget()Returns: Retain target flag Return type: bool New in version NX4.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
RetainTarget(retainTarget)Parameters: retainTarget (bool) – Retain target flag New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
RetainTool¶
-
BooleanBuilder.RetainTool¶ Returns or sets the retain tool flag
-------------------------------------Getter Method
Signature
RetainTool()Returns: Retain tool flag Return type: bool New in version NX4.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
RetainTool(retainTool)Parameters: retainTool (bool) – Retain tool flag New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Target¶
-
BooleanBuilder.Target¶ Returns or sets the target body
-------------------------------------Getter Method
Signature
Target()Returns: Target body for boolean operation. Return type: NXOpen.BodyNew in version NX4.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Target(target)Parameters: target ( NXOpen.Body) – Target body for boolean operation. This parameter may not be None.New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Targets¶
-
BooleanBuilder.Targets¶ Returns the target bodies for the boolean operation
-------------------------------------Getter Method
Signature
Targets()Returns: Return type: NXOpen.SelectBodyListNew in version NX5.0.0.
License requirements: None.
Tolerance¶
-
BooleanBuilder.Tolerance¶ Returns or sets the tolerance
-------------------------------------Getter Method
Signature
Tolerance()Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Tolerance(tolerance)Parameters: tolerance (float) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Tool¶
-
BooleanBuilder.Tool¶ Returns or sets the tool body
-------------------------------------Getter Method
Signature
Tool()Returns: Tool body for boolean operation. Return type: NXOpen.DisplayableObjectNew in version NX4.0.0.
Deprecated since version NX5.0.2: Use
Features.BooleanBuilder.ToolBodyCollectorinstead.License requirements: None.
-------------------------------------Setter Method
Signature
Tool(tool)Parameters: tool ( NXOpen.DisplayableObject) – Tool body for boolean operation. This parameter may not be None.New in version NX4.0.0.
Deprecated since version NX5.0.2: Use
Features.BooleanBuilder.ToolBodyCollectorinstead.License requirements: solid_modeling (“SOLIDS MODELING”)
ToolBodyCollector¶
-
BooleanBuilder.ToolBodyCollector¶ Returns or sets the tool body collector for the boolean operation
-------------------------------------Getter Method
Signature
ToolBodyCollector()Returns: Return type: NXOpen.ScCollectorNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ToolBodyCollector(toolBodyCollector)Parameters: toolBodyCollector ( NXOpen.ScCollector) –New in version NX7.5.0.
License requirements: None.
Tools¶
-
BooleanBuilder.Tools¶ Returns the tool bodies for the boolean operation
-------------------------------------Getter Method
Signature
Tools()Returns: Return type: NXOpen.SelectDisplayableObjectListNew in version NX5.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
BooleanBuilder.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.