Represents a builder for an offset emboss feature. More...
Public Types | |
| enum | Types { TypesCurve, TypesPoint } |
| Enumeration of center types Created in NX5.0.0. More... | |
Public Member Functions | |
| double | AngleTolerance () |
| Returns the angle tolerance: The maximum allowable angle between the true theoretical sheet and the body created to approximate it. More... | |
| NXOpen::Expression * | 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. More... | |
| NXOpen::Section * | CenterLine () |
| Returns the center line: An existing curve/path on the sheet that defines the full extent of the offset feature required. More... | |
| NXOpen::Point * | CenterPoint () |
| Returns the center point: An existing point on the input sheet body is selected as the reference from which the feature is defined. More... | |
| double | DistanceTolerance () |
| Returns the distance tolerance: The maximum allowable distance between the true theoretical sheet and the body created to approximate it. More... | |
| NXOpen::Expression * | HeightOffset () |
| Returns the height offset: Distance to offset the input sheet to create the pad. More... | |
| NXOpen::Expression * | LeftWidth () |
| Returns the left width: Width of pad to the left of the path curve. More... | |
| bool | ReverseDirection () |
| Returns 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. More... | |
| NXOpen::Expression * | RightWidth () |
| Returns the right width: Width of pad to the right of the path curve. More... | |
| void | SetAngleTolerance (double angleTolerance) |
| Sets the angle tolerance: The maximum allowable angle between the true theoretical sheet and the body created to approximate it. More... | |
| void | SetCenterPoint (NXOpen::Point *point) |
| Sets the center point: An existing point on the input sheet body is selected as the reference from which the feature is defined. More... | |
| void | SetDistanceTolerance (double distanceTolerance) |
| Sets the distance tolerance: The maximum allowable distance between the true theoretical sheet and the body created to approximate it. More... | |
| void | SetReverseDirection (bool direction) |
| 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. More... | |
| void | SetTarget (NXOpen::ScCollector *target) |
| Sets the target body to offset This defines a sheet body to offset emboss. More... | |
| void | SetType (NXOpen::Features::OffsetEmbossBuilder::Types type) |
| Sets the center type This defines input types: 0 stands for curve case and 1 stands for point case. More... | |
| NXOpen::Expression * | SideOffset () |
| Returns the side offset: Offset from pad boundary to define the sidewall draft. More... | |
| NXOpen::ScCollector * | Target () |
| Returns the target body to offset This defines a sheet body to offset emboss. More... | |
| NXOpen::Expression * | 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. More... | |
| NXOpen::Features::OffsetEmbossBuilder::Types | Type () |
| Returns the center type This defines input types: 0 stands for curve case and 1 stands for point case. More... | |
 Public Member Functions inherited from NXOpen::Features::FeatureBuilder | |
