Murl Engine Lua Addon API  Version 1.0 beta
Murl.Resource.IAnimation

The IAnimation resource object interface.

Animation resources store a number of animation clips, which in turn can contain any number of key frames of different types, such as colors, positions, audio volumes etc, in an ascending order with respect to their time stamps.


Table members

Methods


GetEulerRotationOrder()

Get the rotation order for evaluating Euler angles.

Murl.IEnums.RotationOrder GetEulerRotationOrder()

Returns
Murl.IEnums.RotationOrder The Euler rotation order.

HasKeys(keyType)

Check if this animation contains keys of a given type.

Boolean HasKeys(Murl.IEnums.AnimationKey keyType)

Parameters
keyTypeThe animation key type to query.
Returns
Boolean true if keys of the requested type are present.

GetPresentKeys()

Get the bit mask of animation key types present in this animation.

Integer GetPresentKeys()

Returns
Integer A bit mask of IEnums::AnimationKey values.

GetNumberOfClips()

Get the number of clips stored in the animation.

Integer GetNumberOfClips()

Returns
Integer The total number of clips.

GetClipIndex(clipName)

Get the index of a clip with a given name.

Integer GetClipIndex(String clipName)

Parameters
clipNameThe name of the clip to query.
Returns
Integer The zero-based index of the clip, or -1 if not found.

GetClipName(clipIndex)

Get the name of a clip at a given index.

String GetClipName(Integer clipIndex)

Parameters
clipIndexThe zero-based index of the clip, in the range from 0 to GetNumberOfClips()-1.
Returns
String The name of the clip, or null if the index was out of range.

GetStartTime(clipIndex)

Get a clip's start time.

Number GetStartTime(Integer clipIndex)

Parameters
clipIndexThe zero-based index of the clip, in the range from 0 to GetNumberOfClips()-1.
Returns
Number The start time in seconds, or 0.0 if the index was out of range.

GetEndTime(clipIndex)

Get a clip's end time.

Number GetEndTime(Integer clipIndex)

Parameters
clipIndexThe zero-based index of the clip, in the range from 0 to GetNumberOfClips()-1.
Returns
Number The end time in seconds, or 0.0 if the index was out of range.

GetDuration(clipIndex)

Get a clip's duration.

Number GetDuration(Integer clipIndex)

Parameters
clipIndexThe zero-based index of the clip, in the range from 0 to GetNumberOfClips()-1.
Returns
Number The duration in seconds, or 0.0 if the index was out of range.

GetNumberOfVisibleKeys(clipIndex)

Get the number of "visible" keys stored in a clip.

Integer GetNumberOfVisibleKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfActiveKeys(clipIndex)

Get the number of "active" keys stored in a clip.

Integer GetNumberOfActiveKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfIndexKeys(clipIndex)

Get the number of index keys stored in a clip.

Integer GetNumberOfIndexKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfDepthOrderKeys(clipIndex)

Get the number of depth order keys stored in a clip.

Integer GetNumberOfDepthOrderKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfAlphaKeys(clipIndex)

Get the number of alpha keys stored in a clip.

Integer GetNumberOfAlphaKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfVolumeKeys(clipIndex)

Get the number of audio volume keys stored in a clip.

Integer GetNumberOfVolumeKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfTimeKeys(clipIndex)

Get the number of time keys stored in a clip.

Integer GetNumberOfTimeKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfAmbientColorKeys(clipIndex)

Get the number of ambient color keys stored in a clip.

Integer GetNumberOfAmbientColorKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfDiffuseColorKeys(clipIndex)

Get the number of diffuse color keys stored in a clip.

Integer GetNumberOfDiffuseColorKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfSpecularColorKeys(clipIndex)

Get the number of specular color keys stored in a clip.

Integer GetNumberOfSpecularColorKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfEmissiveColorKeys(clipIndex)

Get the number of emissive color keys stored in a clip.

Integer GetNumberOfEmissiveColorKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfPositionKeys(clipIndex)

Get the number of position keys stored in a clip.

Integer GetNumberOfPositionKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfPositionXKeys(clipIndex)

Get the number of position X keys stored in a clip.

Integer GetNumberOfPositionXKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfPositionYKeys(clipIndex)

Get the number of position Y keys stored in a clip.

Integer GetNumberOfPositionYKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfPositionZKeys(clipIndex)

Get the number of position Z keys stored in a clip.

Integer GetNumberOfPositionZKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfScalingKeys(clipIndex)

Get the number of scaling keys stored in a clip.

Integer GetNumberOfScalingKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfScalingXKeys(clipIndex)

Get the number of scaling X keys stored in a clip.

Integer GetNumberOfScalingXKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfScalingYKeys(clipIndex)

Get the number of scaling Y keys stored in a clip.

Integer GetNumberOfScalingYKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfScalingZKeys(clipIndex)

Get the number of scaling Z keys stored in a clip.

Integer GetNumberOfScalingZKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfEulerAngleKeys(clipIndex)

Get the number of euler X/Y/Z rotation angle keys stored in a clip.

Integer GetNumberOfEulerAngleKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfEulerAngleXKeys(clipIndex)

Get the number of euler X rotation angle keys stored in a clip.

Integer GetNumberOfEulerAngleXKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfEulerAngleYKeys(clipIndex)

Get the number of euler Y rotation angle keys stored in a clip.

Integer GetNumberOfEulerAngleYKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfEulerAngleZKeys(clipIndex)

Get the number of euler Z rotation angle keys stored in a clip.

Integer GetNumberOfEulerAngleZKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfAxisAngleKeys(clipIndex)

Get the number of axis/angle keys stored in a clip.

Integer GetNumberOfAxisAngleKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfQuaternionKeys(clipIndex)

Get the number of quaternion keys stored in a clip.

Integer GetNumberOfQuaternionKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfShearingXYKeys(clipIndex)

Get the number of shearing XY keys stored in a clip.

Integer GetNumberOfShearingXYKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfShearingXZKeys(clipIndex)

Get the number of shearing XZ keys stored in a clip.

Integer GetNumberOfShearingXZKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfShearingYXKeys(clipIndex)

Get the number of shearing YX keys stored in a clip.

Integer GetNumberOfShearingYXKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfShearingYZKeys(clipIndex)

Get the number of shearing YZ keys stored in a clip.

Integer GetNumberOfShearingYZKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfShearingZXKeys(clipIndex)

Get the number of shearing ZX keys stored in a clip.

Integer GetNumberOfShearingZXKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfShearingZYKeys(clipIndex)

Get the number of shearing ZY keys stored in a clip.

Integer GetNumberOfShearingZYKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfEventTriggerKeys(clipIndex)

Get the number of event trigger keys stored in a clip.

Integer GetNumberOfEventTriggerKeys(Integer clipIndex)

Parameters
clipIndexThe clip index.
Returns
Integer The number of keys.

GetNumberOfBlendFactorKeySets()

Get the number of blend factor key sets stored in the animation.

Integer GetNumberOfBlendFactorKeySets()

Returns
Integer The number of key sets..

GetNumberOfBlendFactorKeys(clipIndex, keySet)

Get the number of blend factor keys for a given key set stored in a clip.

Integer GetNumberOfBlendFactorKeys(Integer clipIndex, Integer keySet)

Parameters
clipIndexThe clip index.
keySetThe key set index.
Returns
Integer The number of keys.

GetNumberOfCubicBezierParameterSets()

Get the number of cubic bezier curve parameter sets in this animation.

Integer GetNumberOfCubicBezierParameterSets()

Returns
Integer The number of parameter sets.