NX Open C++ Reference Guide
|
Represents a Dimple feature builder. More...
Public Types | |
enum | DepthTypeOptions { DepthTypeOptionsSectionNormalSide, DepthTypeOptionsSectionReverseNormalSide } |
This enum represents the depth direction for the dimple. More... | |
enum | DimensionTypeOptions { DimensionTypeOptionsOffset, DimensionTypeOptionsFull } |
the Dimension options for dimple. More... | |
enum | SectionSideOptions { SectionSideOptionsLeft, SectionSideOptionsRight } |
This enum represents the side of the section that the dimple punches material. More... | |
enum | SidewallTypeOptions { SidewallTypeOptionsOutside, SidewallTypeOptionsInside } |
the side walls material option. More... | |
Public Member Functions | |
NXOpen::Features::SheetMetal::DimpleBuilder::DepthTypeOptions | DepthType () |
Returns the Direction in which the Dimple is punched. | |
NXOpen::Features::SheetMetal::DimpleBuilder::DimensionTypeOptions | DimensionType () |
Returns the Offset Dimension The actual extent distance of the Dimple will be determined by the active dimension option. | |
bool | FilletSectionCorners () |
Returns the Rounding Option for section Corners which contain Non Fillet Radii. | |
NXOpen::Expression * | GetDepth () |
Depth of the Dimple. | |
NXOpen::Expression * | GetDieRadius () |
Radius value of the sharp edges of the bottom face. | |
NXOpen::Expression * | GetFilletRadius () |
Fillet Radius to be applied for rounding the Sharp section Corners. | |
NXOpen::Expression * | GetPunchRadius () |
Radius value of the sharp edges on the top face. | |
NXOpen::Expression * | GetTaperAngle () |
Taper Angle of the Dimple. | |
bool | IncludeRounding () |
Returns the Rounding type of the Sharp edges of bottom face and top face. | |
NXOpen::Expression * | MinimumToolClearance () |
Returns the minimum tool clearance expression. | |
NXOpen::Section * | Section () |
Returns the Section used by the Dimple. | |
NXOpen::Features::SheetMetal::DimpleBuilder::SectionSideOptions | SectionSide () |
Returns the section Side for the Dimple section. | |
void | SetDepth (const NXString &extent) |
Created in NX4.0.0. | |
void | SetDepth (const char *extent) |
Created in NX4.0.0. | |
void | SetDepthType (NXOpen::Features::SheetMetal::DimpleBuilder::DepthTypeOptions depthType) |
Sets the Direction in which the Dimple is punched. | |
void | SetDieRadius (const NXString &dieRadius) |
Created in NX4.0.0. | |
void | SetDieRadius (const char *dieRadius) |
Created in NX4.0.0. | |
void | SetDimensionType (NXOpen::Features::SheetMetal::DimpleBuilder::DimensionTypeOptions dimensionType) |
Sets the Offset Dimension The actual extent distance of the Dimple will be determined by the active dimension option. | |
void | SetFilletRadius (const NXString &filletRadius) |
Created in NX4.0.0. | |
void | SetFilletRadius (const char *filletRadius) |
Created in NX4.0.0. | |
void | SetFilletSectionCorners (bool filletSectionCorners) |
Sets the Rounding Option for section Corners which contain Non Fillet Radii. | |
void | SetIncludeRounding (bool includeRounding) |
Sets the Rounding type of the Sharp edges of bottom face and top face. | |
void | SetPunchRadius (const NXString &punchRadius) |
Created in NX4.0.0. | |
void | SetPunchRadius (const char *punchRadius) |
Created in NX4.0.0. | |
void | SetSection (NXOpen::Section *section) |
Sets the Section used by the Dimple. | |
void | SetSectionSide (NXOpen::Features::SheetMetal::DimpleBuilder::SectionSideOptions sectionSide) |
Sets the section Side for the Dimple section. | |
void | SetSidewallType (NXOpen::Features::SheetMetal::DimpleBuilder::SidewallTypeOptions sidewallType) |
Sets the side where the material must be added to the dimple. | |
void | SetSketch (NXOpen::Features::SketchFeature *sketch) |
Sets the Slave Sketch used by the Dimple, If one exists. | |
void | SetTaperAngle (const NXString &taperAngle) |
Created in NX4.0.0. | |
void | SetTaperAngle (const char *taperAngle) |
Created in NX4.0.0. | |
NXOpen::Features::SheetMetal::DimpleBuilder::SidewallTypeOptions | SidewallType () |
Returns the side where the material must be added to the dimple. | |
NXOpen::Features::SketchFeature * | Sketch () |
Returns the Slave Sketch used by the Dimple, If one exists. | |
int | ValidateBuilderData () |
Verify whether the builder data is valid for creating a dimple or not. | |
![]() | |
NXOpen::Features::Feature * | CommitFeature () |
Commits the feature parameters and creates the feature. | |
NXOpen::Features::Feature * | GetFeature () |
Returns the feature currently being edited by this builder. | |
void | HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature) |
Re-suppress an internal parent feature (a slave feature) after it has been edited. | |
bool | ParentFeatureInternal () |
Returns whether or not the latest timestamped parent feature of this feature should be made internal Created in NX5.0.0. | |
bool | PatchSolutionFlag () |
Returns the patch solution flag Created in NX8.0.1. | |
NXString | PatchSurfaceFilename () |
Returns the patch surface filename Created in NX8.0.1. | |
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. | |
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. | |
void | SetPatchSolutionFlag (bool optionValue) |
Sets the patch solution flag Created in NX8.0.1. | |
void | SetPatchSurfaceFilename (const NXString &surfaceFilename) |
Sets the patch surface filename Created in NX8.0.1. | |
void | SetPatchSurfaceFilename (const char *surfaceFilename) |
Sets the patch surface filename Created in NX8.0.1. | |
void | SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename) |
Sets the surrounding patch surface filename Created in NX8.0.1. | |
void | SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename) |
Sets the surrounding patch surface filename Created in NX8.0.1. | |
void | ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature) |
Unsuppress an internal parent feature (a slave feature) so it can be edited. | |
NXString | SurroundingPatchSurfaceFilename () |
Returns the surrounding patch surface filename Created in NX8.0.1. | |
void | UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature) |
Set the internal parent feature of the feature being edited to external Created in NX6.0.0. | |
![]() | |
NXOpen::NXObject * | Commit () |
Commits any edits that have been applied to the builder. | |
void | Destroy () |
Deletes the builder, and cleans up any objects created by the builder. | |
std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
For builders that create more than one object, this method returns the objects that are created by commit. | |
NXOpen::NXObject * | GetObject () |
Returns the object currently being edited by this builder. | |
void | ShowResults () |
Updates the model to reflect the result of an edit to the model for all builders that support showing results. | |
virtual bool | Validate () |
Validate whether the inputs to the component are sufficient for commit to be called. | |
![]() | |
tag_t | GetTag () const |
<b>Deprecated</b>:<br> Use Tag instead. | |
tag_t | Tag () const |
Returns the tag of this object. | |
Represents a Dimple feature builder.
To create a new instance of this class, use Features::SheetMetal::SheetmetalManager::CreateDimpleFeatureBuilder
Created in NX4.0.0.
the Dimension options for dimple.
This specifies whether the dimple's depth must be measured from the plane to which the section is attached or from the
This enum represents the side of the section that the dimple punches material.
The "left" option represents the side to the left of a person who is walking along the section in the direction of its curves when the section normal is pointing up. The "right" option represents the person's right hand side. This interpretation is the same regardless of whether the section is open or closed. The "right" side at any point along the section can also be represented by the vector resulting from the cross product of the curve tangent (of the section curve at that point) and the section normal. The "left" side is the opposite.
the side walls material option.
This specifies whether the dimple's outerwalls or the innerwalls coincide with the section outline
NXOpen::Features::SheetMetal::DimpleBuilder::DepthTypeOptions NXOpen::Features::SheetMetal::DimpleBuilder::DepthType | ( | ) |
Returns the Direction in which the Dimple is punched.
<br> This is used to specify the direction in which the punching should happen. If Punching must happen in the direction of the Section Normal (specified using the @link Features::SheetMetal::DimpleBuilder::Section Features::SheetMetal::DimpleBuilder::Section @endlink and @link Features::SheetMetal::DimpleBuilder::SetSection Features::SheetMetal::DimpleBuilder::SetSection @endlink ) then pass the value of @link Features::SheetMetal::DimpleBuilder::DepthTypeOptionsSectionNormalSide Features::SheetMetal::DimpleBuilder::DepthTypeOptionsSectionNormalSide@endlink If punching must happen in the opposite direction to that of Section Normal, set the value to be @link Features::SheetMetal::DimpleBuilder::DepthTypeOptionsSectionReverseNormalSide Features::SheetMetal::DimpleBuilder::DepthTypeOptionsSectionReverseNormalSide@endlink <br>
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
NXOpen::Features::SheetMetal::DimpleBuilder::DimensionTypeOptions NXOpen::Features::SheetMetal::DimpleBuilder::DimensionType | ( | ) |
Returns the Offset Dimension
The actual extent distance of the Dimple will be determined by the active dimension option.
In case of @link Features::SheetMetal::DimpleBuilder::DimensionTypeOptionsOffset Features::SheetMetal::DimpleBuilder::DimensionTypeOptionsOffset@endlink the actual extent distance will be offset dimension distance plus the thickness of sheet. In case of @link Features::SheetMetal::DimpleBuilder::DimensionTypeOptionsFull Features::SheetMetal::DimpleBuilder::DimensionTypeOptionsFull@endlink the actual extent distance will be the Full dimension distance. <br>
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
bool NXOpen::Features::SheetMetal::DimpleBuilder::FilletSectionCorners | ( | ) |
Returns the Rounding Option for section Corners which contain Non Fillet Radii.
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
NXOpen::Expression* NXOpen::Features::SheetMetal::DimpleBuilder::GetDepth | ( | ) |
Depth of the Dimple.
NXOpen::Expression* NXOpen::Features::SheetMetal::DimpleBuilder::GetDieRadius | ( | ) |
Radius value of the sharp edges of the bottom face.
NXOpen::Expression* NXOpen::Features::SheetMetal::DimpleBuilder::GetFilletRadius | ( | ) |
Fillet Radius to be applied for rounding the Sharp section Corners.
@return
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
NXOpen::Expression* NXOpen::Features::SheetMetal::DimpleBuilder::GetPunchRadius | ( | ) |
Radius value of the sharp edges on the top face.
NXOpen::Expression* NXOpen::Features::SheetMetal::DimpleBuilder::GetTaperAngle | ( | ) |
Taper Angle of the Dimple.
<br> In case of a tapered dimple, the taper angle is applied on the side faces of the above-protruded section. The affects of taper angle will always increases the cavity volume of the dimple. <br> @return
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
bool NXOpen::Features::SheetMetal::DimpleBuilder::IncludeRounding | ( | ) |
Returns the Rounding type of the Sharp edges of bottom face and top face.
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
NXOpen::Expression* NXOpen::Features::SheetMetal::DimpleBuilder::MinimumToolClearance | ( | ) |
Returns the minimum tool clearance expression.
Created in NX6.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
NXOpen::Section* NXOpen::Features::SheetMetal::DimpleBuilder::Section | ( | ) |
Returns the Section used by the Dimple.
Section can be Open/Closed.
The section is protruded on the reference face at finite distance of extent and in the direction of extent side. The actual extent distance will be determined by the active dimension option i.e. Offset Dimension or Full Dimension. In case of Offset Dimension the actual extent distance will be offset dimension distance plus the thickness of sheet. In case of Full Dimension the actual extent distance will be the Full dimension distance. In case of open section, the end segments are extended to the nearest flat face edges. If the end segments are already crossing the flat face edges, those segments will be trimmed to the edges.
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
NXOpen::Features::SheetMetal::DimpleBuilder::SectionSideOptions NXOpen::Features::SheetMetal::DimpleBuilder::SectionSide | ( | ) |
Returns the section Side for the Dimple section.
<br> This is used to specify which side of the section should remain stationary during the Dimple operation. Dimple's section is a set of connected curves. The material exists on both sides of the section curves. section Side specifies - the material on which side of the curve must be punched.The other side shall be bent to the specified angle with respect to this fixed side. This is how you calculate Left/Right. Get the Section Normal (N)Get the Tangent of the section.(T) Result = CrossProduct(N, T). The resultant vector is called RIGHT. This vector shall be in the direction of one if the two sides of the material.If you want the material on the side of Result to be punched, then you have to pass the value of @link Features::SheetMetal::DimpleBuilder::SectionSideOptionsRight Features::SheetMetal::DimpleBuilder::SectionSideOptionsRight@endlink If you want the other side to be punched, then you have to send @link Features::SheetMetal::DimpleBuilder::SectionSideOptionsLeft Features::SheetMetal::DimpleBuilder::SectionSideOptionsLeft@endlink . <br>
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
void NXOpen::Features::SheetMetal::DimpleBuilder::SetDepth | ( | const NXString & | extent | ) |
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
extent | NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Features::SheetMetal::DimpleBuilder::SetDepth | ( | const char * | extent | ) |
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
extent | NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Features::SheetMetal::DimpleBuilder::SetDepthType | ( | NXOpen::Features::SheetMetal::DimpleBuilder::DepthTypeOptions | depthType | ) |
Sets the Direction in which the Dimple is punched.
<br> This is used to specify the direction in which the punching should happen. If Punching must happen in the direction of the Section Normal (specified using the @link Features::SheetMetal::DimpleBuilder::Section Features::SheetMetal::DimpleBuilder::Section @endlink and @link Features::SheetMetal::DimpleBuilder::SetSection Features::SheetMetal::DimpleBuilder::SetSection @endlink ) then pass the value of @link Features::SheetMetal::DimpleBuilder::DepthTypeOptionsSectionNormalSide Features::SheetMetal::DimpleBuilder::DepthTypeOptionsSectionNormalSide@endlink If punching must happen in the opposite direction to that of Section Normal, set the value to be @link Features::SheetMetal::DimpleBuilder::DepthTypeOptionsSectionReverseNormalSide Features::SheetMetal::DimpleBuilder::DepthTypeOptionsSectionReverseNormalSide@endlink <br>
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
depthType | depth type |
void NXOpen::Features::SheetMetal::DimpleBuilder::SetDieRadius | ( | const NXString & | dieRadius | ) |
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
dieRadius | NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Features::SheetMetal::DimpleBuilder::SetDieRadius | ( | const char * | dieRadius | ) |
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
dieRadius | NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Features::SheetMetal::DimpleBuilder::SetDimensionType | ( | NXOpen::Features::SheetMetal::DimpleBuilder::DimensionTypeOptions | dimensionType | ) |
Sets the Offset Dimension
The actual extent distance of the Dimple will be determined by the active dimension option.
In case of @link Features::SheetMetal::DimpleBuilder::DimensionTypeOptionsOffset Features::SheetMetal::DimpleBuilder::DimensionTypeOptionsOffset@endlink the actual extent distance will be offset dimension distance plus the thickness of sheet. In case of @link Features::SheetMetal::DimpleBuilder::DimensionTypeOptionsFull Features::SheetMetal::DimpleBuilder::DimensionTypeOptionsFull@endlink the actual extent distance will be the Full dimension distance. <br>
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
dimensionType | dimension type |
void NXOpen::Features::SheetMetal::DimpleBuilder::SetFilletRadius | ( | const NXString & | filletRadius | ) |
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
filletRadius | NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Features::SheetMetal::DimpleBuilder::SetFilletRadius | ( | const char * | filletRadius | ) |
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
filletRadius | NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Features::SheetMetal::DimpleBuilder::SetFilletSectionCorners | ( | bool | filletSectionCorners | ) |
Sets the Rounding Option for section Corners which contain Non Fillet Radii.
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
filletSectionCorners | fillet section corners |
void NXOpen::Features::SheetMetal::DimpleBuilder::SetIncludeRounding | ( | bool | includeRounding | ) |
Sets the Rounding type of the Sharp edges of bottom face and top face.
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
includeRounding | include rounding |
void NXOpen::Features::SheetMetal::DimpleBuilder::SetPunchRadius | ( | const NXString & | punchRadius | ) |
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
punchRadius | NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Features::SheetMetal::DimpleBuilder::SetPunchRadius | ( | const char * | punchRadius | ) |
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
punchRadius | NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Features::SheetMetal::DimpleBuilder::SetSection | ( | NXOpen::Section * | section | ) |
Sets the Section used by the Dimple.
Section can be Open/Closed.
The section is protruded on the reference face at finite distance of extent and in the direction of extent side. The actual extent distance will be determined by the active dimension option i.e. Offset Dimension or Full Dimension. In case of Offset Dimension the actual extent distance will be offset dimension distance plus the thickness of sheet. In case of Full Dimension the actual extent distance will be the Full dimension distance. In case of open section, the end segments are extended to the nearest flat face edges. If the end segments are already crossing the flat face edges, those segments will be trimmed to the edges.
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
section | section |
void NXOpen::Features::SheetMetal::DimpleBuilder::SetSectionSide | ( | NXOpen::Features::SheetMetal::DimpleBuilder::SectionSideOptions | sectionSide | ) |
Sets the section Side for the Dimple section.
<br> This is used to specify which side of the section should remain stationary during the Dimple operation. Dimple's section is a set of connected curves. The material exists on both sides of the section curves. section Side specifies - the material on which side of the curve must be punched.The other side shall be bent to the specified angle with respect to this fixed side. This is how you calculate Left/Right. Get the Section Normal (N)Get the Tangent of the section.(T) Result = CrossProduct(N, T). The resultant vector is called RIGHT. This vector shall be in the direction of one if the two sides of the material.If you want the material on the side of Result to be punched, then you have to pass the value of @link Features::SheetMetal::DimpleBuilder::SectionSideOptionsRight Features::SheetMetal::DimpleBuilder::SectionSideOptionsRight@endlink If you want the other side to be punched, then you have to send @link Features::SheetMetal::DimpleBuilder::SectionSideOptionsLeft Features::SheetMetal::DimpleBuilder::SectionSideOptionsLeft@endlink . <br>
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
sectionSide | section side |
void NXOpen::Features::SheetMetal::DimpleBuilder::SetSidewallType | ( | NXOpen::Features::SheetMetal::DimpleBuilder::SidewallTypeOptions | sidewallType | ) |
Sets the side where the material must be added to the dimple.
Done with Respect to the section
If Features::SheetMetal::DimpleBuilder::SidewallTypeOptionsInside is specified, the material of the dimple sidewalls will be added to the interior of the section. If Features::SheetMetal::DimpleBuilder::SidewallTypeOptionsOutside is specified,the material will be added from the lifted section such that the volume of the dimple cavity is increased.
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
sidewallType | sidewall type |
void NXOpen::Features::SheetMetal::DimpleBuilder::SetSketch | ( | NXOpen::Features::SketchFeature * | sketch | ) |
Sets the Slave Sketch used by the Dimple, If one exists.
<br> If the Sketch is created internally as part of the Dimple command in the UI, then it shall be consumed by the Dimple and shall not show up as a seperate feature in the Part Navigator. If such a behaviour is deired, then specify the Sketch here. <br>
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
sketch | sketch |
void NXOpen::Features::SheetMetal::DimpleBuilder::SetTaperAngle | ( | const NXString & | taperAngle | ) |
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
taperAngle | NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Features::SheetMetal::DimpleBuilder::SetTaperAngle | ( | const char * | taperAngle | ) |
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
taperAngle | NOTE: The full Unicode character set is not supported for this parameter. |
NXOpen::Features::SheetMetal::DimpleBuilder::SidewallTypeOptions NXOpen::Features::SheetMetal::DimpleBuilder::SidewallType | ( | ) |
Returns the side where the material must be added to the dimple.
Done with Respect to the section
If Features::SheetMetal::DimpleBuilder::SidewallTypeOptionsInside is specified, the material of the dimple sidewalls will be added to the interior of the section. If Features::SheetMetal::DimpleBuilder::SidewallTypeOptionsOutside is specified,the material will be added from the lifted section such that the volume of the dimple cavity is increased.
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
NXOpen::Features::SketchFeature* NXOpen::Features::SheetMetal::DimpleBuilder::Sketch | ( | ) |
Returns the Slave Sketch used by the Dimple, If one exists.
<br> If the Sketch is created internally as part of the Dimple command in the UI, then it shall be consumed by the Dimple and shall not show up as a seperate feature in the Part Navigator. If such a behaviour is deired, then specify the Sketch here. <br>
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")
int NXOpen::Features::SheetMetal::DimpleBuilder::ValidateBuilderData | ( | ) |
Verify whether the builder data is valid for creating a dimple or not.
<br> If the Builder data is valid, returned value shall be 0 <br> @return Data Validity Flag.
Created in NX4.0.0.
License requirements : nx_sheet_metal ("NX Sheet Metal")