![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
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.
Get the rotation order for evaluating Euler angles.
Murl.IEnums.RotationOrder GetEulerRotationOrder()
Check if this animation contains keys of a given type.
Boolean HasKeys(Murl.IEnums.AnimationKey keyType)
keyType | The animation key type to query. |
Check if clip actually contains keys for a given key semantic and key set index.
Boolean HasKeys(Integer clipIndex, Murl.IEnums.AnimationKeySemantic semantic, Integer keySetIndex)
clipIndex | The zero-based index of the clip, in the range from 0 to GetNumberOfClips()-1. |
semantic | The key semantic to query. |
keySetIndex | The key set index, in the range from 0 to GetNumberOfKeySets()-1. |
Get the bit mask of animation key types present in this animation.
Integer GetPresentKeys()
Get the number of clips stored in the animation.
Integer GetNumberOfClips()
Check if this animation has a clip at a given index.
Boolean HasClip(Integer clipIndex)
clipIndex | The zero-based index of the clip to query |
Get the index of a clip with a given name.
Integer GetClipIndex(String clipName)
clipName | The name of the clip to query. |
Get the name of a clip at a given index.
String GetClipName(Integer clipIndex)
clipIndex | The zero-based index of the clip, in the range from 0 to GetNumberOfClips()-1. |
Get a clip's start time.
Number GetStartTime(Integer clipIndex)
clipIndex | The zero-based index of the clip, in the range from 0 to GetNumberOfClips()-1. |
Get a clip's end time.
Number GetEndTime(Integer clipIndex)
clipIndex | The zero-based index of the clip, in the range from 0 to GetNumberOfClips()-1. |
Get a clip's duration.
Number GetDuration(Integer clipIndex)
clipIndex | The zero-based index of the clip, in the range from 0 to GetNumberOfClips()-1. |
Get a clip's number of individual key sets for a given key semantic.
Integer GetNumberOfKeySets(Integer clipIndex, Murl.IEnums.AnimationKeySemantic semantic)
clipIndex | The zero-based index of the clip, in the range from 0 to GetNumberOfClips()-1. |
semantic | The key semantic to query. |
Get a clip's number of keys for a given key semantic and key set index.
Integer GetNumberOfKeys(Integer clipIndex, Murl.IEnums.AnimationKeySemantic semantic, Integer keySetIndex)
clipIndex | The zero-based index of the clip, in the range from 0 to GetNumberOfClips()-1. |
semantic | The key semantic to query. |
keySetIndex | The key set index, in the range from 0 to GetNumberOfKeySets()-1. |
Get a clip's key data type for a given key semantic and key set index.
Murl.IEnums.AnimationKeyType GetKeyType(Integer clipIndex, Murl.IEnums.AnimationKeySemantic semantic, Integer keySetIndex)
clipIndex | The zero-based index of the clip, in the range from 0 to GetNumberOfClips()-1. |
semantic | The key semantic to query. |
keySetIndex | The key set index, in the range from 0 to GetNumberOfKeySets()-1. |
Get the number of "visible" keys stored in a clip.
Integer GetNumberOfVisibleKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of "active" keys stored in a clip.
Integer GetNumberOfActiveKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of index keys stored in a clip.
Integer GetNumberOfIndexKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of depth order keys stored in a clip.
Integer GetNumberOfDepthOrderKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of alpha keys stored in a clip.
Integer GetNumberOfAlphaKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of audio volume keys stored in a clip.
Integer GetNumberOfVolumeKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of time keys stored in a clip.
Integer GetNumberOfTimeKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of ambient color keys stored in a clip.
Integer GetNumberOfAmbientColorKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of diffuse color keys stored in a clip.
Integer GetNumberOfDiffuseColorKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of specular color keys stored in a clip.
Integer GetNumberOfSpecularColorKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of emissive color keys stored in a clip.
Integer GetNumberOfEmissiveColorKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of position keys stored in a clip.
Integer GetNumberOfPositionKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of position X keys stored in a clip.
Integer GetNumberOfPositionXKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of position Y keys stored in a clip.
Integer GetNumberOfPositionYKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of position Z keys stored in a clip.
Integer GetNumberOfPositionZKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of scaling keys stored in a clip.
Integer GetNumberOfScalingKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of scaling X keys stored in a clip.
Integer GetNumberOfScalingXKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of scaling Y keys stored in a clip.
Integer GetNumberOfScalingYKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of scaling Z keys stored in a clip.
Integer GetNumberOfScalingZKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of euler X/Y/Z rotation angle keys stored in a clip.
Integer GetNumberOfEulerAngleKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of euler X rotation angle keys stored in a clip.
Integer GetNumberOfEulerAngleXKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of euler Y rotation angle keys stored in a clip.
Integer GetNumberOfEulerAngleYKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of euler Z rotation angle keys stored in a clip.
Integer GetNumberOfEulerAngleZKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of axis/angle keys stored in a clip.
Integer GetNumberOfAxisAngleKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of quaternion keys stored in a clip.
Integer GetNumberOfQuaternionKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of shearing XY keys stored in a clip.
Integer GetNumberOfShearingXYKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of shearing XZ keys stored in a clip.
Integer GetNumberOfShearingXZKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of shearing YX keys stored in a clip.
Integer GetNumberOfShearingYXKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of shearing YZ keys stored in a clip.
Integer GetNumberOfShearingYZKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of shearing ZX keys stored in a clip.
Integer GetNumberOfShearingZXKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of shearing ZY keys stored in a clip.
Integer GetNumberOfShearingZYKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of event trigger keys stored in a clip.
Integer GetNumberOfEventTriggerKeys(Integer clipIndex)
clipIndex | The clip index. |
Get the number of blend factor key sets stored in the animation.
Integer GetNumberOfBlendFactorKeySets()
Get the number of blend factor keys for a given key set stored in a clip.
Integer GetNumberOfBlendFactorKeys(Integer clipIndex, Integer keySet)
clipIndex | The clip index. |
keySet | The key set index. |
Get the number of cubic bezier curve parameter sets in this animation.
Integer GetNumberOfCubicBezierParameterSets()