AnimationControl Class

class NXOpen.Motion.AnimationControl

Bases: NXOpen.Motion.PostControl

Represents the NXOpen.Motion.AnimationControl

An instance of this class can not be obtained

New in version NX9.0.0.

Properties

Property Description
CurrentStep Returns the current animation step
Delay Returns or sets the animation delay
IsOccurrence Returns whether this object is an occurrence or not.
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
Mode Returns or sets the animation mode
Name Returns the custom name of the object.
NumberSteps Returns the number of animation steps
OwningComponent Returns the owning component, if this object is an occurrence.
OwningPart Returns the owning part of this object
Prototype Returns the prototype of this object if it is an occurrence.
Tag Returns the Tag for this object.

Methods

Method Description
CreateAttributeIterator Create an attribute iterator
DeleteAllAttributesByType Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle Deletes an attribute by type and title.
DeleteUserAttribute Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes Deletes the attributes on the object, if any, that satisfy the given iterator
FindObject Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
Finish Finish animation
GetAttributeTitlesByType Gets all the attribute titles of a specific type.
GetBooleanUserAttribute Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute Gets a time attribute by Title and array Index.
GetIntegerAttribute Gets an integer attribute by title.
GetIntegerUserAttribute Gets an integer attribute by Title and array Index.
GetLinkTransformatioinMatrix Get animation link transformation matrix
GetNextUserAttribute Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue Gets the value of PDM Reference attribute for given object.
GetRealAttribute Gets a real attribute by title.
GetRealUserAttribute Gets a real attribute by Title and array Index.
GetReferenceAttribute Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetStringAttribute Gets a string attribute value by title.
GetStringUserAttribute Gets a string attribute by Title and array Index.
GetTimeAttribute Gets a time attribute by title.
GetTimeUserAttribute Gets a time attribute by Title and array Index.
GetUserAttribute Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock Determine the lock of the given attribute.
GetUserAttributeSize Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects Returns an array of objects from which this object presents attributes.
GetUserAttributes Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings Gets all the attributes that have been set on the given object.
HasUserAttribute Determines if an attribute exists on the object, that satisfies the given iterator
Pause Animation pause
Play Animation play.
PlayBackward Animation play backward.
Print Prints a representation of this object to the system log file.
SetAttribute Creates or modifies an integer attribute.
SetBooleanUserAttribute Creates or modifies a boolean attribute with the option to update or not.
SetName Sets the custom name of the object.
SetPdmReferenceAttribute Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute Creates or modifies a string attribute which uses a reference string.
SetTimeAttribute Creates or modifies a time attribute.
SetTimeUserAttribute Creates or modifies a time attribute with the option to update or not.
SetUserAttribute Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock Lock or unlock the given attribute.
StepBackward Animation step backward
StepFirst Animation step to first step
StepForward Animation step forward
StepLast Animation step to last step
StepTo Animation step to a special step
StepToAssemblyPosition Animation step to assembly position
StepToDesignPosition Animation step to design position
Stop Animation stop

Property Detail

CurrentStep

AnimationControl.CurrentStep

Returns the current animation step

-------------------------------------

Getter Method

Signature CurrentStep

Returns:The current step
Return type:int

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

Delay

AnimationControl.Delay

Returns or sets the animation delay

-------------------------------------

Getter Method

Signature Delay

Returns:The delay
Return type:int

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature Delay

Parameters:delay (int) –

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

IsOccurrence

AnimationControl.IsOccurrence

Returns whether this object is an occurrence or not.

-------------------------------------

Getter Method

Signature IsOccurrence

Returns:This object is an occurrence
Return type:bool

New in version NX3.0.0.

License requirements: None.

JournalIdentifier

AnimationControl.JournalIdentifier

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

-------------------------------------

Getter Method

Signature JournalIdentifier

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

Mode

AnimationControl.Mode

Returns or sets the animation mode

-------------------------------------

Getter Method

Signature Mode

Returns:The animation play mode
Return type:NXOpen.Motion.PlayMode

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

Setter Method

Signature Mode

Parameters:mode (NXOpen.Motion.PlayMode) –

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

Name

AnimationControl.Name

Returns the custom name of the object.

-------------------------------------

Getter Method

Signature Name

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

NumberSteps

AnimationControl.NumberSteps

Returns the number of animation steps

-------------------------------------

Getter Method

Signature NumberSteps

Returns:The total number of steps
Return type:int

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

OwningComponent

AnimationControl.OwningComponent

Returns the owning component, if this object is an occurrence.

-------------------------------------

Getter Method

Signature OwningComponent

Returns:
Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

AnimationControl.OwningPart

Returns the owning part of this object

-------------------------------------

Getter Method

Signature OwningPart

Returns:The owning part of this object or null if it does not have an owner
Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

Prototype

AnimationControl.Prototype

Returns the prototype of this object if it is an occurrence.

-------------------------------------

Getter Method

Signature Prototype

Returns:The prototype of this object or null if this object is not an occurrence
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

Method Detail

FindObject

AnimationControl.FindObject

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Journal identifier of the object
Returns:
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

Finish

AnimationControl.Finish

Finish animation

Signature Finish()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

GetLinkTransformatioinMatrix

AnimationControl.GetLinkTransformatioinMatrix

Get animation link transformation matrix

Signature GetLinkTransformatioinMatrix(linkTag, currentStep)

Parameters:
  • linkTag (NXOpen.Motion.Link) – The special link object
  • currentStep (int) – The current step index
Returns:

The link transformation matrix within current step
Return type:

float

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

Pause

AnimationControl.Pause

Animation pause

Signature Pause()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

Play

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

Signature Play()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

PlayBackward

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

Signature PlayBackward()

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

Print

AnimationControl.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

AnimationControl.SetName

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Signature SetName(name)

Parameters:name (str) –

New in version NX3.0.0.

License requirements: None.

StepBackward

AnimationControl.StepBackward

Animation step backward

Signature StepBackward()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

StepFirst

AnimationControl.StepFirst

Animation step to first step

Signature StepFirst()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

StepForward

AnimationControl.StepForward

Animation step forward

Signature StepForward()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

StepLast

AnimationControl.StepLast

Animation step to last step

Signature StepLast()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

StepTo

AnimationControl.StepTo

Animation step to a special step

Signature StepTo(step)

Parameters:step (int) – Special step

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

StepToAssemblyPosition

AnimationControl.StepToAssemblyPosition

Animation step to assembly position

Signature StepToAssemblyPosition()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

StepToDesignPosition

AnimationControl.StepToDesignPosition

Animation step to design position

Signature StepToDesignPosition()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

Stop

AnimationControl.Stop

Animation stop

Signature Stop()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)