NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Motion::AnimationControl Class Reference

Represents the NXOpen::Motion::AnimationControl
An instance of this class can not be obtained

Created in NX9.0.0. More...

Inheritance diagram for NXOpen::Motion::AnimationControl:
NXOpen::Motion::PostControl NXOpen::NXObject NXOpen::Motion::IPostControl NXOpen::TaggedObject NXOpen::INXObject

Public Member Functions

int CurrentStep ()
 Returns the current animation step
Created in NX9.0.0. More...
 
int Delay ()
 Returns the animation delay
Created in NX9.0.0. More...
 
void Finish ()
 Finish animation
Created in NX9.0.0. More...
 
double GetLinkTransformatioinMatrix (NXOpen::Motion::Link *linkTag, int currentStep)
 Get animation link transformation matrix. More...
 
NXOpen::Motion::PlayMode Mode ()
 Returns the animation mode
Created in NX9.0.0. More...
 
int NumberSteps ()
 Returns the number of animation steps
Created in NX9.0.0. More...
 
void Pause ()
 Animation pause
Created in NX9.0.0. More...
 
void Play ()
 Animation play. More...
 
void PlayBackward ()
 Animation play backward. More...
 
void SetDelay (int delay)
 Sets the animation delay
Created in NX9.0.0. More...
 
void SetMode (NXOpen::Motion::PlayMode mode)
 Sets the animation mode
Created in NX9.0.0. More...
 
void StepBackward ()
 Animation step backward
Created in NX9.0.0. More...
 
void StepFirst ()
 Animation step to first step
Created in NX9.0.0. More...
 
void StepForward ()
 Animation step forward
Created in NX9.0.0. More...
 
void StepLast ()
 Animation step to last step
Created in NX9.0.0. More...
 
void StepTo (int step)
 Animation step to a special step
Created in NX9.0.0. More...
 
void StepToAssemblyPosition ()
 Animation step to assembly position
Created in NX9.0.0. More...
 
void StepToDesignPosition ()
 Animation step to design position
Created in NX9.0.0. More...
 
void Stop ()
 Animation stop
Created in NX9.0.0. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen::NXObject
enum  AttributeType {
  AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger,
  AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference,
  AttributeTypeAny = 100
}
 Specifies attribute type. More...
 
enum  DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
 Specifies the format of the date and time attribute. More...
 

Detailed Description

Represents the NXOpen::Motion::AnimationControl
An instance of this class can not be obtained

Created in NX9.0.0.


Member Function Documentation

int NXOpen::Motion::AnimationControl::CurrentStep ( )

Returns the current animation step
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

int NXOpen::Motion::AnimationControl::Delay ( )

Returns the animation delay
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::AnimationControl::Finish ( )

Finish animation
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

double NXOpen::Motion::AnimationControl::GetLinkTransformatioinMatrix ( NXOpen::Motion::Link linkTag,
int  currentStep 
)

Get animation link transformation matrix.

Returns
The link transformation matrix within current step
Created in NX9.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
linkTagThe special link object
currentStepThe current step index
NXOpen::Motion::PlayMode NXOpen::Motion::AnimationControl::Mode ( )

Returns the animation mode
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

int NXOpen::Motion::AnimationControl::NumberSteps ( )

Returns the number of animation steps
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::AnimationControl::Pause ( )

Animation pause
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::AnimationControl::Play ( )

Animation play.

This method adds event loop that plays forward step by step and return. It does not wait finishing the play process. For the case there is no UI to control the play and stop action, call Motion::AnimationControl::StepForward in a cycle to play animation
Created in NX9.0.0.

License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::AnimationControl::PlayBackward ( )

Animation play backward.

This method adds event loop that plays backward step by step and return. It does not wait finishing the play process. For the case there is no UI to control the play and stop action, call Motion::AnimationControl::StepBackward in a cycle to play animation backward
Created in NX11.0.0.

License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::AnimationControl::SetDelay ( int  delay)

Sets the animation delay
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
delaydelay
void NXOpen::Motion::AnimationControl::SetMode ( NXOpen::Motion::PlayMode  mode)

Sets the animation mode
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
modemode
void NXOpen::Motion::AnimationControl::StepBackward ( )

Animation step backward
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::AnimationControl::StepFirst ( )

Animation step to first step
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::AnimationControl::StepForward ( )

Animation step forward
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::AnimationControl::StepLast ( )

Animation step to last step
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::AnimationControl::StepTo ( int  step)

Animation step to a special step
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
stepSpecial step
void NXOpen::Motion::AnimationControl::StepToAssemblyPosition ( )

Animation step to assembly position
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::AnimationControl::StepToDesignPosition ( )

Animation step to design position
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::AnimationControl::Stop ( )

Animation stop
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")


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