kanzi::PropertyDrivenAnimationPlayer Class Reference

Property driven animation player applies animation with time taken from specified property on the node every time property changes. More...

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

Inheritance diagram for kanzi::PropertyDrivenAnimationPlayer:
kanzi::NodeComponent kanzi::Object kanzi::MetaObject kanzi::PropertyObject

Public Member Functions

void setTimeline (TimelineSharedPtr animationTimeline)
 Sets animation timeline to Timeline property of the player. More...
 
TimelineSharedPtr getTimeline () const
 Gets animation timeline from Timeline property of the player. More...
 
void setTimeControllerPropertyType (string propertyTypeName)
 Sets the value of TimeControllerPropertyType property of the player. More...
 
string getTimeControllerPropertyType () const
 Gets the value of TimeControllerPropertyType property of the player. More...
 
void setRelativePlayback (bool relativePlayback)
 Sets value of RelativePlayback property. More...
 
bool isRelativePlayback () const
 Gets value of RelativePlayback property. More...
 
void setEnabled (bool enabled)
 Sets value of Enabled property. More...
 
bool isEnabled () const
 Gets value of Enabled property. More...
 
- Public Member Functions inherited from kanzi::NodeComponent
virtual ~NodeComponent ()
 Destructor. More...
 
void setName (string_view name)
 Sets the name of node component. More...
 
string getName () const
 Gets the name of node component. More...
 
NodeSharedPtr getNode () const
 Returns the node the node component is attached to or null pointer if node component is not attached to a node. More...
 
void attach (NodeWeakPtr node)
 Attaches node component to node. More...
 
void detach ()
 Detaches node component from the node it was attached to. More...
 
State getState () const
 Gets the state of node component indicating if component is attached to a node, detached from any node or in process of attaching/detaching. More...
 
bool isAttaching () const
 Indicates whether node component is in the process of attaching to a node. More...
 
bool isAttached () const
 Indicates whether node component is attached to a node. More...
 
bool isAttachingOrAttached () const
 Indicates whether node component is in the process of attaching to a node or already attached. More...
 
bool isDetaching () const
 Indicates whether node component currently detaching from the node. More...
 
bool isDetached () const
 Indicates whether node component is detached from any node. More...
 
bool isDetachingOrDetached () const
 Indicates whether node component is in the process of detaching from the node or already detached. More...
 
- Public Member Functions inherited from kanzi::Object
 Object (Domain *domain)
 
virtual ~Object ()
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
KzuTaskSchedulergetTaskScheduler () const
 Returns the task scheduler of the object. More...
 
KzuMessageDispatchergetMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
virtual const MetaclassgetDynamicMetaclass () const KZ_OVERRIDE
 Returns the metaclass of the dynamic type of the object. More...
 
AppliedStyleEntryapplyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry)
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
- Public Member Functions inherited from kanzi::MetaObject
virtual ~MetaObject ()
 
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
- Public Member Functions inherited from kanzi::PropertyObject
 PropertyObject ()
 
virtual ~PropertyObject ()
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property. More...
 
void removeKzbProperties ()
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
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 >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
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
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. 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...
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
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...
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *owner)
 
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
 Gets number of current notification handlers for given property type. More...
 

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
static PropertyDrivenAnimationPlayerSharedPtr create (Domain *domain, string_view name)
 Creates animation player. More...
 
- Static Public Member Functions inherited from kanzi::NodeComponent
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- 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...
 

Static Public Attributes

static PropertyType< ResourceSharedPtrTimelineProperty
 Timeline property specifies the animation timeline which is applied by property driven animation player at the time specified in the time controller property every time value of time controller property changes. More...
 
static PropertyType< string > TimeControllerPropertyTypeProperty
 TimeControllerPropertyType property specifies type name of the time controller property. More...
 
static PropertyType< bool > RelativePlaybackProperty
 RelativePlayback property specifies whether animations are played in relative manner by adding animated value to target property value instead of replacing the property value. More...
 
static PropertyType< bool > EnabledProperty
 Enabled property specifies whether animation timeline is applied. More...
 
- Static Public Attributes inherited from kanzi::NodeComponent
static PropertyType< string > NameProperty
 Name property specifies the name of node component. More...
 

Protected Member Functions

 PropertyDrivenAnimationPlayer (Domain *domain, string_view name)
 Constructor. More...
 
virtual void attachOverride () KZ_OVERRIDE
 NodeComponent::attachOverride() implementation. More...
 
virtual void detachOverride () KZ_OVERRIDE
 NodeComponent::detachOverride() implementation. More...
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) KZ_OVERRIDE
 Object::onPropertyChanged() implementation. More...
 
void startTimelinePlayback ()
 Starts playback of an animation timeline assigned to the player via Timeline property. More...
 
