Animation Class Reference

This reference page is linked to from the following overview topics:

---

Class Description

Contains static functions for animation and auto-key state management.

Inheritance diagram for Animation:

Public Member Functions
def	AreWeKeying
def	EnableAnimateButton
def	EndPlayback
def	GetAnimRange
def	GetAutoKeyDefaultKeyOn
def	GetAutoKeyDefaultKeyTime
def	GetControllerOverrideRangeDefault
def	GetDefaultInTangentType
def	GetDefaultOutTangentType
def	GetEndTime
def	GetIsAnimating
def	GetPlayActiveOnly
def	GetPlaybackLoop
def	GetPlaybackSpeed
def	GetRealTimePlayback
def	GetSetKeyMode
def	GetSetKeyModeStatus
def	GetSetKeySuspended
def	GetStartTime
def	GetTime
def	IsAnimateEnabled
def	IsPlaying
def	IsSetKeyModeFeatureEnabled
def	ResumeAnimate
def	ResumeSetKeyMode
def	SetAnimateButtonState
def	SetAutoKeyDefaultKeyOn
def	SetAutoKeyDefaultKeyTime
def	SetControllerOverrideRangeDefault
def	SetDefaultTangentType
def	SetEndTime
def	SetIsAnimating
def	SetPlayActiveOnly
def	SetPlaybackLoop
def	SetPlaybackSpeed
def	SetRange
def	SetRealTimePlayback
def	SetSetKeyMode
def	SetStartTime
def	SetTime
def	StartPlayback
def	SuspendAnimate
def	SuspendSetKeyMode

Static Public Attributes
tuple	AreWeKeying = staticmethod(AreWeKeying)
tuple	EnableAnimateButton = staticmethod(EnableAnimateButton)
tuple	EndPlayback = staticmethod(EndPlayback)
tuple	GetAnimRange = staticmethod(GetAnimRange)
tuple	GetAutoKeyDefaultKeyOn = staticmethod(GetAutoKeyDefaultKeyOn)
tuple	GetAutoKeyDefaultKeyTime = staticmethod(GetAutoKeyDefaultKeyTime)
tuple	GetControllerOverrideRangeDefault = staticmethod(GetControllerOverrideRangeDefault)
tuple	GetDefaultInTangentType = staticmethod(GetDefaultInTangentType)
tuple	GetDefaultOutTangentType = staticmethod(GetDefaultOutTangentType)
tuple	GetEndTime = staticmethod(GetEndTime)
tuple	GetIsAnimating = staticmethod(GetIsAnimating)
tuple	GetPlayActiveOnly = staticmethod(GetPlayActiveOnly)
tuple	GetPlaybackLoop = staticmethod(GetPlaybackLoop)
tuple	GetPlaybackSpeed = staticmethod(GetPlaybackSpeed)
tuple	GetRealTimePlayback = staticmethod(GetRealTimePlayback)
tuple	GetSetKeyMode = staticmethod(GetSetKeyMode)
tuple	GetSetKeyModeStatus = staticmethod(GetSetKeyModeStatus)
tuple	GetSetKeySuspended = staticmethod(GetSetKeySuspended)
tuple	GetStartTime = staticmethod(GetStartTime)
tuple	GetTime = staticmethod(GetTime)
tuple	IsAnimateEnabled = staticmethod(IsAnimateEnabled)
tuple	IsPlaying = staticmethod(IsPlaying)
tuple	IsSetKeyModeFeatureEnabled = staticmethod(IsSetKeyModeFeatureEnabled)
tuple	ResumeAnimate = staticmethod(ResumeAnimate)
tuple	ResumeSetKeyMode = staticmethod(ResumeSetKeyMode)
tuple	SetAnimateButtonState = staticmethod(SetAnimateButtonState)
tuple	SetAutoKeyDefaultKeyOn = staticmethod(SetAutoKeyDefaultKeyOn)
tuple	SetAutoKeyDefaultKeyTime = staticmethod(SetAutoKeyDefaultKeyTime)
tuple	SetControllerOverrideRangeDefault = staticmethod(SetControllerOverrideRangeDefault)
tuple	SetDefaultTangentType = staticmethod(SetDefaultTangentType)
tuple	SetEndTime = staticmethod(SetEndTime)
tuple	SetIsAnimating = staticmethod(SetIsAnimating)
tuple	SetPlayActiveOnly = staticmethod(SetPlayActiveOnly)
tuple	SetPlaybackLoop = staticmethod(SetPlaybackLoop)
tuple	SetPlaybackSpeed = staticmethod(SetPlaybackSpeed)
tuple	SetRange = staticmethod(SetRange)
tuple	SetRealTimePlayback = staticmethod(SetRealTimePlayback)
tuple	SetSetKeyMode = staticmethod(SetSetKeyMode)
tuple	SetStartTime = staticmethod(SetStartTime)
tuple	SetTime = staticmethod(SetTime)
tuple	StartPlayback = staticmethod(StartPlayback)
tuple	SuspendAnimate = staticmethod(SuspendAnimate)
tuple	SuspendSetKeyMode = staticmethod(SuspendSetKeyMode)
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')

