Kanzi Framework  3.9.0
Kanzi Engine API
kanzi::PropertyFieldAnimationTimelinePlayback Class Reference

Playback control class for Property Field Animation timelines. More...

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

Inheritance diagram for kanzi::PropertyFieldAnimationTimelinePlayback:
[legend]

Public Member Functions

 ~PropertyFieldAnimationTimelinePlayback () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::TimelinePlayback
chrono::milliseconds getGlobalTime () const
 Gets current global time of TimelinePlayback. More...
 
chrono::milliseconds getProgressTime () const
 Gets current progress time of TimelinePlayback. More...
 
State getState () const
 Gets current state of playback. More...
 
bool isApplied () const
 Indicates whether TimelinePlayback is applied. More...
 
void onParentAppliedStateChanged ()
 Notifies TimelinePlayback whether the applied state of its parent playback has changed. More...
 
void onParentCompleted ()
 Notifies TimelinePlayback whether its parent playback has completed. More...
 
void setCompleteCallback (CompleteCallback callback)
 Sets complete callback. More...
 
void setGlobalTime (chrono::milliseconds time)
 Sets global time of playback and calculates new global time from it as well as other parameters such as current iteration index, etc. More...
 
void setParent (TimelinePlayback *playback)
 Sets parent playback. More...
 
void stop ()
 Stops playback. More...
 
void tick (chrono::milliseconds deltaTime)
 Advances TimelinePlayback's global time by delta time and calculates new progress time from it as well as other parameters such as current iteration index, etc. More...
 
 TimelinePlayback (Domain *domain, TimelineSharedPtr timeline)
 Constructor. More...
 
 ~TimelinePlayback () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain. More...
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
ScriptingContextSharedPtr getScriptingContext () const
 Gets the scripting context of the object. More...
 
 Object (Domain *domain)
 
void setScriptingContext (ScriptingContextSharedPtr context)
 Sets the scripting context of the object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
 ~Object () override
 
- Public Member Functions inherited from kanzi::MetaObject
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
virtual ~MetaObject ()
 
- Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 Returns the begin iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator beginPropertyStorage () const
 Returns the begin iterator to the internal property storage container. More...
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
PropertyStorageContainer::iterator endPropertyStorage ()
 Returns the end iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator endPropertyStorage () const
 Returns the end iterator to the internal property storage container. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property type. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
 Gets number of current notification handlers for given property type. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications. More...
 
 PropertyObject ()
 
void removeKzbProperties ()
 
template<typename DataType >
void removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property type. More...
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
virtual ~PropertyObject ()
 

Static Public Member Functions

static PropertyFieldAnimationTimelinePlaybackSharedPtr create (PropertyFieldAnimationTimelineSharedPtr propertyFieldAnimationTimeline, ObjectSharedPtr object, bool relativePlayback)
 Creates a PropertyFieldAnimationTimelinePlayback. More...
 
static PropertyFieldAnimationTimelinePlaybackSharedPtr create (PropertyFieldAnimationTimelineSharedPtr propertyFieldAnimationTimeline, TimelinePlaybackContext &context)
 Creates a PropertyFieldAnimationTimelinePlayback. More...
 
static bool isCompatible (AbstractPropertyType &propertyType)
 Indicates whether the specified property type is supported by PropertyFieldAnimationTimeline. More...
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Protected Member Functions

void applyAnimations ()
 Applies the timeline animations at playback's content time. More...
 
void forgetModifier ()
 Forget the property modifier which was installed on the target property. More...
 
template<typename T >
void installModifier ()
 Installs the modifier to the target property. More...
 
void installModifier ()
 Installs the modifier to the target property. More...
 
void modifyAnimatedProperty (ColorRGBA &currentValue, PropertyNotificationReason reason)
 Modifies the value of the target property. More...
 
void modifyAnimatedProperty (Vector2 &currentValue, PropertyNotificationReason reason)
 Modifies the value of the target property. More...
 
void modifyAnimatedProperty (Vector3 &currentValue, PropertyNotificationReason reason)
 Modifies the value of the target property. More...
 
void modifyAnimatedProperty (Vector4 &currentValue, PropertyNotificationReason reason)
 Modifies the value of the target property. More...
 
void modifyAnimatedProperty (SRTValue3D &currentValue, PropertyNotificationReason reason)
 Modifies the value of the target property. More...
 