void stopTimelinePlayback ()
 Stops ongoing playback of an animation timeline. More...
 
template<typename T >
void updateTimelinePlaybackTime ()
 Updates timeline playback by time calculated from time controller property. More...
 
chrono::milliseconds convertToMilliseconds (int milliseconds)
 Converts integer number of milliseconds to chrono duration in milliseconds. More...
 
chrono::milliseconds convertToMilliseconds (float seconds)
 Converts floating point number of seconds to chrono duration in milliseconds. More...
 
- Protected Member Functions inherited from kanzi::NodeComponent
 NodeComponent (Domain *domain, string_view name)
 Constructor. More...
 
template<typename TMessageType , typename TClass , typename TMethod >
Node::MessageSubscriptionToken addNodeComponentMessageHandler (TMessageType &messageType, TClass *nodeComponent, TMethod method)
 Adds message handler for node component messages to the component's node. More...
 
void removeNodeComponentMessageFilter (Node::MessageSubscriptionToken subscriptionToken)
 Removes message handler added via addNodeComponentMessageHandler function. More...
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
 MetaObject ()
 
void initialize ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntryfindLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 Copy local value from property storage. More...
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 
PropertyStorageContainer::iterator endPropertyStorage ()
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)
 
void onCopy (const PropertyObject &other)
 

Static Protected Member Functions

template<typename T >
static void timeControllerPropertyNoticationHandler (PropertyObject &, const T &, PropertyNotificationReason, void *userData)
 Notification handler for time property. More...
 
- Static Protected Member Functions inherited from kanzi::NodeComponent
template<typename TMessageType , typename TClass , typename TMethod >
static void nodeComponentMessageHandler (TClass *nodeComponent, TMethod method, typename TMessageType::ArgumentsType &messageArguments)
 Handler function for node component messages. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::NodeComponent
enum  State { StateDetached, StateDetaching, StateAttaching, StateAttached }
 State indicating if component is attached to a node, detached from any node or in process of attaching/detaching. More...
 
- Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntry * > AppliedStyleContainer
 Applied style container. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

Property driven animation player applies animation with time taken from specified property on the node every time property changes.

Property driven animation player applies timeline specified in the Timeline property of the player. Paths to animated objects are resolved relative to the node where the player is attached to. All animations in applied timeline are relative: values calculated in animations are added to property values instead of replacing it.

Time for timeline is taken from a property of the node; type name of this property should be set in the TimeControllerPropertyType property of the player. Any property of integer or float type can be used for this purpose. Properties with data types other than integer and float are not supported. Time calculated from value of the property depends on its data type:

  • If property is of float type, then property value 1.0 is interpreted as 1 second (so if value of time property is for example 5.5f, then the time for timeline will be 5.5 seconds, etc.).
  • If property is of integer type, then property value 1 is interpreted as 1 millisecond (so if value of time property is for example 2300, then the time for timeline will be 2.3 seconds, etc.).

Recommended data type for a property used as time controller is integer. Using integer property allows to precisely control the time at which animations in timeline are applied. If floating point property is used as a time controller, property driven animation player rounds it to integer number of milliseconds. In this case result time at which animations in timeline are applied is not precise, but various effects can be applied to floating point time property, for example smooth interpolation by property target interpolator.

Property driven animation player starts to apply animations from the timeline immediately after it is attached to the node. If time controller property could not be resolved or if it has unsupported data type, player will not apply timeline. If time controller property is resolved but is not set to the node, the player will use default property value for calculating time.

Please note that Timeline and TimeController properties of the player are applied only once when it is attached to the node. New values which are set to these properties after player is attach will be ignored.

Examples

To create property driven animation player and specify its timeline and time controller property:

// Create property driven animation player.
// Set timeline.
player->setTimeline(timeline);
// Set type name of time controller property.
player->setTimeControllerPropertyType(timePropertyType.getName());

To attach property driven animation player to the node:

node->addNodeComponent(player);

Constructor & Destructor Documentation

kanzi::PropertyDrivenAnimationPlayer::PropertyDrivenAnimationPlayer ( Domain domain,
string_view  name 
)
explicitprotected

Constructor.

Parameters
domainDomain.
nameName of animation player.

Member Function Documentation

static PropertyTypeEditorInfoSharedPtr kanzi::PropertyDrivenAnimationPlayer::makeEditorInfo ( )
static
static PropertyDrivenAnimationPlayerSharedPtr kanzi::PropertyDrivenAnimationPlayer::create ( Domain domain,
string_view  name 
)
static

Creates animation player.

Parameters
domainDomain.
nameName of animation player.
Returns
animation player.
void kanzi::PropertyDrivenAnimationPlayer::setTimeline ( TimelineSharedPtr  animationTimeline)

Sets animation timeline to Timeline property of the player.

