![]() |
Murl Engine API
Version 2018.3
|
The IClipTransition graph node interface. More...
#include <murl_graph_i_clip_transition.h>
The IClipTransition graph node interface.
Clip transition nodes must be defined as direct children of a node implementing the Graph::IClipSequencer interface, which is responsible for managing any transitions between those clips. See Graph::IClipSequencer and Graph::IClip.
A clip transition must always reference exactly two Graph::IClip nodes: one representing the "from" state and another one for the "to" state. See GetFromClipNodeTarget() and GetToClipNodeTarget().
When a transition is triggered, the given "from" node is blended out (towards a blend factor of 0.0). and the "to" node is synchronously blended in (towards 1.0), both with their respective duration and offset.
The actual trigger used to start a transition can be any combination of bits from the IEnums::TriggerCondition enumeration, set via SetTriggerConditionEnabled(). The following trigger types are available:
Note, that if a transition to a certain clip is started, and there is another transition for that new clip whose condition is true at the same moment, that transition gets also started at the same time. This means, that it is possible to chain transitions together without any delay. However, the same clip cannot be processed twice in the same tick, otherwise an infinite loop would occur. In such a case, the transition is delayed until the next tick.
Public Member Functions | |
virtual INode * | GetNodeInterface ()=0 |
Get the mutable Graph::INode interface. More... | |
virtual const INode * | GetNodeInterface () const =0 |
Get the constant Graph::INode interface. More... | |
virtual Bool | SetTriggerConditionEnabled (IEnums::TriggerCondition condition, Bool enabled)=0 |
Enable/disable a given trigger condition. More... | |
virtual Bool | IsTriggerConditionEnabled (IEnums::TriggerCondition condition) const =0 |
Check if a given trigger condition is enabled. More... | |
virtual IVariableNodeTarget * | GetTriggerVariableNodeTarget ()=0 |
Get the mutable Graph::IVariableNodeTarget container referencing a trigger variable. More... | |
virtual const IVariableNodeTarget * | GetTriggerVariableNodeTarget () const =0 |
Get the constant Graph::IVariableNodeTarget container referencing a trigger variable. More... | |
virtual IClipNodeTarget * | GetFromClipNodeTarget ()=0 |
Get the mutable Graph::IClipNodeTarget container referencing the "from" clip. More... | |
virtual const IClipNodeTarget * | GetFromClipNodeTarget () const =0 |
Get the constant Graph::IClipNodeTarget container referencing the "from" clip. More... | |
virtual IClipNodeTarget * | GetToClipNodeTarget ()=0 |
Get the mutable Graph::IClipNodeTarget container referencing the "to" clip. More... | |
virtual const IClipNodeTarget * | GetToClipNodeTarget () const =0 |
Get the constant Graph::IClipNodeTarget container referencing the "to" clip. More... | |
virtual Bool | SetOutDuration (Double duration)=0 |
Set the duration of the "from" node's out transition. More... | |
virtual Double | GetOutDuration () const =0 |
Get the duration of the "from" node's out transition. More... | |
virtual Bool | SetOutOffset (Double offset)=0 |
Set the out transition time offset. More... | |
virtual Double | GetOutOffset () const =0 |
Get the out transition time offset. More... | |
virtual Bool | SetInDuration (Double duration)=0 |
Set the duration of the "to" node's in transition. More... | |
virtual Double | GetInDuration () const =0 |
Get the duration of the "to" node's in transition. More... | |
virtual Bool | SetInOffset (Double offset)=0 |
Set the in transition time offset. More... | |
virtual Double | GetInOffset () const =0 |
Get the in transition time offset. More... | |
|
pure virtual |
Get the mutable Graph::INode interface.
This method returns a mutable pointer to the node's Graph::INode interface, to be able to query or modify common node properties such as active state, visibility or ID.
|
pure virtual |
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.
|
pure virtual |
Enable/disable a given trigger condition.
condition | The condition to enable or disable |
enabled | If true, the given condition gets enabled. |
|
pure virtual |
Check if a given trigger condition is enabled.
condition | The condition to check. |
|
pure virtual |
Get the mutable Graph::IVariableNodeTarget container referencing a trigger variable.
This method returns a mutable pointer to the node's Graph::IVariableNodeTarget container, which allows to set or query a reference to an optional trigger variable.
|
pure virtual |
Get the constant Graph::IVariableNodeTarget container referencing a trigger variable.
This method returns a constant pointer to the node's Graph::IVariableNodeTarget container, which allows to query a reference to an optional trigger variable.
|
pure virtual |
Get the mutable Graph::IClipNodeTarget container referencing the "from" clip.
This method returns a mutable pointer to the node's Graph::IClipNodeTarget container, which allows to set or query a reference to the "from" clip node.
|
pure virtual |
Get the constant Graph::IClipNodeTarget container referencing the "from" clip.
This method returns a constant pointer to the node's Graph::IClipNodeTarget container, which allows to query a reference to the "from" clip node.
|
pure virtual |
Get the mutable Graph::IClipNodeTarget container referencing the "to" clip.
This method returns a mutable pointer to the node's Graph::IClipNodeTarget container, which allows to set or query a reference to the "to" clip node.
|
pure virtual |
Get the constant Graph::IClipNodeTarget container referencing the "to" clip.
This method returns a constant pointer to the node's Graph::IClipNodeTarget container, which allows to query a reference to the "to" clip node.
Set the duration of the "from" node's out transition.
duration | The duration in seconds. |
|
pure virtual |
Get the duration of the "from" node's out transition.
Set the out transition time offset.
offset | The offset in seconds, with positive values in the future. |
|
pure virtual |
Get the out transition time offset.
Set the duration of the "to" node's in transition.
duration | The duration in seconds. |
|
pure virtual |
Get the duration of the "to" node's in transition.
Set the in transition time offset.
offset | The offset in seconds, with positive values in the future. |
|
pure virtual |
Get the in transition time offset.