Animatable Class Reference

Inheritance diagram for Animatable:

Public Member Functions
def	AddNewKey (self, *args)
def	AssignController (self, *args)
def	CanAssignController (self, *args)
def	CanCopyAnim (self)
def	CanCopyTrack (self, *args)
def	CanDeleteSubAnim (self, *args)
def	CanMakeUnique (self)
def	ClearAFlag (self, *args)
def	ClearAFlagEx (self, *args)
def	ClearAllAppData (self)
def	ClearFlagBit (self, *args)
def	ClearFlagInAllAnimatables (*args)
def	CopyKeysFromTime (self, *args)
def	DeleteAppData (self, *args)
def	DeleteKeyAtTime (self, *args)
def	DeleteKeyByIndex (self, *args)
def	DeleteKeys (self, *args)
def	DeleteSubAnim (self, *args)
def	DeleteTime (self, *args)
def	DoesSupportTimeOperations (self)
def	EditTimeRange (self, *args)
def	FreeCaches (self)
def	GetAnimByHandle (*args)
def	GetAnimHandle (self)
def	GetAppData (self, *args)
def	GetClassID (self)
def	GetClassName (self)
def	GetCustomAttributeContainer (self)
def	GetHasSubElements (self, type=0)
def	GetKeyIndex (self, *args)
def	GetKeyTime (self, *args)
def	GetNextKeyTime (self, *args)
def	GetNodeName (self)
def	GetNumKeys (self)
def	GetNumSubAnims (self)
def	GetParameterBlock (self)
def	GetSubAnim (self, *args)
def	GetSubAnimName (self, *args)
def	GetSuperClassID (self)
def	GetTimeRange (self, *args)
def	InsertTime (self, *args)
def	IsAnimated (self)
def	IsKeyAtTime (self, *args)
def	IsSubClassOf (self, *args)
def	MoveKeys (self, *args)
def	ReverseTime (self, *args)
def	ScaleKeyValues (self, *args)
def	ScaleTime (self, *args)
def	SetAFlag (self, *args)
def	SetAFlagEx (self, *args)
def	SetAppData (self, *args)
def	SetFlagBit (self, *args)
def	SubNumToRefNum (self, *args)
def	TestAFlag (self, *args)
def	TestAFlagEx (self, *args)
def	TestFlagBit (self, *args)
Public Member Functions inherited from InterfaceServer
def	GetInterface (self, *args)
Public Member Functions inherited from Wrapper
def	GetUnwrappedPtr (self)

Static Public Attributes
	AnimHandle = _swig_property(GetAnimHandle)
	ClassID = _swig_property(GetClassID)
	ClearFlagInAllAnimatables = staticmethod(ClearFlagInAllAnimatables)
	GetAnimByHandle = staticmethod(GetAnimByHandle)
	KeyTimes = _swig_property(lambda self: (self.GetKeyTime(i) for i in xrange(self.GetNumKeys())))
	NodeName = _swig_property(GetNodeName)
	NumSubAnims = _swig_property(GetNumSubAnims)
	ParameterBlock = _swig_property(GetParameterBlock)
	SubAnimNames = _swig_property(lambda self: (self.GetSubAnimName(i) for i in xrange(self.GetNumSubAnims())))
	SubAnims = _swig_property(lambda self: (self.GetSubAnim(i) for i in xrange(self.GetNumSubAnims())))
	SuperClassID = _swig_property(GetSuperClassID)
	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from InterfaceServer
	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from Wrapper
	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')

Detailed Description

The base class for most scene entity and plugin types.

Member Function Documentation

AddNewKey()

def AddNewKey	(		self,
		*	args
	)

AddNewKey(Animatable self, TimeValue t, DWORD flags)

AssignController()

def AssignController	(		self,
		*	args
	)

AssignController(Animatable self, Animatable control, int subAnim) -> bool

CanAssignController()

def CanAssignController	(		self,
		*	args
	)

CanAssignController(Animatable self, int i) -> bool

CanCopyAnim()

def CanCopyAnim

(

self

)

CanCopyAnim(Animatable self) -> bool

CanCopyTrack()

def CanCopyTrack	(		self,
		*	args
	)

CanCopyTrack(Animatable self, Interval iv, DWORD flags) -> bool

CanDeleteSubAnim()

def CanDeleteSubAnim	(		self,
		*	args
	)

CanDeleteSubAnim(Animatable self, int i) -> bool

CanMakeUnique()

def CanMakeUnique

(

self

)

CanMakeUnique(Animatable self) -> bool

ClearAFlag()

def ClearAFlag	(		self,
		*	args
	)

ClearAFlag(Animatable self, DWORD mask)

ClearAFlagEx()

def ClearAFlagEx	(		self,
		*	args
	)

ClearAFlagEx(Animatable self, DWORD mask)

ClearAllAppData()

def ClearAllAppData

(

self

)

ClearAllAppData(Animatable self)

ClearFlagBit()

def ClearFlagBit	(		self,
		*	args
	)

ClearFlagBit(Animatable self, int index)

ClearFlagInAllAnimatables()

def ClearFlagInAllAnimatables

(

*

args

)

ClearFlagInAllAnimatables(DWORD mask)

CopyKeysFromTime()

def CopyKeysFromTime	(		self,
		*	args
	)

CopyKeysFromTime(Animatable self, TimeValue src, TimeValue dst, DWORD flags)

DeleteAppData()

def DeleteAppData	(		self,
		*	args
	)

DeleteAppData(Animatable self, DWORD dataId)

DeleteKeyAtTime()

def DeleteKeyAtTime	(		self,
		*	args
	)

DeleteKeyAtTime(Animatable self, TimeValue t)

DeleteKeyByIndex()

def DeleteKeyByIndex	(		self,
		*	args
	)