Member Function Documentation

def AreWeKeying

(

args

)

AreWeKeying(TimeValue t=Autodesk::Max::Now()) -> bool
AreWeKeying() -> bool

def EnableAnimateButton

(

args

)

EnableAnimateButton(bool enable)

def EndPlayback

(

)

EndPlayback()

def GetAnimRange

(

)

GetAnimRange() -> Interval

def GetAutoKeyDefaultKeyOn

(

)

GetAutoKeyDefaultKeyOn() -> bool

def GetAutoKeyDefaultKeyTime

(

)

GetAutoKeyDefaultKeyTime() -> TimeValue

def GetControllerOverrideRangeDefault

(

)

GetControllerOverrideRangeDefault() -> bool

def GetDefaultInTangentType

(

)

GetDefaultInTangentType() -> int

def GetDefaultOutTangentType

(

)

GetDefaultOutTangentType() -> int

def GetEndTime

(

)

GetEndTime() -> TimeValue

def GetIsAnimating

(

)

GetIsAnimating() -> bool

def GetPlayActiveOnly

(

)

GetPlayActiveOnly() -> bool

def GetPlaybackLoop

(

)

GetPlaybackLoop() -> bool

def GetPlaybackSpeed

(

)

GetPlaybackSpeed() -> int

def GetRealTimePlayback

(

)

GetRealTimePlayback() -> bool

def GetSetKeyMode

(

)

GetSetKeyMode() -> bool

def GetSetKeyModeStatus

(

)

GetSetKeyModeStatus() -> bool

def GetSetKeySuspended

(

)

GetSetKeySuspended() -> bool

def GetStartTime

(

)

GetStartTime() -> TimeValue

def GetTime

(

)

GetTime() -> TimeValue

def IsAnimateEnabled

(

)

IsAnimateEnabled() -> bool

def IsPlaying

(

)

IsPlaying() -> bool

def IsSetKeyModeFeatureEnabled

(

)

IsSetKeyModeFeatureEnabled() -> bool

def ResumeAnimate

(

)

ResumeAnimate()

def ResumeSetKeyMode

(

)

ResumeSetKeyMode()

def SetAnimateButtonState

(

args

)

SetAnimateButtonState(bool onOff)

def SetAutoKeyDefaultKeyOn

(

args

)

SetAutoKeyDefaultKeyOn(bool setKey)

def SetAutoKeyDefaultKeyTime

(

args

)

SetAutoKeyDefaultKeyTime(TimeValue t)

def SetControllerOverrideRangeDefault

(

args

)

SetControllerOverrideRangeDefault(bool override)

def SetDefaultTangentType

(

args

)

SetDefaultTangentType(int dfltInTangentType, int dfltOutTangentType, bool writeInCfgFile=True)
SetDefaultTangentType(int dfltInTangentType, int dfltOutTangentType)

def SetEndTime

(

args

)

SetEndTime(TimeValue e)

def SetIsAnimating

(

args

)

SetIsAnimating(bool b)

def SetPlayActiveOnly

(

args

)

SetPlayActiveOnly(bool playActive)

def SetPlaybackLoop

(

args

)

SetPlaybackLoop(bool loop)

def SetPlaybackSpeed

(

args

)

SetPlaybackSpeed(int s)

def SetRange

(

args

)

SetRange(Interval range)

def SetRealTimePlayback

(

args

)

SetRealTimePlayback(bool realTime)

def SetSetKeyMode

(

args

)

SetSetKeyMode(bool onOff)

def SetStartTime

(

args

)

SetStartTime(TimeValue s)

def SetTime

(

args

)

SetTime(TimeValue t, bool redraw=True)
SetTime(TimeValue t)

def StartPlayback

(

args

)

StartPlayback(bool selOnly=False)
StartPlayback()
StartPlayback(int selOnly)

def SuspendAnimate

(

)

SuspendAnimate()

def SuspendSetKeyMode

(

)

SuspendSetKeyMode()