![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
The ITimeline graph node interface.
The timeline node is evaluated each logic traversal if activated.
A simple timeline is specified by a start/end time.
The timeline can be controlled by Start(), Pause() and Stop() calls.
All setters are taking effect immediately even if the timeline is running.
A more detailed timeline can use a loop start/end time, resulting in 3 phases:
The number of loops specifies the counter for of the loop phase.
Endless looping can be achieved by setting number of loops to < 0.
If number of loops is 0 the loop start/end time is ignored which means the timeline simply runs from start to end time.
If the start time is equal to the loop start time the intro phase is skipped.
If the end time is equal to the loop end time the outro phase is skipped.
Timelines may depend on an optional parent timeline, which is in control of actually starting and stopping the current timeline. See GetParentTimelineNodeTarget().
Optionally, a Resource::IAnimation object may be defined, which can be used to retrieve the time range of an animation clip, which is then used for playback. See GetAnimationResourceTarget(), SetClipIndex() and SetClipName().
A timeline also implements the Graph::IBlendable interface, in order to blend multiple timelines together. Blending can be performed both between multiple timeline units as well as multiple stages from a Graph::MultiTimeline. See GetSubTimelineNodeTarget() for latter case.
It is possible to define a bit mask of up to 32 different global trigger groups, which can be used to selectively enable/disable the timeline's effect on e.g. controllers that implement the Graph::ITimeController interface. See SetTriggerGroupMask() and Graph::ITimeController::SetResponseGroupMask(). By default, all 32 groups are triggered.
See sceneGraphStatesSlotsUnits for an overview of state handling during scene graph traversal.
See Graph::ITimelineState for activating a timeline.
Murl.Graph.IStateUnit
Murl.Graph.IBlendable
Get the constant Graph::INode interface. This method returns a constant pointer to the node's Graph::INode interface, to be able to query common node properties such as active state, visibility or ID.
Murl.Graph.INode GetNodeInterface()
Get the constant container holding an optional parent timeline. This method returns a constant pointer to the node's Graph::ITimelineNodeTarget parent container, which is used to store an optional timeline parent to inherit values from.
Murl.Graph.IGenericNodeTarget.GraphITimeline GetParentTimelineNodeTarget()
Get the constant container holding the optional sub-timelines. This method returns a constant pointer to the node's Graph::ITimelineNodeTarget sub container, which is used to store multiple sub-timeline stages.
Murl.Graph.IGenericNodeTarget.GraphITimeline GetSubTimelineNodeTarget()
Get a constant Graph::IAnimationResourceTarget container. This method returns a constant pointer to a Graph::IAnimationResourceTarget container, which allows to query the optional animation resource that can be used to configure the timeline to play back the time range of a specific animation clip from the resource. See also ITimeline::SetClipIndex().
Murl.Graph.IGenericResourceTarget.ResourceIAnimation GetAnimationResourceTarget()
Reset the timeline. Stop the timeline, reset the WasRunning() state and call Rewind().
Boolean Reset()
Reset the timeline to a specified start time. Set the start time and call Reset().
Boolean ResetTo(Number startTime)
startTime | The start time in seconds. |
Start or continue the timeline. Does not modify the current time and loop.
Boolean Start()
Start the timeline with specified parameters. Set start/end time, calls Rewind() and Start().
Boolean Start(Number startTime, Number endTime)
startTime | The start time in seconds. |
endTime | The end time in seconds. |
Start the timeline with specified parameters. Set start/end time, number of loops, calls Rewind() and Start().
Boolean Start(Number startTime, Number endTime, Integer numberOfLoops)
startTime | The start time in seconds. |
endTime | The end time in seconds. |
numberOfLoops | Number of loops. |
Start the timeline with specified parameters. Set start/end time, loop start/end time, number of loops, calls Rewind() and Start().
Boolean Start(Number startTime, Number endTime, Number loopStartTime, Number loopEndTime, Integer numberOfLoops)
startTime | The start time in seconds. |
endTime | The end time in seconds. |
loopStartTime | The loop start time in seconds. |
loopEndTime | The loop end time in seconds. |
numberOfLoops | Number of loops. |
Pause the timeline.
Boolean Pause()
Stop the timeline. Rewind() is called if auto rewind is enabled.
Boolean Stop()
Rewind the timeline. Sets the current time to the start time and the current loop to the start loop. Does not affect the current running state.
Boolean Rewind()
Stall the timeline. This method acts as a trigger to pause the timeline for a single logic tick. Usually this is called by some node that depends on a steady flow of input data (such as a movie stream) whenever it has to wait for new input data in order to continue decoding. In this case, the timeline may be stalled so that other animations depending on that timeline are kept in sync.
Boolean Stall()
Set the clip index. Setting the clip index works in conjunction with an animation resource set via the resource target obtained from GetAnimationResourceTarget().
Boolean SetClipIndex(Integer clipIndex)
clipIndex | The clip index to set. |
Get the clip index.
Integer GetClipIndex()
Set the current clip by name. Setting the clip works only in conjunction with an animation resource set via the resource target obtained from GetAnimationResourceTarget(), from which the actual clip index is retrieved by its name. This method fails if the given clip name is empty, no animation resource is set, or no clip with that name was found in the animation resource.
Boolean SetClipName(String clipName)
clipName | The clip name. |
Get the current clip's name. This method returns an empty string when no animation resource is defined or the currently active clip is unnamed.
String GetClipName()
Set the start time.
Boolean SetStartTime(Number startTime)
startTime | The start time in seconds. |
Get the start time.
Number GetStartTime()
Set the end time.
Boolean SetEndTime(Number endTime)
endTime | The end time in seconds. |
Get the end time.
Number GetEndTime()
Set the loop start time.
Boolean SetLoopStartTime(Number startTime)
startTime | The loop start time in seconds. |
Get the loop start time.
Number GetLoopStartTime()
Set the loop end time.
Boolean SetLoopEndTime(Number endTime)
endTime | The loop end time in seconds. |
Get the loop end time.
Number GetLoopEndTime()
Set the start loop. Loop #0 is considered the intro, if it is desired to start right in the middle of the first actual loop, the start loop should be set to 1.
Boolean SetStartLoop(Integer startLoop)
startLoop | The start loop. |
Get the start loop.
Integer GetStartLoop()
Set the number of loops.
Boolean SetNumberOfLoops(Integer numberOfLoops)
numberOfLoops | Number of loops. |
Get the number of loops.
Integer GetNumberOfLoops()
Set the time shift value.
Boolean SetTimeShift(Number timeShift)
timeShift | The time shift value. |
Get the time shift value.
Number GetTimeShift()
Set the time offset value.
Boolean SetTimeOffset(Number timeOffset)
timeOffset | The time offset value. |
Get the time offset value.
Number GetTimeOffset()
Set the time scale factor. The recent tick duration is multiplied by the time scale factor and added to the current time each logic tick. The default time scale factor is 1.
Boolean SetTimeScale(Number timeScale)
timeScale | The time scale factor. |
Get the time scale factor.
Number GetTimeScale()
Set the active trigger groups for this timeline. A timeline can be configured to influence a number of user-defined controller groups stored as a UInt32 bit mask, allowing up to 32 individual groups. See Graph::IController::SetResponseGroupMask().
Boolean SetTriggerGroupMask(Integer mask)
mask | The trigger group bit mask. |
Get the active trigger groups for this timeline.
Integer GetTriggerGroupMask()
Enable/disable automatic rewind. Automatic rewind is calling Rewind() when the timeline is stopped.
Boolean SetAutoRewindEnabled(Boolean enabled)
enabled | Enable automatic rewind if true. |
Check if automatic rewind is enabled.
Boolean IsAutoRewindEnabled()
Enable/disable starting on node activation. If the timeline node or a sub-tree containing the node is changed to active the Start() method is called within the next logic traversal.
Boolean SetStartOnActivateEnabled(Boolean enabled)
enabled | Enable starting if true. |
Check if starting on node activation is enabled.
Boolean IsStartOnActivateEnabled()
Enable/disable stopping on node deactivation. If the timeline node or a sub-tree containing the node is changed to inactive the Stop() method is called within the next logic traversal. For potential sideffects see WasRunning().
Boolean SetStopOnDeactivateEnabled(Boolean enabled)
enabled | Enable stopping if true. |
Check if stopping on node deactivation is enabled.
Boolean IsStopOnDeactivateEnabled()
Check if the timeline is running. A timeline can be started by calling Start() and stopped by calling Stop().
Boolean IsRunning()
Check if the timeline is paused. A timeline can be paused by calling Pause() and continued by calling Start().
Boolean IsPaused()
Check if the timeline is stopped. A timeline can be stopped by calling Stop() and started by calling Start().
Boolean IsStopped()
Check if the timeline was started from the beginning.
Boolean WasStarted()
Check if the timeline has stopped running. If the timeline is stopped this state is true within the current logic tick only and will be cleared at the next logic traversal.
(!) This state remains unchanged if the timeline node or a sub-tree containing the node is set to inactive within the current logic tick or if SetStopOnDeactivateEnabled() is enabled. In such a case the Reset() method can be called to clear the state.
Boolean WasRunning()
Check if the timeline is or was running. Returns (IsRunning() || WasRunning()) state.
Boolean IsOrWasRunning()
Check if the current time has passed a specified time within the most recent tick. Does not consider loops, for evaluating loops see HasPassedLoop().
Boolean HasPassedTime(Number time)
time | The time to check in seconds. |
Check if the current loop has passed a specified loop number within the most recent tick. If the loop number to check is negative, true is returned each time the current loop has changed.
Boolean HasPassedLoop(Integer loop)
loop | The loop number to check. |
Get the recent time.
Number GetRecentTime()
Get the current time. This method does not consider loops, for evaluating loops see GetCurrentLoop().
Number GetCurrentTime()
Get the remaining time. This method calculates GetEndTime() - GetCurrentTime() which does not consider loops, for evaluating loops see GetCurrentLoop().
Number GetRemainingTime()
Set the current time. This method does not consider loops, for setting loops see SetCurrentLoop().
SetCurrentTime(Number time)
time | The current time to set in seconds. |
Get the recent loop.
Integer GetRecentLoop()
Get the current loop. The current loop provides the following information for n loops:
Integer GetCurrentLoop()
Get the remaining loops. Calculates GetNumberOfLoops() - GetCurrentLoop().
Integer GetRemainingLoops()
Set the current loop. The current loop represents the following information for n loops:
Boolean SetCurrentLoop(Integer loop)
loop | The current loop to set. |
Get the recent animation state.
Murl.IEnums.AnimationState GetRecentState()
Get the current animation state.
Murl.IEnums.AnimationState GetCurrentState()
Get the timeline's number of stages.
Integer GetNumberOfStages()
Get the timeline's actual node at a given stage.
Murl.Graph.ITimeline GetTimeline(Integer stage)
stage | The stage to query. |