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

Represents a Draft Feature Builder that creates or edits a draft (Old name Taper) feature. More...

Inheritance diagram for NXOpen::Features::DraftBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  DraftReferencesMethods { DraftReferencesMethodsStationaryFace, DraftReferencesMethodsPartingFace, DraftReferencesMethodsStationaryAndPartingFace }
 Describes the different Draft Methods in Draft References. More...
 
enum  Method { MethodIsocline, MethodTrueDraft }
 Describes the Draft type as true draft or isocline draft. More...
 
enum  Type { TypeFace, TypeEdge, TypeTangent, TypePartingEdge }
 Describes the different Draft types. More...
 

Public Member Functions

double AngleTolerance ()
 Returns the angle tolerance in [rad/deg]. More...
 
NXOpen::DirectionDirection ()
 Returns the smart direction for draft. More...
 
double DistanceTolerance ()
 Returns the distance tolerance in [in/mm]. More...
 
bool DraftAllInstances ()
 Returns the option "Draft all instances" [true/false]. More...
 
bool DraftBothSides ()
 Returns whether to draft on both sides of the reference
Created in NX8.5.0. More...
 
NXOpen::Features::DraftBuilder::Method DraftIsoclineOrTruedraft ()
 Returns the Draft method. More...
 
NXOpen::Features::DraftBuilder::DraftReferencesMethods DraftReferencesMethod ()
 Returns the draft references method
Created in NX8.5.0. More...
 
NXOpen::ExpressionCollectorSetListEdgeSetAngleExpressionList ()
 Returns the list of draft edges SC Collectors and corresponding draft angles. More...
 
NXOpen::ExpressionCollectorSetListFaceSetAngleExpressionList ()
 Returns the list of draft faces SC Collectors and corresponding draft angles. More...
 
NXOpen::ScCollectorPartingReference ()
 Returns the parting reference as SC Collector containing only faces or only one datum plane or only one point. More...
 
void SetAngleTolerance (double angleTolerance)
 Sets the angle tolerance in [rad/deg]. More...
 
void SetDirection (NXOpen::Direction *direction)
 Sets the smart direction for draft. More...
 
void SetDistanceTolerance (double distanceTolerance)
 Sets the distance tolerance in [in/mm]. More...
 
void SetDraftAllInstances (bool draftAllInstances)
 Sets the option "Draft all instances" [true/false]. More...
 
void SetDraftBothSides (bool draftBothSides)
 Sets whether to draft on both sides of the reference
Created in NX8.5.0. More...
 
void SetDraftIsoclineOrTruedraft (NXOpen::Features::DraftBuilder::Method draftMethod)
 Sets the Draft method. More...
 
void SetDraftReferencesMethod (NXOpen::Features::DraftBuilder::DraftReferencesMethods draftReferencesMethod)
 Sets the draft references method
Created in NX8.5.0. More...
 
void SetStationaryEntity (NXOpen::NXObject *stationaryEntity)
 Sets the stationary entity for draft. More...
 
void SetSymmetricAngle (bool symmetricAngle)
 Sets whether draft angles on both sides of the parting reference are symmetric
Created in NX8.5.0. More...
 
void SetTypeOfDraft (NXOpen::Features::DraftBuilder::Type type)
 Sets the Draft type. More...
 
void SetVariableAngleOption ()
 Sets the Variable Angle option
Created in NX4.0.0. More...
 
NXOpen::NXObjectStationaryEntity ()
 Returns the stationary entity for draft. More...
 
NXOpen::ScCollectorStationaryPartingReference ()
 Returns the stationary parting reference as SC Collector containing only faces or only one datum plane or only one point Note that DraftBuilder.StationaryPartingReference and DraftBuilder.PartingReference refer to the same collector. More...
 
NXOpen::ScCollectorStationaryReference ()
 Returns the stationary reference as SC Collector containing only faces or only one datum plane or only one point
Created in NX8.5.0. More...
 
bool SymmetricAngle ()
 Returns whether draft angles on both sides of the parting reference are symmetric
Created in NX8.5.0. More...
 
NXOpen::GeometricUtilities::TwoExpressionsCollectorSetListTwoDimensionFaceSetsData ()
 Returns the list of draft faces SC Collectors and corresponding draft angles above and below the parting reference. More...
 
NXOpen::Features::DraftBuilder::Type TypeOfDraft ()
 Returns the Draft type. More...
 
NXOpen::GeometricUtilities::DraftVariableAngleDataVariableAngleData ()
 Returns the Data object for Variable Angle Draft. 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 Draft Feature Builder that creates or edits a draft (Old name Taper) feature.


This class provides methods to set and get various Draft feature parameters and input entities.


Following are default values and options.

Direction Z direction

Draft method Features::DraftBuilder::MethodIsocline

Draft All instances true

Angle tolerance 0.002/0.1 [rad/deg]

Distance tolerance 0.004/0.1 [in/mm]

To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreateDraftBuilder

Created in NX4.0.0.

Member Enumeration Documentation

Describes the different Draft Methods in Draft References.

Enumerator
DraftReferencesMethodsStationaryFace 

Draft from stationary face.

DraftReferencesMethodsPartingFace 

Draft from stationary parting face.

DraftReferencesMethodsStationaryAndPartingFace 

Draft from stationary face to parting face.

Describes the Draft type as true draft or isocline draft.

Enumerator
MethodIsocline 

Indicates use of isocline algorithm to create draft.

Default value.

MethodTrueDraft 

Indicates use of true draft algorithm to create draft.

Describes the different Draft types.

Enumerator
TypeFace 

Face Draft type.

TypeEdge 

From Edges type.

TypeTangent 

Tangent Draft type.

TypePartingEdge 

Draft with Parting Edges type.

Member Function Documentation

