kanzi::PropertyAnimationTimelinePlayback Class Reference

Playback class for PropertyAnimationTimeline. More...

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

Inheritance diagram for kanzi::PropertyAnimationTimelinePlayback:
kanzi::TimelinePlayback kanzi::Object kanzi::MetaObject kanzi::PropertyObject

Public Member Functions

 ~PropertyAnimationTimelinePlayback ()
 Destructor. More...
 
- Public Member Functions inherited from kanzi::TimelinePlayback
 TimelinePlayback (Domain *domain, TimelineSharedPtr timeline)
 Constructor. More...
 
virtual ~TimelinePlayback ()
 Destructor. More...
 
void setParent (TimelinePlayback *playback)
 Sets parent playback. More...
 
void setCompleteCallback (CompleteCallback callback)
 Sets complete callback. More...
 
State getState () const
 Gets current state of 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...
 
chrono::milliseconds getGlobalTime () const
 Gets current global time of TimelinePlayback. 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...
 
chrono::milliseconds getProgressTime () const
 Gets current progress time of TimelinePlayback. 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 stop ()
 Stops playback. 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...
 
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr 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...
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications. 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 PropertyAnimationTimelinePlaybackSharedPtr create (PropertyAnimationTimelineSharedPtr propertyAnimationTimeline, ObjectSharedPtr object, bool relativePlayback)
 Creates new PropertyAnimationTimelinePlayback instance from specified timeline and returns it. More...
 
static PropertyAnimationTimelinePlaybackSharedPtr create (PropertyAnimationTimelineSharedPtr propertyAnimationTimeline, TimelinePlaybackContext &context)
 Creates new PropertyAnimationTimelinePlayback instance from specified timeline and returns it. More...
 
static bool isCompatible (AbstractPropertyType &propertyType, AbstractAnimation &animation)
 Indicates whether specified animation can be applied to a property of specified property type. 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

template<typename TPropertyDataType >
void modifyAnimatedProperty (TPropertyDataType &currentValue, PropertyNotificationReason reason)
 Modifies value of target property. More...
 
template<typename TPropertyDataType , typename TAnimationDataType >
void modifyAnimatedProperty (TPropertyDataType &currentValue, PropertyNotificationReason reason)
 Modifies value of target property. More...
 
void installModifier ()
 Installs modifier to target property. More...
 
template<typename TPropertyDataType >
void installModifier ()
 Installs modifier to target property. More...
 
template<typename TPropertyDataType , typename TAnimationDataType >
void installModifier ()
 Installs modifier to target property. More...
 
void uninstallModifier ()
 Uninstalls modifier from target property. More...
 
template<typename TPropertyDataType >
void uninstallModifier ()
 Uninstalls modifier from target property. More...
 
template<typename TPropertyDataType , typename TAnimationDataType >
void uninstallModifier ()
 Uninstalls modifier from target property. More...
 
void forgetModifier ()
 Forget property modifier installed on target property (for example, when modifier is removed from the property elsewhere). More...
 
 PropertyAnimationTimelinePlayback (PropertyAnimationTimelineSharedPtr propertyAnimationTimeline, ObjectSharedPtr object, bool relative)
 Constructor. More...
 
void applyAnimation ()
 Applies timeline animation at playback's content time. More...
 
virtual void tickOverride (chrono::milliseconds deltaTime) KZ_OVERRIDE
 TimelinePlayback::tickOverride() implementation. More...
 
virtual void onProgressTimeResetOverride () KZ_OVERRIDE
 TimelinePlayback::onProgressTimeResetOverride() implementation. More...
 
virtual void onAppliedStateChangedOverride () KZ_OVERRIDE
 TimelinePlayback::onAppliedStateChangedOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::TimelinePlayback
virtual void onPlaybackCompletedOverride ()
 TimelinePlayback calls this function after it has become complete. More...
 
void notifyPlaybackCompleted ()
 Calls completion callback if it is available. 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 TPropertyDataType >
static void modifierCallback (PropertyObject &object, TPropertyDataType &currentValue, PropertyNotificationReason reason, void *userData)
 Modifier callback function for target property. More...
 
template<typename TPropertyDataType , typename TAnimationDataType >
static void modifierCallback (PropertyObject &object, TPropertyDataType &currentValue, PropertyNotificationReason reason, void *userData)
 Modifier callback function for target property. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::TimelinePlayback
enum  State { StateNotStarted, StateOngoing, StateCompleted, StateStopped }
 Status of the playback. More...
 
typedef function< void(TimelinePlayback &)> CompleteCallback
 Callback for complete timeline. 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< 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 class for PropertyAnimationTimeline.

Constructor & Destructor Documentation

kanzi::PropertyAnimationTimelinePlayback::~PropertyAnimationTimelinePlayback ( )

