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

Represents a NXOpen::Tooling::UserDefinedMotionBuilder to create user defined motion, which contains linear and rotary motion
To create a new instance of this class, use NXOpen::Tooling::ProgressiveDieManager::CreateUserDefinedMotionBuilder
Default values. More...

Inheritance diagram for NXOpen::Tooling::UserDefinedMotionBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  LinearCurveTypes { LinearCurveTypesLinear, LinearCurveTypesFromFile }
 Specifies the motion curve types when motion type is Linear. More...
 
enum  MotionTypes { MotionTypesLinear, MotionTypesRotary }
 Specifies the motion types. More...
 
enum  RotaryCurveTypes { RotaryCurveTypesRotary, RotaryCurveTypesFromFile }
 Specifies the motion curve types when motion type is Rotary. More...
 

Public Member Functions

void DeleteUserDefinedMotion (const NXString &motionName)
 Delete a user defined motion
Created in NX11.0.0. More...
 
void DeleteUserDefinedMotion (const char *motionName)
 Delete a user defined motion
Created in NX11.0.0. More...
 
NXString ExportMotion ()
 Returns the export motion
Created in NX11.0.0. More...
 
NXString ImportMotion ()
 Returns the import motion
Created in NX11.0.0. More...
 
NXOpen::Tooling::UserDefinedMotionBuilder::LinearCurveTypes LinearCurveType ()
 Returns the linear curve type
Created in NX11.0.0. More...
 
NXOpen::DirectionLinearMotionVector ()
 Returns the linear motion vector
Created in NX11.0.0. More...
 
NXOpen::SelectDisplayableObjectListMotionBody ()
 Returns the motion body
Created in NX11.0.0. More...
 
NXString MotionName ()
 Returns the motion name
Created in NX11.0.0. More...
 
NXOpen::Tooling::UserDefinedMotionBuilder::MotionTypes MotionType ()
 Returns the motion type
Created in NX11.0.0. More...
 
double MoveDistance ()
 Returns the move distance
Created in NX11.0.0. More...
 
double PressStartAngle ()
 Returns the press start angle
Created in NX11.0.0. More...
 
double PressStopAngle ()
 Returns the press stop angle
Created in NX11.0.0. More...
 
double ReturnStartAngle ()
 Returns the return start angle
Created in NX11.0.0. More...
 
double ReturnStopAngle ()
 Returns the return stop angle
Created in NX11.0.0. More...
 
NXOpen::Tooling::UserDefinedMotionBuilder::RotaryCurveTypes RotaryCurveType ()
 Returns the rotary curve type
Created in NX11.0.0. More...
 
NXOpen::AxisRotaryMotionAxis ()
 Returns the rotary motion axis
Created in NX11.0.0. More...
 
double RotationAngle ()
 Returns the rotation angle
Created in NX11.0.0. More...
 
void SetExportMotion (const NXString &filename)
 Sets the export motion
Created in NX11.0.0. More...
 
void SetExportMotion (const char *filename)
 Sets the export motion
Created in NX11.0.0. More...
 
void SetImportMotion (const NXString &filename)
 Sets the import motion
Created in NX11.0.0. More...
 
void SetImportMotion (const char *filename)
 Sets the import motion
Created in NX11.0.0. More...
 
void SetLinearCurveType (NXOpen::Tooling::UserDefinedMotionBuilder::LinearCurveTypes linearCurveType)
 Sets the linear curve type
Created in NX11.0.0. More...
 
void SetLinearMotionVector (NXOpen::Direction *linearMotionVector)
 Sets the linear motion vector
Created in NX11.0.0. More...
 
void SetMotionName (const NXString &motionName)
 Sets the motion name
Created in NX11.0.0. More...
 
void SetMotionName (const char *motionName)
 Sets the motion name
Created in NX11.0.0. More...
 
void SetMotionType (NXOpen::Tooling::UserDefinedMotionBuilder::MotionTypes motionType)
 Sets the motion type
Created in NX11.0.0. More...
 
void SetMoveDistance (double moveDistance)
 Sets the move distance
Created in NX11.0.0. More...
 
void SetPressStartAngle (double pressStartAngle)
 Sets the press start angle
Created in NX11.0.0. More...
 
void SetPressStopAngle (double pressStopAngle)
 Sets the press stop angle
Created in NX11.0.0. More...
 
