NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Features::SheetMetal::DimpleBuilder Class Reference

Represents a Dimple feature builder. More...

Inheritance diagram for NXOpen::Features::SheetMetal::DimpleBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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::ExpressionGetDepth ()
 Depth of the Dimple.
NXOpen::ExpressionGetDieRadius ()
 Radius value of the sharp edges of the bottom face.
NXOpen::ExpressionGetFilletRadius ()
 Fillet Radius to be applied for rounding the Sharp section Corners.
NXOpen::ExpressionGetPunchRadius ()
 Radius value of the sharp edges on the top face.
NXOpen::ExpressionGetTaperAngle ()
 Taper Angle of the Dimple.
bool IncludeRounding ()
 Returns the Rounding type of the Sharp edges of bottom face and top face.
NXOpen::ExpressionMinimumToolClearance ()
 Returns the minimum tool clearance expression.
NXOpen::SectionSection ()
 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 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 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 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 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.
NXOpen::Features::SheetMetal::DimpleBuilder::SidewallTypeOptions SidewallType ()
 Returns the side where the material must be added to the dimple.
NXOpen::Features::SketchFeatureSketch ()
 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.

Detailed Description

Represents a Dimple feature builder.


To create a new instance of this class, use Features::SheetMetal::SheetmetalManager::CreateDimpleFeatureBuilder

Created in NX4.0.0.


Member Enumeration Documentation

This enum represents the depth direction for the dimple.

Enumerator:
DepthTypeOptionsSectionNormalSide 

Dimple punched on the side of the section normal.

DepthTypeOptionsSectionReverseNormalSide 

Dimple punched on the side opposite to that of the section normal.

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

Enumerator:
DimensionTypeOptionsOffset 

the actual depth will be depth plus the thickness of sheet.

DimensionTypeOptionsFull 

the actual extent distance will be the value specified as depth.

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.

Enumerator:
SectionSideOptionsLeft 

Side pointed to by the inverse of the tangent cross normal vector.

SectionSideOptionsRight 

Side pointed to by the tangent cross normal vector.

the side walls material option.

This specifies whether the dimple's outerwalls or the innerwalls coincide with the section outline

Enumerator:
SidewallTypeOptionsOutside 

the innerface of the dimple side walls coincides with the section outline.

SidewallTypeOptionsInside 

the outerface of the dimple side walls coincides with the section outline.


Member Function Documentation

Returns the Direction in which the Dimple is punched.


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 Features::SheetMetal::DimpleBuilder::Section and Features::SheetMetal::DimpleBuilder::SetSection ) then pass the value of Features::SheetMetal::DimpleBuilder::DepthTypeOptionsSectionNormalSide If punching must happen in the opposite direction to that of Section Normal, set the value to be Features::SheetMetal::DimpleBuilder::DepthTypeOptionsSectionReverseNormalSide


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Returns the Offset Dimension
The actual extent distance of the Dimple will be determined by the active dimension option.

In case of Features::SheetMetal::DimpleBuilder::DimensionTypeOptionsOffset the actual extent distance will be offset dimension distance plus the thickness of sheet. In case of Features::SheetMetal::DimpleBuilder::DimensionTypeOptionsFull the actual extent distance will be the Full dimension distance.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

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")

Depth of the Dimple.

Returns:

Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Radius value of the sharp edges of the bottom face.

Returns:

Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Fillet Radius to be applied for rounding the Sharp section Corners.

Returns:

Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Radius value of the sharp edges on the top face.

Returns:

Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Taper Angle of the Dimple.


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.

Returns:

Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

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")

Returns the minimum tool clearance expression.


Created in NX6.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

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")

Returns the section Side for the Dimple section.


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 Features::SheetMetal::DimpleBuilder::SectionSideOptionsRight If you want the other side to be punched, then you have to send Features::SheetMetal::DimpleBuilder::SectionSideOptionsLeft .


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")


Created in NX4.0.0.



License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
extent
NOTE: The full Unicode character set is not supported for this parameter.

Sets the Direction in which the Dimple is punched.


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 Features::SheetMetal::DimpleBuilder::Section and Features::SheetMetal::DimpleBuilder::SetSection ) then pass the value of Features::SheetMetal::DimpleBuilder::DepthTypeOptionsSectionNormalSide If punching must happen in the opposite direction to that of Section Normal, set the value to be Features::SheetMetal::DimpleBuilder::DepthTypeOptionsSectionReverseNormalSide


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
depthTypedepth type


Created in NX4.0.0.



License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
dieRadius
NOTE: The full Unicode character set is not supported for this parameter.

Sets the Offset Dimension
The actual extent distance of the Dimple will be determined by the active dimension option.

In case of Features::SheetMetal::DimpleBuilder::DimensionTypeOptionsOffset the actual extent distance will be offset dimension distance plus the thickness of sheet. In case of Features::SheetMetal::DimpleBuilder::DimensionTypeOptionsFull the actual extent distance will be the Full dimension distance.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
dimensionTypedimension type


Created in NX4.0.0.



License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
filletRadius
NOTE: The full Unicode character set is not supported for this parameter.

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")

Parameters:
filletSectionCornersfillet section corners

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")

Parameters:
includeRoundinginclude rounding


Created in NX4.0.0.



License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
punchRadius
NOTE: The full Unicode character set is not supported for this parameter.

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")

Parameters:
sectionsection

Sets the section Side for the Dimple section.


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 Features::SheetMetal::DimpleBuilder::SectionSideOptionsRight If you want the other side to be punched, then you have to send Features::SheetMetal::DimpleBuilder::SectionSideOptionsLeft .


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
sectionSidesection side

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")

Parameters:
sidewallTypesidewall type

Sets the Slave Sketch used by the Dimple, If one exists.


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.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
sketchsketch


Created in NX4.0.0.



License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
taperAngle
NOTE: The full Unicode character set is not supported for this parameter.

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")

Returns the Slave Sketch used by the Dimple, If one exists.


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.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Verify whether the builder data is valid for creating a dimple or not.


If the Builder data is valid, returned value shall be 0


Returns:
Data Validity Flag.
Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.