Use TimelinePlaybackContext helper interface class to defines the context of an animation playback. More...
#include <kanzi/core.ui/animation/timeline_playback_context.hpp>
Public Member Functions | |
bool | isRelativePlayback () |
Returns the state of the playback. | |
virtual shared_ptr< Object > | lookupObject (string_view path) |
Looks up for an object from a node's path. | |
void | setRelativePlayback (bool isRelative) |
Sets the state of the playback. | |
TimelinePlaybackContext () | |
Constructor. | |
virtual | ~TimelinePlaybackContext () |
Destructor. | |
Protected Member Functions | |
virtual shared_ptr< Object > | lookupObjectOverride (string_view path)=0 |
Implement this function in inherited class to lookup for an object from a node. | |
Use TimelinePlaybackContext helper interface class to defines the context of an animation playback.
Kanzi resolves paths to animated nodes relative to the node where you attach an Animation Player. Refer to AnimationPlayer for more details.
By using a TimelinePlaybackContext object you can:
|
inlineexplicit |
Constructor.
Sets the playback to be an absolute playback.
|
inlinevirtual |
Destructor.
|
inlinevirtual |
Looks up for an object from a node's path.
Note that the resolved object may be another node or a resource within a node.
path | Relative path to use for the lookup. |
Sets the state of the playback.
By setting a playback as relative it sets AnimationPlayer::RelativePlaybackProperty of the animation player. Refer to AnimationPlayer AnimationPlayer::RelativePlaybackProperty for more details.
isRelative | Set to true if the playback is relative, false otherwise. |
|
inline |
Returns the state of the playback.
|
protectedpure virtual |
Implement this function in inherited class to lookup for an object from a node.
path | Relative path to use for lookup. |
Implemented in kanzi::SceneGraphTimelinePlaybackContext.