Kanzi 4.1.0
kanzi::ObjectTimelinePlaybackContext Class Reference

Timeline playback context that resolves paths relative to a plain Object rather than a scene graph node. More...

#include <kanzi/core.ui/animation/object_timeline_playback_context.hpp>

Inheritance diagram for kanzi::ObjectTimelinePlaybackContext:
[legend]

Public Member Functions

 ObjectTimelinePlaybackContext (ObjectTimelinePlaybackContext &&) noexcept=default
 
 ObjectTimelinePlaybackContext (shared_ptr< Object > object)
 Constructor.
 
ObjectTimelinePlaybackContextoperator= (ObjectTimelinePlaybackContext &&)=default
 
 ~ObjectTimelinePlaybackContext () override=default
 
- Public Member Functions inherited from kanzi::TimelinePlaybackContext
const optional< RuntimeEnvironment > & getRuntimeEnvironment () const
 Returns the runtime environment of the playback context, if set.
 
bool isRelativePlayback ()
 Returns the state of the playback.
 
virtual shared_ptr< ObjectlookupObject (string_view path)
 Looks up for an object from a node's path.
 
void setRelativePlayback (bool isRelative)
 Sets the state of the playback.
 
void setRuntimeEnvironment (RuntimeEnvironment environment)
 Sets the runtime environment for the playback context.
 
 TimelinePlaybackContext ()
 Constructor.
 
virtual ~TimelinePlaybackContext ()
 Destructor.
 

Protected Member Functions

shared_ptr< ObjectlookupObjectOverride (string_view path) override
 TimelinePlaybackContext::lookupObjectOverride() implementation.
 

Detailed Description

Timeline playback context that resolves paths relative to a plain Object rather than a scene graph node.

Supports only the self-path ".", which resolves to the provided object.

Since
Kanzi 4.1

Constructor & Destructor Documentation

◆ ObjectTimelinePlaybackContext() [1/2]

kanzi::ObjectTimelinePlaybackContext::ObjectTimelinePlaybackContext ( shared_ptr< Object > object)
inlineexplicit

Constructor.

Parameters
objectObject this context refers to.

◆ ObjectTimelinePlaybackContext() [2/2]

kanzi::ObjectTimelinePlaybackContext::ObjectTimelinePlaybackContext ( ObjectTimelinePlaybackContext && )
defaultnoexcept

◆ ~ObjectTimelinePlaybackContext()

kanzi::ObjectTimelinePlaybackContext::~ObjectTimelinePlaybackContext ( )
overridedefault

Member Function Documentation

◆ operator=()

ObjectTimelinePlaybackContext & kanzi::ObjectTimelinePlaybackContext::operator= ( ObjectTimelinePlaybackContext && )
default

◆ lookupObjectOverride()

shared_ptr< Object > kanzi::ObjectTimelinePlaybackContext::lookupObjectOverride ( string_view path)
overrideprotectedvirtual

TimelinePlaybackContext::lookupObjectOverride() implementation.

Returns the context object for path ".", empty otherwise.

Implements kanzi::TimelinePlaybackContext.


The documentation for this class was generated from the following file: