OffsetEmbossBuilder Class¶
-
class
NXOpen.Features.OffsetEmbossBuilder¶ Bases:
NXOpen.Features.FeatureBuilderRepresents a builder for an offset emboss feature.
This allows creation and editing of an offset emboss feature takes a sheet body, a curve or a point at center, and several dimensions to create an offset pad on the target sheet body.
To create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateOffsetEmbossBuilder()New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| AngleTolerance | Returns or sets the angle tolerance: The maximum allowable angle between the true theoretical sheet and the body created to approximate it. |
| BottomDistance | Returns the bottom distance(Only for point case): The bottom distance defines the extent of the offset pad from the reference point below the point. |
| CenterLine | Returns the center line: An existing curve/path on the sheet that defines the full extent of the offset feature required. |
| CenterPoint | Returns or sets the center point: An existing point on the input sheet body is selected as the reference from which the feature is defined. |
| DistanceTolerance | Returns or sets the distance tolerance: The maximum allowable distance between the true theoretical sheet and the body created to approximate it. |
| HeightOffset | Returns the height offset: Distance to offset the input sheet to create the pad. |
| LeftWidth | Returns the left width: Width of pad to the left of the path curve. |
| 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: The value of true means that the direction for the feature is reversed from the surface normal of the target body, or the offset emboss will create a pocket. |
| RightWidth | Returns the right width: Width of pad to the right of the path curve. |
| SideOffset | Returns the side offset: Offset from pad boundary to define the sidewall draft. |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| Tag | Returns the Tag for this object. |
| Target | Returns or sets the target body to offset This defines a sheet body to offset emboss. |
| TopDistance | Returns the top distance(Only for point case): The top distance defines the extent of the offset pad from the reference point above the point. |
| Type | Returns or sets the center type This defines input types: 0 stands for curve case and 1 stands for point case. |
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. |
Enumerations¶
| OffsetEmbossBuilderTypes Enumeration | Enumeration of center types |
Property Detail¶
AngleTolerance¶
-
OffsetEmbossBuilder.AngleTolerance¶ Returns or sets the angle tolerance: The maximum allowable angle between the true theoretical sheet and the body created to approximate it.
-------------------------------------Getter Method
Signature
AngleToleranceReturns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AngleToleranceParameters: angleTolerance (float) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
BottomDistance¶
-
OffsetEmbossBuilder.BottomDistance¶ Returns the bottom distance(Only for point case): The bottom distance defines the extent of the offset pad from the reference point below the point.
-------------------------------------Getter Method
Signature
BottomDistanceReturns: Return type: NXOpen.ExpressionNew in version NX5.0.0.
License requirements: None.
CenterLine¶
-
OffsetEmbossBuilder.CenterLine¶ Returns the center line: An existing curve/path on the sheet that defines the full extent of the offset feature required.
-------------------------------------Getter Method
Signature
CenterLineReturns: Return type: NXOpen.SectionNew in version NX5.0.0.
License requirements: None.
CenterPoint¶
-
OffsetEmbossBuilder.CenterPoint¶ Returns or sets the center point: An existing point on the input sheet body is selected as the reference from which the feature is defined.
-------------------------------------Getter Method
Signature
CenterPointReturns: Return type: NXOpen.PointNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CenterPointParameters: point ( NXOpen.Point) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
DistanceTolerance¶
-
OffsetEmbossBuilder.DistanceTolerance¶ Returns or sets the distance tolerance: The maximum allowable distance between the true theoretical sheet and the body created to approximate it.
-------------------------------------Getter Method
Signature
DistanceToleranceReturns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DistanceToleranceParameters: distanceTolerance (float) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
HeightOffset¶
-
OffsetEmbossBuilder.HeightOffset¶ Returns the height offset: Distance to offset the input sheet to create the pad.
This defines the amount by which the input sheet body is offset to create the pad.
-------------------------------------Getter Method
Signature
HeightOffsetReturns: Return type: NXOpen.ExpressionNew in version NX5.0.0.
License requirements: None.
LeftWidth¶
-
OffsetEmbossBuilder.LeftWidth¶ Returns the left width: Width of pad to the left of the path curve.
This defines an offset distance (along the input sheet body) away from the curve/path that defines the extent of the feature
-------------------------------------Getter Method
Signature
LeftWidthReturns: Return type: NXOpen.ExpressionNew in version NX5.0.0.
License requirements: None.
ReverseDirection¶
-
OffsetEmbossBuilder.ReverseDirection¶ Returns or sets the reverse direction: The value of true means that the direction for the feature is reversed from the surface normal of the target body, or the offset emboss will create a pocket.
The value of false for the reverse direction property means that the offset emboss feature will create a pad.
-------------------------------------Getter Method
Signature
ReverseDirectionReturns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReverseDirectionParameters: direction (bool) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
RightWidth¶
-
OffsetEmbossBuilder.RightWidth¶ Returns the right width: Width of pad to the right of the path curve.
This defines an offset distance (along the input sheet body) away from the curve/path that defines the extent of the feature.
-------------------------------------Getter Method
Signature
RightWidthReturns: Return type: NXOpen.ExpressionNew in version NX5.0.0.
License requirements: None.
SideOffset¶
-
OffsetEmbossBuilder.SideOffset¶ Returns the side offset: Offset from pad boundary to define the sidewall draft.
This defines an offset distance around all edges of the offset pad that in conjunction with the offset height determines the amount of sidewall draft.
-------------------------------------Getter Method
Signature
SideOffsetReturns: Return type: NXOpen.ExpressionNew in version NX5.0.0.
License requirements: None.
Target¶
-
OffsetEmbossBuilder.Target¶ Returns or sets the target body to offset This defines a sheet body to offset emboss.
-------------------------------------Getter Method
Signature
TargetReturns: Return type: NXOpen.ScCollectorNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TargetParameters: target ( NXOpen.ScCollector) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
TopDistance¶
-
OffsetEmbossBuilder.TopDistance¶ Returns the top distance(Only for point case): The top distance defines the extent of the offset pad from the reference point above the point.
-------------------------------------Getter Method
Signature
TopDistanceReturns: Return type: NXOpen.ExpressionNew in version NX5.0.0.
License requirements: None.
Type¶
-
OffsetEmbossBuilder.Type¶ Returns or sets the center type This defines input types: 0 stands for curve case and 1 stands for point case.
-------------------------------------Getter Method
Signature
TypeReturns: Return type: NXOpen.Features.OffsetEmbossBuilderTypesNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TypeParameters: type ( NXOpen.Features.OffsetEmbossBuilderTypes) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Method Detail¶
Validate¶
-
OffsetEmbossBuilder.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.