AssignPatchBuilder Class¶
-
class
NXOpen.Tooling.AssignPatchBuilder¶ Bases:
NXOpen.BuilderRepresents a builder to be used to add sheet bodies as patch surfaces or delete patch surfaces.
To create a new instance of this class, use
NXOpen.Tooling.AssignPatchCollection.CreateBuilderDefault values.
Property Value KeepSheet 1 New in version NX7.5.0.
Properties¶
| Property | Description |
|---|---|
| KeepSheet | Returns or sets the flag indicating whether to Keep the sheet body or just delete it when deleting a patch surface. |
| PatchColor | Returns or sets the patch surface color. |
| PatchSurfaces | Returns the selected surfaces added as patch surfaces or deleted from patch surfaces. |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| AddSelectFace | Add selected face to select list. |
| ClearAddingCandidates | Clear the m_addingCandidates list. |
| 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. |
| InitOnEnter | Get initial patched and parting faces to do delete surface function. |
| PrepareAllRemovingSheets | Get all the related sheets in one feature set. |
| 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. |
Property Detail¶
KeepSheet¶
-
AssignPatchBuilder.KeepSheet¶ Returns or sets the flag indicating whether to Keep the sheet body or just delete it when deleting a patch surface.
-------------------------------------Getter Method
Signature
KeepSheet()Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
KeepSheet(keepSheet)Parameters: keepSheet (bool) – New in version NX7.5.0.
License requirements: None.
PatchColor¶
-
AssignPatchBuilder.PatchColor¶ Returns or sets the patch surface color.
-------------------------------------Getter Method
Signature
PatchColor()Returns: Return type: Id New in version NX7.5.5.
License requirements: None.
-------------------------------------Setter Method
Signature
PatchColor(patchColor)Parameters: patchColor (Id) – New in version NX7.5.5.
License requirements: None.
PatchSurfaces¶
-
AssignPatchBuilder.PatchSurfaces¶ Returns the selected surfaces added as patch surfaces or deleted from patch surfaces.
-------------------------------------Getter Method
Signature
PatchSurfaces()Returns: Return type: NXOpen.SelectBodyListNew in version NX7.5.0.
License requirements: None.
Method Detail¶
AddSelectFace¶
-
AssignPatchBuilder.AddSelectFace¶ Add selected face to select list.
Signature
AddSelectFace(addFace)Parameters: addFace ( NXOpen.Body) – face to add to user selected face listNew in version NX7.5.0.
License requirements: None.
ClearAddingCandidates¶
-
AssignPatchBuilder.ClearAddingCandidates¶ Clear the m_addingCandidates list.
Signature
ClearAddingCandidates()New in version NX7.5.0.
License requirements: None.
InitOnEnter¶
-
AssignPatchBuilder.InitOnEnter¶ Get initial patched and parting faces to do delete surface function.
Signature
InitOnEnter()New in version NX7.5.0.
License requirements: None.
PrepareAllRemovingSheets¶
-
AssignPatchBuilder.PrepareAllRemovingSheets¶ Get all the related sheets in one feature set.
Signature
PrepareAllRemovingSheets(sheets)Parameters: sheets (list of NXOpen.Body) – The sheets to find their related originalsNew in version NX7.5.0.
License requirements: None.
Validate¶
-
AssignPatchBuilder.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.