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

Represents a NXOpen::AnimationDesigner::MeasureBuilder . More...

Inheritance diagram for NXOpen::AnimationDesigner::MeasureBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  MeasureTypes { MeasureTypesDistance, MeasureTypesAngle, MeasureTypesMotorParameter }
 the measure types. More...
 
enum  MotorParameterTypes { MotorParameterTypesDisplacement, MotorParameterTypesVelocity, MotorParameterTypesAcceleration }
 the motor parameter types. More...
 

Public Member Functions

NXOpen::DirectionDirection1 ()
 Returns the first direction used to measure the angle with the second direction. More...
 
NXOpen::DirectionDirection2 ()
 Returns the second direction used to measure the angle with the first direction. More...
 
NXOpen::SelectNXObjectListList1 ()
 Returns the first object list used to be measured with the second object list. More...
 
NXOpen::SelectNXObjectListList2 ()
 Returns the second object list used to be measured with the first object list. More...
 
NXOpen::AnimationDesigner::MeasureBuilder::MeasureTypes MeasureType ()
 Returns the measure type. More...
 
NXOpen::SelectNXObjectMotor ()
 Returns the motor. More...
 
NXOpen::AnimationDesigner::MeasureBuilder::MotorParameterTypes MotorParameterType ()
 Returns the motor parameter type. More...
 
NXString Name ()
 Returns the name. More...
 
void SetDirection1 (NXOpen::Direction *direction1)
 Sets the first direction used to measure the angle with the second direction. More...
 
void SetDirection2 (NXOpen::Direction *direction2)
 Sets the second direction used to measure the angle with the first direction. More...
 
void SetMeasureType (NXOpen::AnimationDesigner::MeasureBuilder::MeasureTypes measureType)
 Sets the measure type. More...
 
void SetMotorParameterType (NXOpen::AnimationDesigner::MeasureBuilder::MotorParameterTypes motorParameterType)
 Sets the motor parameter type. More...
 
void SetName (const NXString &name)
 Sets the name. More...
 
void SetName (const char *name)
 Sets the name. 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::AnimationDesigner::MeasureBuilder .


To create a new instance of this class, use NXOpen::AnimationDesigner::MeasureCollection::CreateMeasureBuilder

Created in NX12.0.0.

Member Enumeration Documentation

the measure types.

Enumerator
MeasureTypesDistance 

distance

MeasureTypesAngle 

angle

MeasureTypesMotorParameter 

motor parameter

the motor parameter types.

Enumerator
MotorParameterTypesDisplacement 

displacement

MotorParameterTypesVelocity 

velocity

MotorParameterTypesAcceleration 

acceleration

Member Function Documentation

NXOpen::Direction* NXOpen::AnimationDesigner::MeasureBuilder::Direction1 ( )

Returns the first direction used to measure the angle with the second direction.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::Direction* NXOpen::AnimationDesigner::MeasureBuilder::Direction2 ( )

Returns the second direction used to measure the angle with the first direction.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::SelectNXObjectList* NXOpen::AnimationDesigner::MeasureBuilder::List1 ( )

Returns the first object list used to be measured with the second object list.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::SelectNXObjectList* NXOpen::AnimationDesigner::MeasureBuilder::List2 ( )

Returns the second object list used to be measured with the first object list.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::AnimationDesigner::MeasureBuilder::MeasureTypes NXOpen::AnimationDesigner::MeasureBuilder::MeasureType ( )

Returns the measure type.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::SelectNXObject* NXOpen::AnimationDesigner::MeasureBuilder::Motor ( )

Returns the motor.

This can be a NXOpen::AnimationDesigner::SpeedMotor or NXOpen::AnimationDesigner::PositionMotor .
Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::AnimationDesigner::MeasureBuilder::MotorParameterTypes NXOpen::AnimationDesigner::MeasureBuilder::MotorParameterType ( )

Returns the motor parameter type.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXString NXOpen::AnimationDesigner::MeasureBuilder::Name ( )

Returns the name.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

void NXOpen::AnimationDesigner::MeasureBuilder::SetDirection1 ( NXOpen::Direction direction1)

Sets the first direction used to measure the angle with the second direction.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
direction1direction1
void NXOpen::AnimationDesigner::MeasureBuilder::SetDirection2 ( NXOpen::Direction direction2)

Sets the second direction used to measure the angle with the first direction.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
direction2direction2
void NXOpen::AnimationDesigner::MeasureBuilder::SetMeasureType ( NXOpen::AnimationDesigner::MeasureBuilder::MeasureTypes  measureType)

Sets the measure type.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
measureTypemeasuretype
void NXOpen::AnimationDesigner::MeasureBuilder::SetMotorParameterType ( NXOpen::AnimationDesigner::MeasureBuilder::MotorParameterTypes  motorParameterType)

Sets the motor parameter type.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
motorParameterTypemotorparametertype
void NXOpen::AnimationDesigner::MeasureBuilder::SetName ( const NXString name)

Sets the name.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
namename
void NXOpen::AnimationDesigner::MeasureBuilder::SetName ( const char *  name)

Sets the name.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
namename

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