Represents a Die Keyway Child sub feature. More...

Inheritance diagram for NXOpen::Die::KeywayChildBuilder:

Public Types
enum	LocationOption { LocationOptionPositiveX, LocationOptionNegativeX, LocationOptionPositiveY, LocationOptionNegativeY }
	Settings for the location of the keyway. More...

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 the keyway.

double	Depth ()
	Returns the depth of the keyway.

bool	DesignStatus ()
	Returns the design status of the keyway, if true the keyway will be built into the model, if false it will not.

bool	DisplayStatus ()
	Returns the display status of the keyway, if true input data to the keyway will be displayed, if false the input data will not be displayed.

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 the keyway.

NXOpen::Die::KeywayChildBuilder::LocationOption	Location ()
	Returns the location of the keyway.

double	MinimumRibHeight ()
	Returns the minimum rib height of the keyway.

double	Offset ()
	Returns the offset of the keyway.

double	PadHeight ()
	Returns the pad height of the keyway.

double	PadWidth ()
	Returns the pad width of the keyway.

double	PlacementOffset ()
	Returns the placement offset of the keyway.

NXOpen::IOrientation *	Plane ()
	Returns the plane of the keyway.

bool	ReverseOrientation ()
	Returns the value to reverse the orientation of the orientation plane, if true the keyway orientation normal will be reversed, if false it will not.

double	RunoffDepth ()
	Returns the runoff depth of the keyway.

double	RunoffDiameter ()
	Returns the runoff diameter of the keyway.

double	RunoffLength ()
	Returns the runoff length of the keyway.

NXOpen::Die::KeywayChildBuilder::RunoffTypeOption	RunoffType ()
	Returns the runoff type of the keyway.

double	RunoffWidth ()
	Returns the runoff width of the keyway.

void	SetDepth (double depth)
	Sets the depth of the keyway.

void	SetDesignStatus (bool designStatus)
	Sets the design status of the keyway, if true the keyway will be built into the model, if false it will not.

void	SetDisplayStatus (bool displayStatus)
	Sets the display status of the keyway, if true input data to the keyway will be displayed, if false the input data will not be displayed.

void	SetLength (double length)
	Sets the length of the keyway.

void	SetLocation (NXOpen::Die::KeywayChildBuilder::LocationOption location)
	Sets the location of the keyway.

void	SetMinimumRibHeight (double minimumRibHeight)
	Sets the minimum rib height of the keyway.

void	SetOffset (double offset)
	Sets the offset of the keyway.

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 the keyway.

void	SetPadWidth (double padWidth)
	Sets the pad width of the keyway.

void	SetPlacementOffset (double placementOffset)
	Sets the placement offset of the keyway.

void	SetPlane (NXOpen::IOrientation *plane)
	Sets the plane of the keyway.

void	SetReverseOrientation (bool reverseOrientation)
	Sets the value to reverse the orientation of the orientation plane, if true the keyway orientation normal will be reversed, if false it will not.

void	SetRunoffDepth (double runoffDepth)
	Sets the runoff depth of the keyway.

void	SetRunoffDiameter (double runoffDiameter)
	Sets the runoff diameter of the keyway.

void	SetRunoffLength (double runoffLength)
	Sets the runoff length of the keyway.

void	SetRunoffType (NXOpen::Die::KeywayChildBuilder::RunoffTypeOption runoffType)
	Sets the runoff type of the keyway.

void	SetRunoffWidth (double runoffWidth)
	Sets the runoff width of the keyway.

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 the keyway.

double	Width ()
	Returns the width of the keyway.

Public Member Functions inherited from NXOpen::Features::FeatureBuilder
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.

Public Member Functions inherited from NXOpen::Builder
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.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Die Keyway Child sub feature.

This sub feature is created via the main feature builder.

Created in NX4.0.0.

Member Enumeration Documentation

enum NXOpen::Die::KeywayChildBuilder::LocationOption

Settings for the location of the keyway.

Enumerator:

LocationOptionPositiveX	Keyway built in positive x direction.
LocationOptionNegativeX	Keyway built in negative x direction.
LocationOptionPositiveY	Keyway built in positive y direction.
LocationOptionNegativeY	Keyway built in negative y direction.

enum NXOpen::Die::KeywayChildBuilder::RunoffTypeOption

Settings for the runoff type of the keyway.

Enumerator:

RunoffTypeOptionRectangular	Rectangular runoff.
RunoffTypeOptionCircular	Circular runoff.