NX Open C++ Reference Guide
|
Represents a Die Keyway Parent sub feature. More...
Public Types | |
enum | RunoffTypeOption { RunoffTypeOptionRectangular, RunoffTypeOptionCircular } |
Settings for the runoff type of the keyway. More... | |
Public Member Functions | |
NXOpen::Die::DieBuildStatusOption | BuildStatus () |
Returns the build status of keyways. | |
NXOpen::Die::KeywayChildBuilder * | CreateChild () |
Creates a child keyway. | |
void | DeleteChild (NXOpen::Die::KeywayChildBuilder *diekeywaychild) |
Deletes a child keyway. | |
double | Depth () |
Returns the depth of keyways. | |
bool | DesignStatus () |
Returns the design status of keyways, if true the keyways will be built into the model, if false they will not. | |
bool | DisplayStatus () |
Returns the display status of keyways, if true input data to the keyways will be displayed, if false the input data will not be displayed. | |
std::vector < NXOpen::Die::KeywayChildBuilder * > | GetChildren () |
Outputs the child keyways. | |
void | GetPadAttributes (NXString *title, NXString *value, int *color) |
Gets the pad attributes, note existance of attributes depends on usage in main feature. | |
void | GetSlotAttributes (NXString *title, NXString *value, int *color) |
Gets the slot attributes, note existance of attributes depends on usage in main feature. | |
double | Length () |
Returns the length of keyways. | |
double | MinimumRibHeight () |
Returns the minimum rib height of keyways. | |
double | PadHeight () |
Returns the pad height of keyways. | |
double | PadWidth () |
Returns the pad width of keyways. | |
double | PlacementOffset () |
Returns the placement offset of keyways. | |
double | RunoffDepth () |
Returns the runoff depth of keyways. | |
double | RunoffDiameter () |
Returns the runoff diameter of keyways. | |
double | RunoffLength () |
Returns the runoff length of keyways. | |
NXOpen::Die::KeywayParentBuilder::RunoffTypeOption | RunoffType () |
Returns the runoff type of keyways. | |
double | RunoffWidth () |
Returns the runoff width of keyways. | |
void | SetDepth (double depth) |
Sets the depth of keyways. | |
void | SetDesignStatus (bool designStatus) |
Sets the design status of keyways, if true the keyways will be built into the model, if false they will not. | |
void | SetDisplayStatus (bool displayStatus) |
Sets the display status of keyways, if true input data to the keyways will be displayed, if false the input data will not be displayed. | |
void | SetLength (double length) |
Sets the length of keyways. | |
void | SetMinimumRibHeight (double minimumRibHeight) |
Sets the minimum rib height of keyways. | |
void | SetPadAttributes (const NXString &title, const NXString &value, int color) |
Sets the pad attributes, note existance of attributes depends on usage in main feature. | |
void | SetPadAttributes (const char *title, const char *value, int color) |
Sets the pad attributes, note existance of attributes depends on usage in main feature. | |
void | SetPadHeight (double padHeight) |
Sets the pad height of keyways. | |
void | SetPadWidth (double padWidth) |
Sets the pad width of keyways. | |
void | SetPlacementOffset (double placementOffset) |
Sets the placement offset of keyways. | |
void | SetRunoffDepth (double runoffDepth) |
Sets the runoff depth of keyways. | |
void | SetRunoffDiameter (double runoffDiameter) |
Sets the runoff diameter of keyways. | |
void | SetRunoffLength (double runoffLength) |
Sets the runoff length of keyways. | |
void | SetRunoffType (NXOpen::Die::KeywayParentBuilder::RunoffTypeOption runoffType) |
Sets the runoff type of keyways. | |
void | SetRunoffWidth (double runoffWidth) |
Sets the runoff width of keyways. | |
void | SetSlotAttributes (const NXString &title, const NXString &value, int color) |
Sets the slot attributes, note existance of attributes depends on usage in main feature. | |
void | SetSlotAttributes (const char *title, const char *value, int color) |
Sets the slot attributes, note existance of attributes depends on usage in main feature. | |
void | SetWidth (double width) |
Sets the width of keyways. | |
double | Width () |
Returns the width of keyways. | |
![]() | |
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 Die Keyway Parent sub feature.
This sub feature is created via the main feature builder.
Created in NX4.0.0.
NXOpen::Die::DieBuildStatusOption NXOpen::Die::KeywayParentBuilder::BuildStatus | ( | ) |
Returns the build status of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
NXOpen::Die::KeywayChildBuilder* NXOpen::Die::KeywayParentBuilder::CreateChild | ( | ) |
Creates a child keyway.
void NXOpen::Die::KeywayParentBuilder::DeleteChild | ( | NXOpen::Die::KeywayChildBuilder * | diekeywaychild | ) |
Deletes a child keyway.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
diekeywaychild | diekeywaychild |
double NXOpen::Die::KeywayParentBuilder::Depth | ( | ) |
Returns the depth of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
bool NXOpen::Die::KeywayParentBuilder::DesignStatus | ( | ) |
Returns the design status of keyways, if true the keyways will be built into the model, if false they will not.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
bool NXOpen::Die::KeywayParentBuilder::DisplayStatus | ( | ) |
Returns the display status of keyways, if true input data to the keyways will be displayed, if false the input data will not be displayed.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
std::vector<NXOpen::Die::KeywayChildBuilder *> NXOpen::Die::KeywayParentBuilder::GetChildren | ( | ) |
Outputs the child keyways.
void NXOpen::Die::KeywayParentBuilder::GetPadAttributes | ( | NXString * | title, |
NXString * | value, | ||
int * | color | ||
) |
Gets the pad attributes, note existance of attributes depends on usage in main feature.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
title | Title for attribute. |
value | Value of attribute. |
color | Color of pad faces. |
void NXOpen::Die::KeywayParentBuilder::GetSlotAttributes | ( | NXString * | title, |
NXString * | value, | ||
int * | color | ||
) |
Gets the slot attributes, note existance of attributes depends on usage in main feature.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
title | Title for attribute. |
value | Value of attribute. |
color | Color of slot faces. |
double NXOpen::Die::KeywayParentBuilder::Length | ( | ) |
Returns the length of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
double NXOpen::Die::KeywayParentBuilder::MinimumRibHeight | ( | ) |
Returns the minimum rib height of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
double NXOpen::Die::KeywayParentBuilder::PadHeight | ( | ) |
Returns the pad height of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
double NXOpen::Die::KeywayParentBuilder::PadWidth | ( | ) |
Returns the pad width of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
double NXOpen::Die::KeywayParentBuilder::PlacementOffset | ( | ) |
Returns the placement offset of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
double NXOpen::Die::KeywayParentBuilder::RunoffDepth | ( | ) |
Returns the runoff depth of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
double NXOpen::Die::KeywayParentBuilder::RunoffDiameter | ( | ) |
Returns the runoff diameter of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
double NXOpen::Die::KeywayParentBuilder::RunoffLength | ( | ) |
Returns the runoff length of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
NXOpen::Die::KeywayParentBuilder::RunoffTypeOption NXOpen::Die::KeywayParentBuilder::RunoffType | ( | ) |
Returns the runoff type of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
double NXOpen::Die::KeywayParentBuilder::RunoffWidth | ( | ) |
Returns the runoff width of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
void NXOpen::Die::KeywayParentBuilder::SetDepth | ( | double | depth | ) |
Sets the depth of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
depth | depth |
void NXOpen::Die::KeywayParentBuilder::SetDesignStatus | ( | bool | designStatus | ) |
Sets the design status of keyways, if true the keyways will be built into the model, if false they will not.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
designStatus | design status |
void NXOpen::Die::KeywayParentBuilder::SetDisplayStatus | ( | bool | displayStatus | ) |
Sets the display status of keyways, if true input data to the keyways will be displayed, if false the input data will not be displayed.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
displayStatus | display status |
void NXOpen::Die::KeywayParentBuilder::SetLength | ( | double | length | ) |
Sets the length of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
length | length |
void NXOpen::Die::KeywayParentBuilder::SetMinimumRibHeight | ( | double | minimumRibHeight | ) |
Sets the minimum rib height of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
minimumRibHeight | minimum rib height |
void NXOpen::Die::KeywayParentBuilder::SetPadAttributes | ( | const NXString & | title, |
const NXString & | value, | ||
int | color | ||
) |
Sets the pad attributes, note existance of attributes depends on usage in main feature.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
title | Title for attribute. NOTE: The full Unicode character set is not supported for this parameter. |
value | Value of attribute. NOTE: The full Unicode character set is not supported for this parameter. |
color | Color of pad faces. |
void NXOpen::Die::KeywayParentBuilder::SetPadAttributes | ( | const char * | title, |
const char * | value, | ||
int | color | ||
) |
Sets the pad attributes, note existance of attributes depends on usage in main feature.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
title | Title for attribute. NOTE: The full Unicode character set is not supported for this parameter. |
value | Value of attribute. NOTE: The full Unicode character set is not supported for this parameter. |
color | Color of pad faces. |
void NXOpen::Die::KeywayParentBuilder::SetPadHeight | ( | double | padHeight | ) |
Sets the pad height of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
padHeight | pad height |
void NXOpen::Die::KeywayParentBuilder::SetPadWidth | ( | double | padWidth | ) |
Sets the pad width of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
padWidth | pad width |
void NXOpen::Die::KeywayParentBuilder::SetPlacementOffset | ( | double | placementOffset | ) |
Sets the placement offset of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
placementOffset | placement offset |
void NXOpen::Die::KeywayParentBuilder::SetRunoffDepth | ( | double | runoffDepth | ) |
Sets the runoff depth of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
runoffDepth | runoff depth |
void NXOpen::Die::KeywayParentBuilder::SetRunoffDiameter | ( | double | runoffDiameter | ) |
Sets the runoff diameter of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
runoffDiameter | runoff diameter |
void NXOpen::Die::KeywayParentBuilder::SetRunoffLength | ( | double | runoffLength | ) |
Sets the runoff length of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
runoffLength | runoff length |
void NXOpen::Die::KeywayParentBuilder::SetRunoffType | ( | NXOpen::Die::KeywayParentBuilder::RunoffTypeOption | runoffType | ) |
Sets the runoff type of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
runoffType | runoff type |
void NXOpen::Die::KeywayParentBuilder::SetRunoffWidth | ( | double | runoffWidth | ) |
Sets the runoff width of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
runoffWidth | runoff width |
void NXOpen::Die::KeywayParentBuilder::SetSlotAttributes | ( | const NXString & | title, |
const NXString & | value, | ||
int | color | ||
) |
Sets the slot attributes, note existance of attributes depends on usage in main feature.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
title | Title for attribute. NOTE: The full Unicode character set is not supported for this parameter. |
value | Value of attribute. NOTE: The full Unicode character set is not supported for this parameter. |
color | Color of slot faces. |
void NXOpen::Die::KeywayParentBuilder::SetSlotAttributes | ( | const char * | title, |
const char * | value, | ||
int | color | ||
) |
Sets the slot attributes, note existance of attributes depends on usage in main feature.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
title | Title for attribute. NOTE: The full Unicode character set is not supported for this parameter. |
value | Value of attribute. NOTE: The full Unicode character set is not supported for this parameter. |
color | Color of slot faces. |
void NXOpen::Die::KeywayParentBuilder::SetWidth | ( | double | width | ) |
Sets the width of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")
width | width |
double NXOpen::Die::KeywayParentBuilder::Width | ( | ) |
Returns the width of keyways.
Created in NX4.0.0.
License requirements : ug_die_design ("Die Design")