The IStageTimeline interface.
More...
#include "murl_logic_i_stage_timeline.h"
Inherited by Murl::Logic::StageTimeline.
The IStageTimeline interface.
The IStageTimeline encapsulates a reference to a Graph::ITimeline, an intro and an outro (start / end) time pair.
This object is typically used by the IStage object to create an intro and outro animation behaviour for stages.
(!) Do not confuse with Graph::ITimeline intro / loop / outro feature. When using StartIntro() or StartOutro() the Graph::ITimeline is simply started with the corresponding (start / end) time pair by calling Graph::ITimeline::Start(Real startTime, Real endTime).
◆ SetIntroStartTime()
virtual void Murl::Logic::IStageTimeline::SetIntroStartTime |
( |
Real |
startTime | ) |
|
|
pure virtual |
Set the intro start time.
- Parameters
-
startTime | The intro start time in seconds. |
◆ SetIntroEndTime()
virtual void Murl::Logic::IStageTimeline::SetIntroEndTime |
( |
Real |
endTime | ) |
|
|
pure virtual |
Set the intro end time.
- Parameters
-
endTime | The intro end time in seconds. |
◆ SetIntroTime()
virtual void Murl::Logic::IStageTimeline::SetIntroTime |
( |
Real |
startTime, |
|
|
Real |
endTime |
|
) |
| |
|
pure virtual |
Set the intro start and end time.
- Parameters
-
startTime | The intro start time in seconds. |
endTime | The intro end time in seconds. |
◆ GetIntroStartTime()
virtual Real Murl::Logic::IStageTimeline::GetIntroStartTime |
( |
| ) |
const |
|
pure virtual |
Get the intro start time.
- Returns
- The intro start time in seconds.
◆ GetIntroEndTime()
virtual Real Murl::Logic::IStageTimeline::GetIntroEndTime |
( |
| ) |
const |
|
pure virtual |
Get the intro end time.
- Returns
- The intro end time in seconds.
◆ SetOutroStartTime()
virtual void Murl::Logic::IStageTimeline::SetOutroStartTime |
( |
Real |
startTime | ) |
|
|
pure virtual |
Set the outro start time.
- Parameters
-
startTime | The outro start time in seconds. |
◆ SetOutroEndTime()
virtual void Murl::Logic::IStageTimeline::SetOutroEndTime |
( |
Real |
endTime | ) |
|
|
pure virtual |
Set the outro end time.
- Parameters
-
endTime | The outro end time in seconds. |
◆ SetOutroTime()
virtual void Murl::Logic::IStageTimeline::SetOutroTime |
( |
Real |
startTime, |
|
|
Real |
endTime |
|
) |
| |
|
pure virtual |
Set the outro start and end time.
- Parameters
-
startTime | The outro start time in seconds. |
endTime | The outro end time in seconds. |
◆ GetOutroStartTime()
virtual Real Murl::Logic::IStageTimeline::GetOutroStartTime |
( |
| ) |
const |
|
pure virtual |
Get the outro start time.
- Returns
- The outro start time in seconds.
◆ GetOutroEndTime()
virtual Real Murl::Logic::IStageTimeline::GetOutroEndTime |
( |
| ) |
const |
|
pure virtual |
Get the outro end time.
- Returns
- The outro end time in seconds.
◆ GetTimeline()
◆ Init()
Initialize the IStageTimeline object.
- Parameters
-
root | The graph root node. |
timeline | The full path to the graph <Timeline> instance. |
- Returns
- true if successful.
◆ DeInit()
virtual Bool Murl::Logic::IStageTimeline::DeInit |
( |
| ) |
|
|
pure virtual |
◆ StartIntro()
virtual Bool Murl::Logic::IStageTimeline::StartIntro |
( |
| ) |
|
|
pure virtual |
Start the intro.
- Returns
- true if successful.
◆ StartOutro()
virtual Bool Murl::Logic::IStageTimeline::StartOutro |
( |
| ) |
|
|
pure virtual |
Start the outro.
- Returns
- true if successful.
◆ IsRunning()
virtual Bool Murl::Logic::IStageTimeline::IsRunning |
( |
| ) |
const |
|
pure virtual |
Check if the timeline is running.
- Returns
- true if running.
The documentation for this interface was generated from the following file:
- murl_logic_i_stage_timeline.h