double NXOpen::Features::DraftBuilder::AngleTolerance ( )

Returns the angle tolerance in [rad/deg].


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

NXOpen::Direction* NXOpen::Features::DraftBuilder::Direction ( )

Returns the smart direction for draft.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

double NXOpen::Features::DraftBuilder::DistanceTolerance ( )

Returns the distance tolerance in [in/mm].


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

bool NXOpen::Features::DraftBuilder::DraftAllInstances ( )

Returns the option "Draft all instances" [true/false].


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

bool NXOpen::Features::DraftBuilder::DraftBothSides ( )

Returns whether to draft on both sides of the reference
Created in NX8.5.0.



License requirements : None

NXOpen::Features::DraftBuilder::Method NXOpen::Features::DraftBuilder::DraftIsoclineOrTruedraft ( )

Returns the Draft method.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

NXOpen::Features::DraftBuilder::DraftReferencesMethods NXOpen::Features::DraftBuilder::DraftReferencesMethod ( )

Returns the draft references method
Created in NX8.5.0.



License requirements : None

NXOpen::ExpressionCollectorSetList* NXOpen::Features::DraftBuilder::EdgeSetAngleExpressionList ( )

Returns the list of draft edges SC Collectors and corresponding draft angles.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

NXOpen::ExpressionCollectorSetList* NXOpen::Features::DraftBuilder::FaceSetAngleExpressionList ( )

Returns the list of draft faces SC Collectors and corresponding draft angles.


If the Draft is From Plane or Surface, use Features::DraftBuilder::TwoDimensionFaceSetsData instead.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

NXOpen::ScCollector* NXOpen::Features::DraftBuilder::PartingReference ( )

Returns the parting reference as SC Collector containing only faces or only one datum plane or only one point.

Note that DraftBuilder.StationaryPartingReference and DraftBuilder.PartingReference refer to the same collector.
Created in NX9.0.0.

License requirements : None

void NXOpen::Features::DraftBuilder::SetAngleTolerance ( double  angleTolerance)

Sets the angle tolerance in [rad/deg].


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
angleToleranceangle tolerance
void NXOpen::Features::DraftBuilder::SetDirection ( NXOpen::Direction direction)

Sets the smart direction for draft.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
directiondirection
void NXOpen::Features::DraftBuilder::SetDistanceTolerance ( double  distanceTolerance)

Sets the distance tolerance in [in/mm].


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
distanceTolerancedistance tolerance
void NXOpen::Features::DraftBuilder::SetDraftAllInstances ( bool  draftAllInstances)

Sets the option "Draft all instances" [true/false].


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
draftAllInstancesdraft all instances
void NXOpen::Features::DraftBuilder::SetDraftBothSides ( bool  draftBothSides)

Sets whether to draft on both sides of the reference
Created in NX8.5.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
draftBothSidesdraft both sides
void NXOpen::Features::DraftBuilder::SetDraftIsoclineOrTruedraft ( NXOpen::Features::DraftBuilder::Method  draftMethod)

Sets the Draft method.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
draftMethoddraft method
void NXOpen::Features::DraftBuilder::SetDraftReferencesMethod ( NXOpen::Features::DraftBuilder::DraftReferencesMethods  draftReferencesMethod)

Sets the draft references method
Created in NX8.5.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
draftReferencesMethoddraft references method
void NXOpen::Features::DraftBuilder::SetStationaryEntity ( NXOpen::NXObject stationaryEntity)

Sets the stationary entity for draft.


Deprecated:
Deprecated in NX8.5.0. Use Features::DraftBuilder::StationaryReference instead. Note that this API cannot be used together with the new API.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
stationaryEntitystationary entity
void NXOpen::Features::DraftBuilder::SetSymmetricAngle ( bool  symmetricAngle)

Sets whether draft angles on both sides of the parting reference are symmetric
Created in NX8.5.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
symmetricAnglesymmetric angle
void NXOpen::Features::DraftBuilder::SetTypeOfDraft ( NXOpen::Features::DraftBuilder::Type  type)

Sets the Draft type.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
typetype
void NXOpen::Features::DraftBuilder::SetVariableAngleOption ( )

Sets the Variable Angle option
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

NXOpen::NXObject* NXOpen::Features::DraftBuilder::StationaryEntity ( )

Returns the stationary entity for draft.


Deprecated:
Deprecated in NX8.5.0. Use Features::DraftBuilder::StationaryReference instead. Note that this API cannot be used together with the new API.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

NXOpen::ScCollector* NXOpen::Features::DraftBuilder::StationaryPartingReference ( )

Returns the stationary parting reference as SC Collector containing only faces or only one datum plane or only one point Note that DraftBuilder.StationaryPartingReference and DraftBuilder.PartingReference refer to the same collector.


Created in NX8.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::DraftBuilder::StationaryReference ( )

Returns the stationary reference as SC Collector containing only faces or only one datum plane or only one point
Created in NX8.5.0.



License requirements : None

bool NXOpen::Features::DraftBuilder::SymmetricAngle ( )

Returns whether draft angles on both sides of the parting reference are symmetric
Created in NX8.5.0.



License requirements : None

NXOpen::GeometricUtilities::TwoExpressionsCollectorSetList* NXOpen::Features::DraftBuilder::TwoDimensionFaceSetsData ( )

Returns the list of draft faces SC Collectors and corresponding draft angles above and below the parting reference.


Created in NX8.5.0.

License requirements : None

NXOpen::Features::DraftBuilder::Type NXOpen::Features::DraftBuilder::TypeOfDraft ( )

Returns the Draft type.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

NXOpen::GeometricUtilities::DraftVariableAngleData* NXOpen::Features::DraftBuilder::VariableAngleData ( )

Returns the Data object for Variable Angle Draft.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")


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