PatchBuilder Class¶
-
class
NXOpen.Features.PatchBuilder¶ Bases:
NXOpen.Features.FeatureBuilderRepresents a
NXOpen.Features.PatchBuilderLets you use a sheet body to replace some of the faces of a solid body.You can also patch a sheet to another sheet.
To create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreatePatchBuilder()Default values.
Property Value CreateHolePatch False ReverseDirection False New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| CreateHolePatch | Returns or sets the create hole patch. |
| 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 |
| ReverseDirection | Returns or sets the reverse direction. |
| SeedFace | Returns the seed face. |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| Tag | Returns the Tag for this object. |
| Target | Returns the target. |
| Tolerance | Returns or sets the tolerance. |
| Tool | Returns the tool. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| CommitFeature | Commits the feature parameters and creates the feature |
| 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¶
CreateHolePatch¶
-
PatchBuilder.CreateHolePatch¶ Returns or sets the create hole patch.
Patch the closed tool sheet to the target body to create a hole-like patch feature. Note if the edges of the tool sheet have gaps that are larger than the tolerance, the patching may not work as expected.
-------------------------------------Getter Method
Signature
CreateHolePatchReturns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CreateHolePatchParameters: createHolePatch (bool) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ReverseDirection¶
-
PatchBuilder.ReverseDirection¶ Returns or sets the reverse direction.
If set to true, the target body faces against the direction are removed, else the target body faces where the direction points to are removed. The default direction is defined by the normal vector of the first face in tool body, or of the seed face if specified.
-------------------------------------Getter Method
Signature
ReverseDirectionReturns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReverseDirectionParameters: reverseDirection (bool) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SeedFace¶
-
PatchBuilder.SeedFace¶ Returns the seed face.
Use a single face of the tool sheet that has multiple faces as the direction.
-------------------------------------Getter Method
Signature
SeedFaceReturns: Return type: NXOpen.SelectFaceNew in version NX5.0.0.
License requirements: None.
Target¶
-
PatchBuilder.Target¶ Returns the target.
A solid or sheet body acts as the target for the patch feature.
-------------------------------------Getter Method
Signature
TargetReturns: Return type: NXOpen.SelectBodyNew in version NX5.0.0.
License requirements: None.
Tolerance¶
-
PatchBuilder.Tolerance¶ Returns or sets the tolerance.
The upper gap between the edges of the target and tool body
-------------------------------------Getter Method
Signature
ToleranceReturns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ToleranceParameters: tolerance (float) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Tool¶
-
PatchBuilder.Tool¶ Returns the tool.
A sheet acts as the tool for the patch feature.
-------------------------------------Getter Method
Signature
ToolReturns: Return type: NXOpen.SelectDisplayableObjectNew in version NX5.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
PatchBuilder.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.