Parameters
animationTimelinetimeline.
TimelineSharedPtr kanzi::PropertyDrivenAnimationPlayer::getTimeline ( ) const

Gets animation timeline from Timeline property of the player.

Returns
timelime.
void kanzi::PropertyDrivenAnimationPlayer::setTimeControllerPropertyType ( string  propertyTypeName)

Sets the value of TimeControllerPropertyType property of the player.

Parameters
valueName of property type.
string kanzi::PropertyDrivenAnimationPlayer::getTimeControllerPropertyType ( ) const

Gets the value of TimeControllerPropertyType property of the player.

Returns
Name of property type.
void kanzi::PropertyDrivenAnimationPlayer::setRelativePlayback ( bool  relativePlayback)

Sets value of RelativePlayback property.

Parameters
relativePlaybackSpecifies whether playback is relative.
bool kanzi::PropertyDrivenAnimationPlayer::isRelativePlayback ( ) const

Gets value of RelativePlayback property.

Returns
True if playback is relative, false otherwise.
void kanzi::PropertyDrivenAnimationPlayer::setEnabled ( bool  enabled)

Sets value of Enabled property.

Parameters
enabledSpecifies whether animation timeline is applied.
bool kanzi::PropertyDrivenAnimationPlayer::isEnabled ( ) const

Gets value of Enabled property.

Returns
True if animation timeline is applied, false otherwise.
virtual void kanzi::PropertyDrivenAnimationPlayer::attachOverride ( )
protectedvirtual

NodeComponent::attachOverride() implementation.

Reimplemented from kanzi::NodeComponent.

virtual void kanzi::PropertyDrivenAnimationPlayer::detachOverride ( )
protectedvirtual

NodeComponent::detachOverride() implementation.

Reimplemented from kanzi::NodeComponent.

virtual void kanzi::PropertyDrivenAnimationPlayer::onPropertyChanged ( AbstractPropertyType  propertyType,
PropertyNotificationReason  reason 
)
protectedvirtual

Object::onPropertyChanged() implementation.

Reimplemented from kanzi::PropertyObject.

template<typename T >
static void kanzi::PropertyDrivenAnimationPlayer::timeControllerPropertyNoticationHandler ( PropertyObject ,
const T &  ,
PropertyNotificationReason  ,
void *  userData 
)
staticprotected

Notification handler for time property.

void kanzi::PropertyDrivenAnimationPlayer::startTimelinePlayback ( )
protected

Starts playback of an animation timeline assigned to the player via Timeline property.

Does no thing if playback is already ongoing.

void kanzi::PropertyDrivenAnimationPlayer::stopTimelinePlayback ( )
protected

Stops ongoing playback of an animation timeline.

Does no thing if there is no ongoing playback.

template<typename T >
void kanzi::PropertyDrivenAnimationPlayer::updateTimelinePlaybackTime ( )
protected

Updates timeline playback by time calculated from time controller property.

chrono::milliseconds kanzi::PropertyDrivenAnimationPlayer::convertToMilliseconds ( int  milliseconds)
protected

Converts integer number of milliseconds to chrono duration in milliseconds.

Parameters
millisecondsNumber of milliseconds to convert to duration.
Returns
result duration.
chrono::milliseconds kanzi::PropertyDrivenAnimationPlayer::convertToMilliseconds ( float  seconds)
protected

Converts floating point number of seconds to chrono duration in milliseconds.

Parameters
secondsNumber of seconds to convert to duration.
Returns
result duration.

Member Data Documentation

PropertyType<ResourceSharedPtr> kanzi::PropertyDrivenAnimationPlayer::TimelineProperty
static

Timeline property specifies the animation timeline which is applied by property driven animation player at the time specified in the time controller property every time value of time controller property changes.

PropertyType<string> kanzi::PropertyDrivenAnimationPlayer::TimeControllerPropertyTypeProperty
static

TimeControllerPropertyType property specifies type name of the time controller property.

Time controller property can be any property of float or integer type on the node where property driven animation player is attached. When attached, property driven animation player finds time controller property on the node by the type name. After that it uses values of time controller property to calculate time at which animation timeline specified in Timeline property is applied.

PropertyType<bool> kanzi::PropertyDrivenAnimationPlayer::RelativePlaybackProperty
static

RelativePlayback property specifies whether animations are played in relative manner by adding animated value to target property value instead of replacing the property value.

By default relative playback is disabled.

PropertyType<bool> kanzi::PropertyDrivenAnimationPlayer::EnabledProperty
static

Enabled property specifies whether animation timeline is applied.

By default Enabled property is set to true, that is, property driven animation player applies animation timeline. Modifying Enabled property of attached property driven player will make immediate effect in the player; no reattahcing is needed in order for this property to have effect.


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