NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Die::ClearanceBuilder Class Reference

Represents a builder that is used to create or edit a NXOpen::Die::Clearance feature. More...

Inheritance diagram for NXOpen::Die::ClearanceBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ClearanceGeometryTypes { ClearanceGeometryTypesSolid, ClearanceGeometryTypesSection }
 Identifies which type of input defines the clearance. More...
 
enum  Types { TypesGage, TypesGripper, TypesLifter }
 Identifies which clearance type is being created in the casting. More...
 

Public Member Functions

double AngleTolerance ()
 Returns the angle tolerance. More...
 
NXOpen::Die::DieAttributesBuilderAttributes ()
 Returns the attribute title, value and face color to apply to the clearance faces. More...
 
NXOpen::Die::DieDirectionBuilderClearanceDirection ()
 Returns the direction to use when extruding to create the clearance areas. More...
 
NXOpen::Die::ClearanceBuilder::ClearanceGeometryTypes ClearanceGeometryType ()
 Returns the input type of the clearance geometry. More...
 
NXOpen::ExpressionDistance ()
 Returns the expression containing the distance value for extrusions when defining the clearance area. More...
 
double DistanceTolerance ()
 Returns the distance tolerance. More...
 
NXOpen::SelectBodyListGeometry ()
 Returns the solid to use for the basis of the clearance area. More...
 
NXOpen::ExpressionOffset ()
 Returns the expression containing the offset value to apply to create a clearance area around the solid or closed profile definitions. More...
 
NXOpen::Die::DiePlaneBuilderOrientation ()
 Returns the projection plane for the closed profiles to define the clearance areas. More...
 
NXOpen::SectionSection ()
 Returns the closed profile sections to use for the basis of the clearance area. More...
 
void SetAngleTolerance (double angleTolerance)
 Sets the angle tolerance. More...
 
void SetClearanceGeometryType (NXOpen::Die::ClearanceBuilder::ClearanceGeometryTypes clearanceGeometryType)
 Sets the input type of the clearance geometry. More...
 
void SetDistanceTolerance (double distanceTolerance)
 Sets the distance tolerance. More...
 
void SetType (NXOpen::Die::ClearanceBuilder::Types type)
 Sets the identification of the clearance type (NXOpen::Die::ClearanceBuilder::TypesGage , NXOpen::Die::ClearanceBuilder::TypesGripper , or NXOpen::Die::ClearanceBuilder::TypesLifter ) to create in the target solid. More...
 
NXOpen::SelectBodyTarget ()
 Returns the target solid the clearance will be subtracted from. More...
 
NXOpen::Die::ClearanceBuilder::Types Type ()
 Returns the identification of the clearance type (NXOpen::Die::ClearanceBuilder::TypesGage , NXOpen::Die::ClearanceBuilder::TypesGripper , or NXOpen::Die::ClearanceBuilder::TypesLifter ) to create in the target solid. More...
 
- Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::FeatureCommitFeature ()
 Commits the feature parameters and creates the feature. More...
 
NXOpen::Features::FeatureGetFeature ()
 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::NXObjectCommit ()
 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::NXObjectGetObject ()
 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 that is used to create or edit a NXOpen::Die::Clearance feature.


To create a new instance of this class, use NXOpen::Die::DieCollection::CreateClearanceBuilder
Default values.

Property Value

ClearanceGeometryType

Solid

Distance.Value

0 (millimeters part), 0 (inches part)

Offset.Value

5 (millimeters part), 0.2 (inches part)


Created in NX7.5.0.

Member Enumeration Documentation

Identifies which type of input defines the clearance.

Enumerator
ClearanceGeometryTypesSolid 

The input is solids.

ClearanceGeometryTypesSection 

The input is closed profiles.

Identifies which clearance type is being created in the casting.

Enumerator
TypesGage 

Clearance will be provided encompassing gage solids.

TypesGripper 

Clearance will be provided encompassing gripper, or transfer, machinery solids.

TypesLifter 

Clearance will be provided encompassing interior casting lifting solids.

Member Function Documentation

double NXOpen::Die::ClearanceBuilder::AngleTolerance ( )

Returns the angle tolerance.