void SetReturnStartAngle (double returnStartAngle)
 Sets the return start angle
Created in NX11.0.0. More...
 
void SetReturnStopAngle (double returnStopAngle)
 Sets the return stop angle
Created in NX11.0.0. More...
 
void SetRotaryCurveType (NXOpen::Tooling::UserDefinedMotionBuilder::RotaryCurveTypes rotaryCurveType)
 Sets the rotary curve type
Created in NX11.0.0. More...
 
void SetRotaryMotionAxis (NXOpen::Axis *rotaryMotionAxis)
 Sets the rotary motion axis
Created in NX11.0.0. More...
 
void SetRotationAngle (double rotationAngle)
 Sets the rotation angle
Created in NX11.0.0. More...
 
void SetUseControlData (bool useControlData)
 Sets the use control data
Created in NX11.0.0. More...
 
bool UseControlData ()
 Returns the use control data
Created in NX11.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 NXOpen::Tooling::UserDefinedMotionBuilder to create user defined motion, which contains linear and rotary motion
To create a new instance of this class, use NXOpen::Tooling::ProgressiveDieManager::CreateUserDefinedMotionBuilder
Default values.

Property Value

LinearCurveType

Linear

MotionType

Linear

MoveDistance

0

PressStartAngle

0

PressStopAngle

90

ReturnStartAngle

180

ReturnStopAngle

270

RotaryCurveType

Rotary

RotationAngle

0

UseControlData

0


Created in NX11.0.0.

Member Enumeration Documentation

Specifies the motion curve types when motion type is Linear.

Enumerator
LinearCurveTypesLinear 

Linear motion curve type.

LinearCurveTypesFromFile 

Motion curve data read from file type.

Specifies the motion types.

Enumerator
MotionTypesLinear 

Linear motion type.

MotionTypesRotary 

Rotary motion type.

Specifies the motion curve types when motion type is Rotary.

Enumerator
RotaryCurveTypesRotary 

Rotary motion curve type.

RotaryCurveTypesFromFile 

Motion curve data read from file type.

Member Function Documentation

void NXOpen::Tooling::UserDefinedMotionBuilder::DeleteUserDefinedMotion ( const NXString motionName)

Delete a user defined motion
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
motionNamemotionname
void NXOpen::Tooling::UserDefinedMotionBuilder::DeleteUserDefinedMotion ( const char *  motionName)

Delete a user defined motion
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
motionNamemotionname
NXString NXOpen::Tooling::UserDefinedMotionBuilder::ExportMotion ( )

Returns the export motion
Created in NX11.0.0.



License requirements : None

NXString NXOpen::Tooling::UserDefinedMotionBuilder::ImportMotion ( )

Returns the import motion
Created in NX11.0.0.



License requirements : None

NXOpen::Tooling::UserDefinedMotionBuilder::LinearCurveTypes NXOpen::Tooling::UserDefinedMotionBuilder::LinearCurveType ( )

Returns the linear curve type
Created in NX11.0.0.



License requirements : None

NXOpen::Direction* NXOpen::Tooling::UserDefinedMotionBuilder::LinearMotionVector ( )

Returns the linear motion vector
Created in NX11.0.0.



License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::Tooling::UserDefinedMotionBuilder::MotionBody ( )

Returns the motion body
Created in NX11.0.0.



License requirements : None

NXString NXOpen::Tooling::UserDefinedMotionBuilder::MotionName ( )

Returns the motion name
Created in NX11.0.0.



License requirements : None

NXOpen::Tooling::UserDefinedMotionBuilder::MotionTypes NXOpen::Tooling::UserDefinedMotionBuilder::MotionType ( )

Returns the motion type
Created in NX11.0.0.



License requirements : None

double NXOpen::Tooling::UserDefinedMotionBuilder::MoveDistance ( )

Returns the move distance
Created in NX11.0.0.



License requirements : None

double NXOpen::Tooling::UserDefinedMotionBuilder::PressStartAngle ( )

Returns the press start angle
Created in NX11.0.0.



License requirements : None

double NXOpen::Tooling::UserDefinedMotionBuilder::PressStopAngle ( )

Returns the press stop angle
Created in NX11.0.0.



License requirements : None

double NXOpen::Tooling::UserDefinedMotionBuilder::ReturnStartAngle ( )

Returns the return start angle
Created in NX11.0.0.



License requirements : None