| NXOpen::Features::Feature * | CommitFeature () |
| Commits the feature parameters and creates the feature. More... | |
| NXOpen::Features::Feature * | GetFeature () |
| Returns the feature currently being edited by this builder. More... | |
| void | HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature) |
| Re-suppress an internal parent feature (a slave feature) after it has been edited. More... | |
| bool | ParentFeatureInternal () |
| Returns whether or not the latest timestamped parent feature of this feature should be made internal Created in NX5.0.0. More... | |
| bool | PatchSolutionFlag () |
| Returns the patch solution flag Created in NX8.0.1. More... | |
| NXString | PatchSurfaceFilename () |
| Returns the patch surface filename Created in NX8.0.1. More... | |
| void | SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature) |
| Set the parent features which would be internal or slaves to the feature being created or commited Created in NX6.0.0. More... | |
| void | SetParentFeatureInternal (bool isInternal) |
| Sets whether or not the latest timestamped parent feature of this feature should be made internal Created in NX5.0.0. More... | |
| void | SetPatchSolutionFlag (bool optionValue) |
| Sets the patch solution flag Created in NX8.0.1. More... | |
| void | SetPatchSurfaceFilename (const NXString &surfaceFilename) |
| Sets the patch surface filename Created in NX8.0.1. More... | |
| void | SetPatchSurfaceFilename (const char *surfaceFilename) |
| Sets the patch surface filename Created in NX8.0.1. More... | |
| void | SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename) |
| Sets the surrounding patch surface filename Created in NX8.0.1. More... | |
| void | SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename) |
| Sets the surrounding patch surface filename Created in NX8.0.1. More... | |
| void | ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature) |
| Unsuppress an internal parent feature (a slave feature) so it can be edited. More... | |
| NXString | SurroundingPatchSurfaceFilename () |
| Returns the surrounding patch surface filename Created in NX8.0.1. More... | |
| void | UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature) |
| Set the internal parent feature of the feature being edited to external Created in NX6.0.0. More... | |
| Public Member Functions inherited from NXOpen::Builder | |
| NXOpen::NXObject * | Commit () |
| Commits any edits that have been applied to the builder. More... | |
| void | Destroy () |
| Deletes the builder, and cleans up any objects created by the builder. More... | |
| std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
| For builders that create more than one object, this method returns the objects that are created by commit. More... | |
| NXOpen::NXObject * | GetObject () |
| Returns the object currently being edited by this builder. More... | |
| void | ShowResults () |
| Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
| virtual bool | Validate () |
| Validate whether the inputs to the component are sufficient for commit to be called. More... | |
| Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
Detailed Description
Represents 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
Created in NX5.0.0.
Member Enumeration Documentation
Member Function Documentation
| double NXOpen::Features::OffsetEmbossBuilder::AngleTolerance | ( | ) |
Returns the angle tolerance: The maximum allowable angle between the true theoretical sheet and the body created to approximate it.
Created in NX5.0.0.
License requirements : None
| NXOpen::Expression* NXOpen::Features::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.
Created in NX5.0.0.
License requirements : None
| NXOpen::Section* NXOpen::Features::OffsetEmbossBuilder::CenterLine | ( | ) |
Returns the center line: An existing curve/path on the sheet that defines the full extent of the offset feature required.
Created in NX5.0.0.
License requirements : None
| NXOpen::Point* NXOpen::Features::OffsetEmbossBuilder::CenterPoint | ( | ) |
Returns the center point: An existing point on the input sheet body is selected as the reference from which the feature is defined.
Created in NX5.0.0.
License requirements : None
| double NXOpen::Features::OffsetEmbossBuilder::DistanceTolerance | ( | ) |
Returns the distance tolerance: The maximum allowable distance between the true theoretical sheet and the body created to approximate it.
Created in NX5.0.0.
License requirements : None
| NXOpen::Expression* NXOpen::Features::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.
Created in NX5.0.0.
License requirements : None
| NXOpen::Expression* NXOpen::Features::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
Created in NX5.0.0.
License requirements : None
| bool NXOpen::Features::OffsetEmbossBuilder::ReverseDirection | ( | ) |
Returns 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.
Created in NX5.0.0.
License requirements : None
| NXOpen::Expression* NXOpen::Features::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.
Created in NX5.0.0.
License requirements : None
| void NXOpen::Features::OffsetEmbossBuilder::SetAngleTolerance | ( | double | angleTolerance | ) |
Sets the angle tolerance: The maximum allowable angle between the true theoretical sheet and the body created to approximate it.
Created in NX5.0.0.
License requirements : solid_modeling ("SOLIDS MODELING")
- Parameters
-
angleTolerance angletolerance
| void NXOpen::Features::OffsetEmbossBuilder::SetCenterPoint | ( | NXOpen::Point * | point | ) |
Sets the center point: An existing point on the input sheet body is selected as the reference from which the feature is defined.
Created in NX5.0.0.
License requirements : solid_modeling ("SOLIDS MODELING")
- Parameters
-
point point
| void NXOpen::Features::OffsetEmbossBuilder::SetDistanceTolerance | ( | double | distanceTolerance | ) |
Sets the distance tolerance: The maximum allowable distance between the true theoretical sheet and the body created to approximate it.
Created in NX5.0.0.
License requirements : solid_modeling ("SOLIDS MODELING")
- Parameters
-
distanceTolerance distancetolerance
| void NXOpen::Features::OffsetEmbossBuilder::SetReverseDirection | ( | bool | direction | ) |
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.
Created in NX5.0.0.
License requirements : solid_modeling ("SOLIDS MODELING")
- Parameters
-
direction direction
| void NXOpen::Features::OffsetEmbossBuilder::SetTarget | ( | NXOpen::ScCollector * | target | ) |
Sets the target body to offset This defines a sheet body to offset emboss.
Created in NX5.0.0.
License requirements : solid_modeling ("SOLIDS MODELING")
- Parameters
-
target target
| void NXOpen::Features::OffsetEmbossBuilder::SetType | ( | NXOpen::Features::OffsetEmbossBuilder::Types | type | ) |
Sets the center type This defines input types: 0 stands for curve case and 1 stands for point case.
Created in NX5.0.0.
License requirements : solid_modeling ("SOLIDS MODELING")
- Parameters
-
type type
| NXOpen::Expression* NXOpen::Features::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.
Created in NX5.0.0.
License requirements : None
| NXOpen::ScCollector* NXOpen::Features::OffsetEmbossBuilder::Target | ( | ) |
Returns the target body to offset This defines a sheet body to offset emboss.
Created in NX5.0.0.
License requirements : None
| NXOpen::Expression* NXOpen::Features::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.
Created in NX5.0.0.
License requirements : None
| NXOpen::Features::OffsetEmbossBuilder::Types NXOpen::Features::OffsetEmbossBuilder::Type | ( | ) |
Returns the center type This defines input types: 0 stands for curve case and 1 stands for point case.
Created in NX5.0.0.
License requirements : None
The documentation for this class was generated from the following file:
- Features_OffsetEmbossBuilder.hxx