DeleteKeyByIndex(Animatable self, int index)

DeleteKeys()

def DeleteKeys	(		self,
		*	args
	)

DeleteKeys(Animatable self, DWORD flags)

DeleteSubAnim()

def DeleteSubAnim	(		self,
		*	args
	)

DeleteSubAnim(Animatable self, int i)

DeleteTime()

def DeleteTime	(		self,
		*	args
	)

DeleteTime(Animatable self, Interval iv, DWORD flags)

DoesSupportTimeOperations()

def DoesSupportTimeOperations

(

self

)

DoesSupportTimeOperations(Animatable self) -> bool

EditTimeRange()

def EditTimeRange	(		self,
		*	args
	)

EditTimeRange(Animatable self, Interval range, DWORD flags)

FreeCaches()

def FreeCaches

(

self

)

FreeCaches(Animatable self)

GetAnimByHandle()

def GetAnimByHandle

(

*

args

)

GetAnimByHandle(AnimHandle animHandle) -> Animatable

GetAnimHandle()

def GetAnimHandle

(

self

)

GetAnimHandle(Animatable self) -> AnimHandle

GetAppData()

def GetAppData	(		self,
		*	args
	)

GetAppData(Animatable self, DWORD dataId) -> wchar_t const *

GetClassID()

def GetClassID

(

self

)

GetClassID(Animatable self) -> Class_ID

Reimplemented in PolyObject.

GetClassName()

def GetClassName

(

self

)

GetClassName(Animatable self) -> WStr

GetCustomAttributeContainer()

def GetCustomAttributeContainer

(

self

)

GetCustomAttributeContainer(Animatable self) -> CustomAttributeContainer

GetHasSubElements()

def GetHasSubElements	(		self,
			type = 0
	)

GetHasSubElements(Animatable self, int type=0) -> bool
GetHasSubElements(Animatable self) -> bool

GetKeyIndex()

def GetKeyIndex	(		self,
		*	args
	)

GetKeyIndex(Animatable self, TimeValue t) -> int

GetKeyTime()

def GetKeyTime	(		self,
		*	args
	)

GetKeyTime(Animatable self, int index) -> TimeValue

GetNextKeyTime()

def GetNextKeyTime	(		self,
		*	args
	)

GetNextKeyTime(Animatable self, TimeValue t, DWORD flags, TimeValue & nt) -> bool

GetNodeName()

def GetNodeName

(

self

)

GetNodeName(Animatable self) -> WStr

GetNumKeys()

def GetNumKeys

(

self

)

GetNumKeys(Animatable self) -> int

GetNumSubAnims()

def GetNumSubAnims

(

self

)

GetNumSubAnims(Animatable self) -> int

GetParameterBlock()

def GetParameterBlock

(

self

)

GetParameterBlock(Animatable self) -> ParameterBlock

GetSubAnim()

def GetSubAnim	(		self,
		*	args
	)

GetSubAnim(Animatable self, int i) -> Animatable

GetSubAnimName()

def GetSubAnimName	(		self,
		*	args
	)

GetSubAnimName(Animatable self, int i) -> WStr

GetSuperClassID()

def GetSuperClassID

(

self

)

GetSuperClassID(Animatable self) -> SClass_ID

GetTimeRange()

def GetTimeRange	(		self,
		*	args
	)

GetTimeRange(Animatable self, DWORD flags) -> Interval

InsertTime()

def InsertTime	(		self,
		*	args
	)

InsertTime(Animatable self, TimeValue ins, TimeValue amount)

IsAnimated()

def IsAnimated

(

self

)

IsAnimated(Animatable self) -> bool

IsKeyAtTime()

def IsKeyAtTime	(		self,
		*	args
	)

IsKeyAtTime(Animatable self, TimeValue t, DWORD flags) -> bool

IsSubClassOf()

def IsSubClassOf	(		self,
		*	args
	)

IsSubClassOf(Animatable self, Class_ID classID) -> bool

MoveKeys()

def MoveKeys	(		self,
		*	args
	)

MoveKeys(Animatable self, ParamDimensionBase dim, float delta, DWORD flags)

ReverseTime()

def ReverseTime	(		self,
		*	args
	)

ReverseTime(Animatable self, Interval iv, DWORD flags)

ScaleKeyValues()

def ScaleKeyValues	(		self,
		*	args
	)

ScaleKeyValues(Animatable self, ParamDimensionBase dim, float origin, float scale, DWORD flags)

ScaleTime()

def ScaleTime	(		self,
		*	args
	)

ScaleTime(Animatable self, Interval iv, float s)

SetAFlag()

def SetAFlag	(		self,
		*	args
	)

SetAFlag(Animatable self, DWORD mask)

SetAFlagEx()

def SetAFlagEx	(		self,
		*	args
	)

SetAFlagEx(Animatable self, DWORD mask)

SetAppData()

def SetAppData	(		self,
		*	args
	)

SetAppData(Animatable self, DWORD dataId, wchar_t const * stringData)

SetFlagBit()

def SetFlagBit	(		self,
		*	args
	)

SetFlagBit(Animatable self, int index, bool newValue=True)
SetFlagBit(Animatable self, int index)

SubNumToRefNum()

def SubNumToRefNum	(		self,
		*	args
	)

SubNumToRefNum(Animatable self, int subNum) -> int

TestAFlag()

def TestAFlag	(		self,
		*	args
	)

TestAFlag(Animatable self, DWORD mask) -> bool

TestAFlagEx()

def TestAFlagEx	(		self,
		*	args
	)

TestAFlagEx(Animatable self, DWORD mask) -> bool

TestFlagBit()

def TestFlagBit	(		self,
		*	args
	)

TestFlagBit(Animatable self, int index) -> bool