void modifyAnimatedProperty (SRTValue2D &currentValue, PropertyNotificationReason reason)
 Modifies the value of the target property. More...
 
void onAppliedStateChangedOverride () override
 TimelinePlayback::onAppliedStateChangedOverride() implementation. More...
 
void onProgressTimeResetOverride () override
 TimelinePlayback::onProgressTimeResetOverride() implementation. More...
 
 PropertyFieldAnimationTimelinePlayback (PropertyFieldAnimationTimelineSharedPtr propertyFieldAnimationTimeline, ObjectSharedPtr object, bool relative)
 Constructor. More...
 
void tickOverride (chrono::milliseconds deltaTime) override
 TimelinePlayback::tickOverride() implementation. More...
 
template<typename T >
void uninstallModifier ()
 Uninstalls the modifier from the target property. More...
 
void uninstallModifier ()
 Uninstalls the modifier from the target property. More...
 
- Protected Member Functions inherited from kanzi::TimelinePlayback
void notifyPlaybackCompleted ()
 Calls completion callback if it is available. More...
 
virtual void onPlaybackCompletedOverride ()
 TimelinePlayback calls this function after it has become complete. More...
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
void initialize ()
 
 MetaObject ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value. More...
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 Internally adds a property value source. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 Internally adds a property value source. More...
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the property storage for given property type descriptor. More...
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the top-level value source for a given property descriptor. More...
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)
 
void onCopy (const PropertyObject &other)
 
void removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Removes a local value from the given property storage. More...
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 Removes a property value source. More...
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 

Static Protected Member Functions

template<typename T >
static void modifierCallback (PropertyObject &object, T &currentValue, PropertyNotificationReason reason, void *userData)
 Modifier callback function for target property. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::TimelinePlayback
typedef function< void(TimelinePlayback &)> CompleteCallback
 Callback for complete timeline. More...
 
enum  State { StateNotStarted, StateOngoing, StateCompleted, StateStopped }
 Status of the playback. More...
 
- Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

Playback control class for Property Field Animation timelines.

Use timeline playback to keep track of how a timeline is played.

To perform a play back of a Property Field Animation Timeline, you will have to create a PropertyFieldAnimationTimelinePlayback object by calling the PropertyFieldAnimationTimelinePlayback::create() function:

// Create a property field timeline and apply it to the Render Transformation property of the current node.
// Scale the current node on the x axis by animating the Scale X property field of the Render Transformation property
// with the linearAnimation animation.
propertyFieldTimeline->addEntry(PropertyFieldScaleX, linearAnimation);
// Create property field timeline playback

See Timeline Playback for details and usage.

Constructor & Destructor Documentation

◆ ~PropertyFieldAnimationTimelinePlayback()

kanzi::PropertyFieldAnimationTimelinePlayback::~PropertyFieldAnimationTimelinePlayback ( )
override

Destructor.

◆ PropertyFieldAnimationTimelinePlayback()

kanzi::PropertyFieldAnimationTimelinePlayback::PropertyFieldAnimationTimelinePlayback ( PropertyFieldAnimationTimelineSharedPtr  propertyFieldAnimationTimeline,
ObjectSharedPtr  object,
bool  relative 
)
explicitprotected

Constructor.

Parameters
propertyFieldAnimationTimelineTimeline this playback is going to run.
objectTarget object the property of which to animate.
relativeFlag indicating whether playback should be relative or not.

Member Function Documentation

◆ create() [1/2]

static PropertyFieldAnimationTimelinePlaybackSharedPtr kanzi::PropertyFieldAnimationTimelinePlayback::create ( PropertyFieldAnimationTimelineSharedPtr  propertyFieldAnimationTimeline,
ObjectSharedPtr  object,
bool  relativePlayback 
)
static

Creates a PropertyFieldAnimationTimelinePlayback.

Parameters
propertyFieldAnimationTimelineTimeline this playback is going to run.
objectTarget object the property of which to animate.
relativePlaybackFlag indicating whether playback should be relative or not.
Returns
The created playback.

◆ create() [2/2]

static PropertyFieldAnimationTimelinePlaybackSharedPtr kanzi::PropertyFieldAnimationTimelinePlayback::create ( PropertyFieldAnimationTimelineSharedPtr  propertyFieldAnimationTimeline,
TimelinePlaybackContext context 
)
static

Creates a PropertyFieldAnimationTimelinePlayback.

Parameters
propertyFieldAnimationTimelineTimeline this playback is going to run.
contextPlayback context used to resolve targets.
Returns
The created playback.

