NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::AnimationDesigner::SpeedMotorBuilder Class Reference

Represents a NXOpen::AnimationDesigner::SpeedMotorBuilder . More...

Inheritance diagram for NXOpen::AnimationDesigner::SpeedMotorBuilder:
NXOpen::AnimationDesigner::MotorBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Axis { AxisAngular, AxisLinear, AxisMixed }
 the axis types. More...
 
enum  ColorOptions { ColorOptionsSpecifyColor, ColorOptionsNoColor }
 the color options. More...
 

Public Member Functions

NXOpen::AnimationDesigner::SpeedMotorBuilder::Axis AxisType ()
 Returns the axis type. More...
 
NXOpen::NXColorColor ()
 Returns the color. More...
 
NXOpen::AnimationDesigner::SpeedMotorBuilder::ColorOptions ColorOption ()
 Returns the color option. More...
 
void EditStartTime (double deltaStart)
 Sets the start time value. More...
 
NXOpen::ExpressionMaxAcceleration ()
 Returns the max acceleration. More...
 
void SetAxisType (NXOpen::AnimationDesigner::SpeedMotorBuilder::Axis axisType)
 Sets the axis type. More...
 
void SetColor (NXOpen::NXColor *color)
 Sets the color. More...
 
void SetColorOption (NXOpen::AnimationDesigner::SpeedMotorBuilder::ColorOptions colorOption)
 Sets the color option. More...
 
void SetUseAcceleration (bool useAcceleration)
 Sets the limit acceleration. More...
 
NXOpen::ExpressionSpeed ()
 Returns the speed. More...
 
NXOpen::ExpressionStartTime ()
 Returns the start time. More...
 
bool UseAcceleration ()
 Returns the limit acceleration. More...
 
- Public Member Functions inherited from NXOpen::AnimationDesigner::MotorBuilder
NXOpen::SelectNXObjectAxisJoint ()
 Returns the joint select. More...
 
NXString Name ()
 Returns the name. 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::SpeedMotorBuilder .


To create a new instance of this class, use NXOpen::AnimationDesigner::SpeedMotorCollection::CreateSpeedMotorBuilder

Created in NX12.0.0.

Member Enumeration Documentation

the axis types.

Enumerator
AxisAngular 

Angular.

AxisLinear 

Linear.

AxisMixed 

Mix angular and linear.

the color options.

Enumerator
ColorOptionsSpecifyColor 

Assigns a color to the speed motor.

ColorOptionsNoColor 

Assigns no color to the speed motor.

Member Function Documentation

NXOpen::AnimationDesigner::SpeedMotorBuilder::Axis NXOpen::AnimationDesigner::SpeedMotorBuilder::AxisType ( )

Returns the axis type.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::NXColor* NXOpen::AnimationDesigner::SpeedMotorBuilder::Color ( )

Returns the color.


Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::AnimationDesigner::SpeedMotorBuilder::ColorOptions NXOpen::AnimationDesigner::SpeedMotorBuilder::ColorOption ( )

Returns the color option.


Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

void NXOpen::AnimationDesigner::SpeedMotorBuilder::EditStartTime ( double  deltaStart)

Sets the start time value.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
deltaStartdeltastart
NXOpen::Expression* NXOpen::AnimationDesigner::SpeedMotorBuilder::MaxAcceleration ( )

Returns the max acceleration.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

void NXOpen::AnimationDesigner::SpeedMotorBuilder::SetAxisType ( NXOpen::AnimationDesigner::SpeedMotorBuilder::Axis  axisType)

Sets the axis type.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
axisTypeaxistype
void NXOpen::AnimationDesigner::SpeedMotorBuilder::SetColor ( NXOpen::NXColor color)

Sets the color.


Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
colorcolor
void NXOpen::AnimationDesigner::SpeedMotorBuilder::SetColorOption ( NXOpen::AnimationDesigner::SpeedMotorBuilder::ColorOptions  colorOption)

Sets the color option.


Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
colorOptioncoloroption
void NXOpen::AnimationDesigner::SpeedMotorBuilder::SetUseAcceleration ( bool  useAcceleration)

Sets the limit acceleration.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
useAccelerationuseacceleration
NXOpen::Expression* NXOpen::AnimationDesigner::SpeedMotorBuilder::Speed ( )

Returns the speed.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

NXOpen::Expression* NXOpen::AnimationDesigner::SpeedMotorBuilder::StartTime ( )

Returns the start time.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

bool NXOpen::AnimationDesigner::SpeedMotorBuilder::UseAcceleration ( )

Returns the limit acceleration.


Created in NX12.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")


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