Destructor.

kanzi::PropertyAnimationTimelinePlayback::PropertyAnimationTimelinePlayback ( PropertyAnimationTimelineSharedPtr  propertyAnimationTimeline,
ObjectSharedPtr  object,
bool  relative 
)
explicitprotected

Constructor.

Parameters
propertyAnimationTimelineProperty animation timeline to create playback from.
objectTarget object the property of which to animate.
relativeFlag indicating whether playback should be relative or not.

Member Function Documentation

static PropertyAnimationTimelinePlaybackSharedPtr kanzi::PropertyAnimationTimelinePlayback::create ( PropertyAnimationTimelineSharedPtr  propertyAnimationTimeline,
ObjectSharedPtr  object,
bool  relativePlayback 
)
static

Creates new PropertyAnimationTimelinePlayback instance from specified timeline and returns it.

Parameters
propertyAnimationTimelineProperty animation timeline to create playback from.
objectTarget object the property of which to animate.
relativePlaybackFlag indicating whether playback should be relative or not.
Returns
New playback.
static PropertyAnimationTimelinePlaybackSharedPtr kanzi::PropertyAnimationTimelinePlayback::create ( PropertyAnimationTimelineSharedPtr  propertyAnimationTimeline,
TimelinePlaybackContext context 
)
static

Creates new PropertyAnimationTimelinePlayback instance from specified timeline and returns it.

Parameters
propertyAnimationTimelineProperty animation timeline to create playback from.
contextContext used to resolve timeline's path to target object to actual object.
Returns
New playback.
static bool kanzi::PropertyAnimationTimelinePlayback::isCompatible ( AbstractPropertyType propertyType,
AbstractAnimation animation 
)
static

Indicates whether specified animation can be applied to a property of specified property type.

Parameters
propertyTypeProperty type to check.
animationAnimation to check.
Returns
True if animation can be applied to property type, false otherwise.
template<typename TPropertyDataType >
static void kanzi::PropertyAnimationTimelinePlayback::modifierCallback ( PropertyObject object,
TPropertyDataType &  currentValue,
PropertyNotificationReason  reason,
void *  userData 
)
staticprotected

Modifier callback function for target property.

template<typename TPropertyDataType , typename TAnimationDataType >
static void kanzi::PropertyAnimationTimelinePlayback::modifierCallback ( PropertyObject object,
TPropertyDataType &  currentValue,
PropertyNotificationReason  reason,
void *  userData 
)
staticprotected

Modifier callback function for target property.

template<typename TPropertyDataType >
void kanzi::PropertyAnimationTimelinePlayback::modifyAnimatedProperty ( TPropertyDataType &  currentValue,
PropertyNotificationReason  reason 
)
protected

Modifies value of target property.

Parameters
currentValueProperty value to modify.
reasonReason for which the value should be modified.
template<typename TPropertyDataType , typename TAnimationDataType >
void kanzi::PropertyAnimationTimelinePlayback::modifyAnimatedProperty ( TPropertyDataType &  currentValue,
PropertyNotificationReason  reason 
)
protected

Modifies value of target property.

Parameters
currentValueProperty value to modify.
reasonReason for which the value should be modified.
void kanzi::PropertyAnimationTimelinePlayback::installModifier ( )
protected

Installs modifier to target property.

template<typename TPropertyDataType >
void kanzi::PropertyAnimationTimelinePlayback::installModifier ( )
protected

Installs modifier to target property.

template<typename TPropertyDataType , typename TAnimationDataType >
void kanzi::PropertyAnimationTimelinePlayback::installModifier ( )
protected

Installs modifier to target property.

void kanzi::PropertyAnimationTimelinePlayback::uninstallModifier ( )
protected

Uninstalls modifier from target property.

template<typename TPropertyDataType >
void kanzi::PropertyAnimationTimelinePlayback::uninstallModifier ( )
protected

Uninstalls modifier from target property.

template<typename TPropertyDataType , typename TAnimationDataType >
void kanzi::PropertyAnimationTimelinePlayback::uninstallModifier ( )
protected

Uninstalls modifier from target property.

void kanzi::PropertyAnimationTimelinePlayback::forgetModifier ( )
protected

Forget property modifier installed on target property (for example, when modifier is removed from the property elsewhere).

void kanzi::PropertyAnimationTimelinePlayback::applyAnimation ( )
protected

Applies timeline animation at playback's content time.

virtual void kanzi::PropertyAnimationTimelinePlayback::tickOverride ( chrono::milliseconds  deltaTime)
protectedvirtual
virtual void kanzi::PropertyAnimationTimelinePlayback::onProgressTimeResetOverride ( )
protectedvirtual
virtual void kanzi::PropertyAnimationTimelinePlayback::onAppliedStateChangedOverride ( )
protectedvirtual

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