◆ isCompatible()

static bool kanzi::PropertyFieldAnimationTimelinePlayback::isCompatible ( AbstractPropertyType propertyType)
static

Indicates whether the specified property type is supported by PropertyFieldAnimationTimeline.

Parameters
propertyTypeThe property type to check.
Returns
True if the property type is supported, false otherwise.

◆ modifierCallback()

template<typename T >
static void kanzi::PropertyFieldAnimationTimelinePlayback::modifierCallback ( PropertyObject object,
T currentValue,
PropertyNotificationReason  reason,
void *  userData 
)
staticprotected

Modifier callback function for target property.

◆ modifyAnimatedProperty() [1/6]

void kanzi::PropertyFieldAnimationTimelinePlayback::modifyAnimatedProperty ( ColorRGBA currentValue,
PropertyNotificationReason  reason 
)
protected

Modifies the value of the target property.

Parameters
currentValueProperty value to modify.
reasonReason for which the value should be modified.

◆ modifyAnimatedProperty() [2/6]

void kanzi::PropertyFieldAnimationTimelinePlayback::modifyAnimatedProperty ( Vector2 currentValue,
PropertyNotificationReason  reason 
)
protected

Modifies the value of the target property.

Parameters
currentValueProperty value to modify.
reasonReason for which the value should be modified.

◆ modifyAnimatedProperty() [3/6]

void kanzi::PropertyFieldAnimationTimelinePlayback::modifyAnimatedProperty ( Vector3 currentValue,
PropertyNotificationReason  reason 
)
protected

Modifies the value of the target property.

Parameters
currentValueProperty value to modify.
reasonReason for which the value should be modified.

◆ modifyAnimatedProperty() [4/6]

void kanzi::PropertyFieldAnimationTimelinePlayback::modifyAnimatedProperty ( Vector4 currentValue,
PropertyNotificationReason  reason 
)
protected

Modifies the value of the target property.

Parameters
currentValueProperty value to modify.
reasonReason for which the value should be modified.

◆ modifyAnimatedProperty() [5/6]

void kanzi::PropertyFieldAnimationTimelinePlayback::modifyAnimatedProperty ( SRTValue3D currentValue,
PropertyNotificationReason  reason 
)
protected

Modifies the value of the target property.

Parameters
currentValueProperty value to modify.
reasonReason for which the value should be modified.

◆ modifyAnimatedProperty() [6/6]

void kanzi::PropertyFieldAnimationTimelinePlayback::modifyAnimatedProperty ( SRTValue2D currentValue,
PropertyNotificationReason  reason 
)
protected

Modifies the value of the target property.

Parameters
currentValueProperty value to modify.
reasonReason for which the value should be modified.

◆ installModifier() [1/2]

template<typename T >
void kanzi::PropertyFieldAnimationTimelinePlayback::installModifier ( )
protected

Installs the modifier to the target property.

◆ installModifier() [2/2]

void kanzi::PropertyFieldAnimationTimelinePlayback::installModifier ( )
protected

Installs the modifier to the target property.

◆ uninstallModifier() [1/2]

template<typename T >
void kanzi::PropertyFieldAnimationTimelinePlayback::uninstallModifier ( )
protected

Uninstalls the modifier from the target property.

◆ uninstallModifier() [2/2]

void kanzi::PropertyFieldAnimationTimelinePlayback::uninstallModifier ( )
protected

Uninstalls the modifier from the target property.

◆ forgetModifier()

void kanzi::PropertyFieldAnimationTimelinePlayback::forgetModifier ( )
protected

Forget the property modifier which was installed on the target property.

For example, when the modifier is removed from the property from elsewhere.

◆ applyAnimations()

void kanzi::PropertyFieldAnimationTimelinePlayback::applyAnimations ( )
protected

Applies the timeline animations at playback's content time.

◆ tickOverride()

void kanzi::PropertyFieldAnimationTimelinePlayback::tickOverride ( chrono::milliseconds  deltaTime)
overrideprotectedvirtual

◆ onProgressTimeResetOverride()

void kanzi::PropertyFieldAnimationTimelinePlayback::onProgressTimeResetOverride ( )
overrideprotectedvirtual

◆ onAppliedStateChangedOverride()

void kanzi::PropertyFieldAnimationTimelinePlayback::onAppliedStateChangedOverride ( )
overrideprotectedvirtual

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