double NXOpen::Tooling::UserDefinedMotionBuilder::ReturnStopAngle ( )

Returns the return stop angle
Created in NX11.0.0.



License requirements : None

NXOpen::Tooling::UserDefinedMotionBuilder::RotaryCurveTypes NXOpen::Tooling::UserDefinedMotionBuilder::RotaryCurveType ( )

Returns the rotary curve type
Created in NX11.0.0.



License requirements : None

NXOpen::Axis* NXOpen::Tooling::UserDefinedMotionBuilder::RotaryMotionAxis ( )

Returns the rotary motion axis
Created in NX11.0.0.



License requirements : None

double NXOpen::Tooling::UserDefinedMotionBuilder::RotationAngle ( )

Returns the rotation angle
Created in NX11.0.0.



License requirements : None

void NXOpen::Tooling::UserDefinedMotionBuilder::SetExportMotion ( const NXString filename)

Sets the export motion
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
filenamefilename
void NXOpen::Tooling::UserDefinedMotionBuilder::SetExportMotion ( const char *  filename)

Sets the export motion
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
filenamefilename
void NXOpen::Tooling::UserDefinedMotionBuilder::SetImportMotion ( const NXString filename)

Sets the import motion
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
filenamefilename
void NXOpen::Tooling::UserDefinedMotionBuilder::SetImportMotion ( const char *  filename)

Sets the import motion
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
filenamefilename
void NXOpen::Tooling::UserDefinedMotionBuilder::SetLinearCurveType ( NXOpen::Tooling::UserDefinedMotionBuilder::LinearCurveTypes  linearCurveType)

Sets the linear curve type
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
linearCurveTypelinearcurvetype
void NXOpen::Tooling::UserDefinedMotionBuilder::SetLinearMotionVector ( NXOpen::Direction linearMotionVector)

Sets the linear motion vector
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
linearMotionVectorlinearmotionvector
void NXOpen::Tooling::UserDefinedMotionBuilder::SetMotionName ( const NXString motionName)

Sets the motion name
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
motionNamemotionname
void NXOpen::Tooling::UserDefinedMotionBuilder::SetMotionName ( const char *  motionName)

Sets the motion name
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
motionNamemotionname
void NXOpen::Tooling::UserDefinedMotionBuilder::SetMotionType ( NXOpen::Tooling::UserDefinedMotionBuilder::MotionTypes  motionType)

Sets the motion type
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
motionTypemotiontype
void NXOpen::Tooling::UserDefinedMotionBuilder::SetMoveDistance ( double  moveDistance)

Sets the move distance
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
moveDistancemovedistance
void NXOpen::Tooling::UserDefinedMotionBuilder::SetPressStartAngle ( double  pressStartAngle)

Sets the press start angle
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
pressStartAnglepressstartangle
void NXOpen::Tooling::UserDefinedMotionBuilder::SetPressStopAngle ( double  pressStopAngle)

Sets the press stop angle
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
pressStopAnglepressstopangle
void NXOpen::Tooling::UserDefinedMotionBuilder::SetReturnStartAngle ( double  returnStartAngle)

Sets the return start angle
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
returnStartAnglereturnstartangle
void NXOpen::Tooling::UserDefinedMotionBuilder::SetReturnStopAngle ( double  returnStopAngle)

Sets the return stop angle
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
returnStopAnglereturnstopangle
void NXOpen::Tooling::UserDefinedMotionBuilder::SetRotaryCurveType ( NXOpen::Tooling::UserDefinedMotionBuilder::RotaryCurveTypes  rotaryCurveType)

Sets the rotary curve type
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
rotaryCurveTyperotarycurvetype
void NXOpen::Tooling::UserDefinedMotionBuilder::SetRotaryMotionAxis ( NXOpen::Axis rotaryMotionAxis)

Sets the rotary motion axis
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
rotaryMotionAxisrotarymotionaxis
void NXOpen::Tooling::UserDefinedMotionBuilder::SetRotationAngle ( double  rotationAngle)

Sets the rotation angle
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
rotationAnglerotationangle
void NXOpen::Tooling::UserDefinedMotionBuilder::SetUseControlData ( bool  useControlData)

Sets the use control data
Created in NX11.0.0.



License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
useControlDatausecontroldata
bool NXOpen::Tooling::UserDefinedMotionBuilder::UseControlData ( )

Returns the use control data
Created in NX11.0.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.