Created in NX7.5.0.

License requirements : None

NXOpen::Die::DieAttributesBuilder* NXOpen::Die::ClearanceBuilder::Attributes ( )

Returns the attribute title, value and face color to apply to the clearance faces.


Created in NX7.5.0.

License requirements : None

NXOpen::Die::DieDirectionBuilder* NXOpen::Die::ClearanceBuilder::ClearanceDirection ( )

Returns the direction to use when extruding to create the clearance areas.


Created in NX7.5.0.

License requirements : None

NXOpen::Die::ClearanceBuilder::ClearanceGeometryTypes NXOpen::Die::ClearanceBuilder::ClearanceGeometryType ( )

Returns the input type of the clearance geometry.


Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::ClearanceBuilder::Distance ( )

Returns the expression containing the distance value for extrusions when defining the clearance area.

If the value is 0.0, then a value will be generated from the target solid.
Created in NX7.5.0.

License requirements : None

double NXOpen::Die::ClearanceBuilder::DistanceTolerance ( )

Returns the distance tolerance.


Created in NX7.5.0.

License requirements : None

NXOpen::SelectBodyList* NXOpen::Die::ClearanceBuilder::Geometry ( )

Returns the solid to use for the basis of the clearance area.

Only valid when type is NXOpen::Die::ClearanceBuilder::ClearanceGeometryTypesSolid .
Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Die::ClearanceBuilder::Offset ( )

Returns the expression containing the offset value to apply to create a clearance area around the solid or closed profile definitions.


Created in NX7.5.0.

License requirements : None

NXOpen::Die::DiePlaneBuilder* NXOpen::Die::ClearanceBuilder::Orientation ( )

Returns the projection plane for the closed profiles to define the clearance areas.

Only valid when type is NXOpen::Die::ClearanceBuilder::ClearanceGeometryTypesSection .
Created in NX7.5.0.

License requirements : None

NXOpen::Section* NXOpen::Die::ClearanceBuilder::Section ( )

Returns the closed profile sections to use for the basis of the clearance area.

Only valid when type is NXOpen::Die::ClearanceBuilder::ClearanceGeometryTypesSection .
Created in NX7.5.0.

License requirements : None

void NXOpen::Die::ClearanceBuilder::SetAngleTolerance ( double  angleTolerance)

Sets the angle tolerance.


Created in NX7.5.0.

License requirements : ug_die_design ("Die Design")

Parameters
angleToleranceangletolerance
void NXOpen::Die::ClearanceBuilder::SetClearanceGeometryType ( NXOpen::Die::ClearanceBuilder::ClearanceGeometryTypes  clearanceGeometryType)

Sets the input type of the clearance geometry.


Created in NX7.5.0.

License requirements : ug_die_design ("Die Design")

Parameters
clearanceGeometryTypeclearancegeometrytype
void NXOpen::Die::ClearanceBuilder::SetDistanceTolerance ( double  distanceTolerance)

Sets the distance tolerance.


Created in NX7.5.0.

License requirements : ug_die_design ("Die Design")

Parameters
distanceTolerancedistancetolerance
void NXOpen::Die::ClearanceBuilder::SetType ( NXOpen::Die::ClearanceBuilder::Types  type)

Sets the identification of the clearance type (NXOpen::Die::ClearanceBuilder::TypesGage , NXOpen::Die::ClearanceBuilder::TypesGripper , or NXOpen::Die::ClearanceBuilder::TypesLifter ) to create in the target solid.


Created in NX7.5.0.

License requirements : ug_die_design ("Die Design")

Parameters
typetype
NXOpen::SelectBody* NXOpen::Die::ClearanceBuilder::Target ( )

Returns the target solid the clearance will be subtracted from.


Created in NX7.5.0.

License requirements : None

NXOpen::Die::ClearanceBuilder::Types NXOpen::Die::ClearanceBuilder::Type ( )

Returns the identification of the clearance type (NXOpen::Die::ClearanceBuilder::TypesGage , NXOpen::Die::ClearanceBuilder::TypesGripper , or NXOpen::Die::ClearanceBuilder::TypesLifter ) to create in the target solid.


Created in NX7.5.0.

License requirements : None


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