SolidPatchBuilder Class¶
-
class
NXOpen.Tooling.
SolidPatchBuilder
¶ Bases:
NXOpen.Builder
Represents a builder to be used to create a solid patch.
To create a new instance of this class, use
NXOpen.Tooling.SolidPatchCollection.CreateBuilder()
Default values.
Property Value PatchType SolidPatch Subtract 0 New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
Patch | Returns the tool bodies selected as linked source bodies for patching up the target body. |
PatchType | Returns or sets the patch type of the solid patch creation. |
Product | Returns the product body selected as the target body for unite with tool bodies. |
Subtract | Returns or sets the toggle for indicating if the tool is subtracted by the target or not. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
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. |
GetObject | Returns the object currently being edited by this builder. |
ShowResult | Show result button to write the patch and link this information to the list window. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
SolidPatchBuilderSolidPatchType Enumeration | Settings of the solid patch creation types. |
Property Detail¶
Patch¶
-
SolidPatchBuilder.
Patch
¶ Returns the tool bodies selected as linked source bodies for patching up the target body.
-------------------------------------
Getter Method
Signature
Patch
Returns: Return type: NXOpen.SelectBodyList
New in version NX7.5.0.
License requirements: None.
PatchType¶
-
SolidPatchBuilder.
PatchType
¶ Returns or sets the patch type of the solid patch creation.
-------------------------------------
Getter Method
Signature
PatchType
Returns: Return type: NXOpen.Tooling.SolidPatchBuilderSolidPatchType
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PatchType
Parameters: patchType ( NXOpen.Tooling.SolidPatchBuilderSolidPatchType
) –New in version NX7.5.0.
License requirements: None.
Product¶
-
SolidPatchBuilder.
Product
¶ Returns the product body selected as the target body for unite with tool bodies.
-------------------------------------
Getter Method
Signature
Product
Returns: Return type: NXOpen.SelectBody
New in version NX7.5.0.
License requirements: None.
Subtract¶
-
SolidPatchBuilder.
Subtract
¶ Returns or sets the toggle for indicating if the tool is subtracted by the target or not.
-------------------------------------
Getter Method
Signature
Subtract
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Subtract
Parameters: isSubtract (bool) – New in version NX7.5.0.
License requirements: None.
Method Detail¶
ShowResult¶
-
SolidPatchBuilder.
ShowResult
¶ Show result button to write the patch and link this information to the list window.
Signature
ShowResult()
New in version NX7.5.0.
License requirements: None.
Validate¶
-
SolidPatchBuilder.
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.