Kanzi 3.9.10
kanzi::PropertyFieldAnimationTimeline Class Reference

Kanzi animation system consists of animations and timelines: More...

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

Inheritance diagram for kanzi::PropertyFieldAnimationTimeline:
[legend]

Classes

struct  Entry
 Structure holding the property field which is to be animated, and its associated animation. More...
 

Public Types

typedef EntryContainer::const_iterator EntryConstIterator
 
typedef vector< EntryEntryContainer
 
- Public Types inherited from kanzi::Timeline
enum  DirectionBehavior { DirectionBehaviorNormal , DirectionBehaviorReverse , DirectionBehaviorPingPong }
 Specifies the direction behavior for a timeline. 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
 

Public Member Functions

void addEntry (PropertyField field, FloatAnimationSharedPtr animation)
 Add an entry in the container of the property fields and their respective animations.
 
EntryConstIterator beginEntries () const
 Returns an iterator pointing to the beginning of the associated animations container.
 
optional< chrono::milliseconds > calculateContentDuration () override
 Timeline::calculateContentDuration() implementation.
 
EntryConstIterator endEntries () const
 Returns an iterator to the end of the associated animations container.
 
EntryContainer getAnimations () const
 Gets the animation collection associated with the timeline.
 
AbstractPropertyType getPropertyType () const
 Gets the property type associated with the timeline.
 
- Public Member Functions inherited from kanzi::Timeline
TimeInterval calculateClipInterval ()
 Calculates clip interval of timeline.
 
optional< chrono::milliseconds > calculateDuration ()
 Calculates the duration of the timeline.
 
unsigned int calculateIterationCount ()
 Calculates number of iterations in timeline.
 
optional< chrono::milliseconds > calculateIterationDuration ()
 Calculates iteration duration.
 
TimelinePlaybackSharedPtr createPlayback (TimelinePlaybackContext &context)
 Creates playback for timeline.
 
optional< chrono::milliseconds > getClipDuration () const
 Gets the clip duration of the timeline (in milliseconds).
 
chrono::milliseconds getClipStartTime () const
 Gets the clip start time of the timeline (in milliseconds).
 
DirectionBehavior getDirectionBehavior () const
 Gets the direction behavior of a timeline.
 
float getDurationScale () const
 Gets the duration scale of timeline.
 
float getMinimumDurationScale () const
 Gets minimum duration scale.
 
unsigned int getRepeatCount () const
 Gets the repeat count of the timeline (zero indicates infinite repeats).
 
chrono::milliseconds getStartTime () const
 Gets the start time of the timeline (in milliseconds).
 
void setClipDuration (optional< chrono::milliseconds > duration)
 Sets the clip duration of the timeline (in milliseconds).
 
void setClipStartTime (chrono::milliseconds clipStartTime)
 Sets the clip start time of the timeline (in milliseconds).
 
void setDirectionBehavior (DirectionBehavior directionBehavior)
 Sets the direction behavior of a timeline.
 
void setDurationScale (float scale)
 Sets the duration scale of timeline.
 
void setRepeatCount (unsigned int repeatCount)
 Sets the repeat count of the timeline (zero indicates infinite repeats).
 
void setStartTime (chrono::milliseconds startTime)
 Gets the start time of the timeline (in milliseconds).
 
- Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object.
 
void applyObjectStyles ()
 Apply all styles for an object node.
 
DomaingetDomain () const
 Returns the domain the object belongs to.
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object.
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain.
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object.
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object.
 
ScriptingContextSharedPtr getScriptingContext () const
 Gets the scripting context of the object.
 
 Object (Domain *domain)
 
void setScriptingContext (ScriptingContextSharedPtr context)
 Sets the scripting context of the object.
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles.
 
 ~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.
 
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 addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 Adds a property modifier without notifying handlers.
 
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, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 Returns the begin iterator to the internal property storage container.
 
PropertyStorageContainer::const_iterator beginPropertyStorage () const
 Returns the begin iterator to the internal property storage container.
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object.
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object.
 
PropertyStorageContainer::iterator endPropertyStorage ()
 Returns the end iterator to the internal property storage container.
 
PropertyStorageContainer::const_iterator endPropertyStorage () const
 Returns the end iterator to the internal property storage container.
 
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.
 
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.
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property type.
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers.
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
 Gets number of current notification handlers for given property type.
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers.
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property.
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property.
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value.
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications.
 
 PropertyObject ()
 
void removeKzbProperties ()
 Remove all KZB properties.
 
void removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
 Remove all KZB properties that are not included in a given set.
 
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.
 
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.
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
KZ_DEPRECATED void validatePropertyModifiers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers.
 
void validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers.
 
virtual ~PropertyObject ()
 

Static Public Member Functions

static PropertyFieldAnimationTimelineSharedPtr create (Domain *domain, string_view objectPath, AbstractPropertyType propertyType)
 Creates a property field animation timeline.
 
static TimelineSharedPtr create (Domain *domain, string_view)
 Creates a property field animation timeline.
 
static ObjectSharedPtr load (Domain *domain, string_view name, KzbFile &kzbFile, KzbMemoryParser &parser)
 Loads a timeline from KZB file.
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class.
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info.
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class.
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info.
 

Protected Member Functions

TimelinePlaybackSharedPtr createPlaybackOverride (TimelinePlaybackContext &context) override
 Timeline::createPlaybackOverride() implementation.
 
void loadOverride (Domain *domain, string_view name, KzbFile &kzbFile, KzbMemoryParser &parser) override
 Timeline::loadOverride() implementation.
 
 PropertyFieldAnimationTimeline (Domain *domain)
 Constructor.
 
 PropertyFieldAnimationTimeline (Domain *domain, string_view objectPath, AbstractPropertyType propertyType)
 Constructor.
 
- Protected Member Functions inherited from kanzi::Timeline
 Timeline (Domain *domain)
 Constructor.
 
- 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.
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
template<typename DataType >
void addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
 Adds a property modifier entry to the property modifier stack and validates them.
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 Internally adds a property value source.
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 Internally adds a property value source.
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage.
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the property storage for given property type descriptor.
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type.
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.
 
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.
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
 Notifies all property handlers on a property storage.
 
void onCopy (const PropertyObject &other)
 
void removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Removes a local value from the given property storage.
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 Removes a property value source.
 
void validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers without notifying handlers.
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers and notifies handlers.
 

Friends

class PropertyFieldAnimationTimelinePlayback
 

Additional Inherited Members

- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container.
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object.
 

Detailed Description

Kanzi animation system consists of animations and timelines:

  • Animations define how to animate a property.
  • Timelines map the animations to time and the objects you want to animate.

Use property field timeline to animate one or more fields of a property, of an object. For example, you can use a separate animation for each color channel to change the color of the text in a Text Block node, or use two different animations to scale a node along x and y axes.

Examples

To create a property field timeline:

// Create a property field timeline and apply it to the Render Transformation property of the current node.
PropertyFieldAnimationTimelineSharedPtr propertyFieldTimeline = PropertyFieldAnimationTimeline::create(domain, ".", Node2D::RenderTransformationProperty);
// 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);

To play an animation regardless of the timeline type:

// Create the playback context and the timeline playback for the node defined in the item2d.
SceneGraphTimelinePlaybackContext context(*item2d);
// Create the playback for the timeline defined in the propertyFieldTimeline.
TimelinePlaybackSharedPtr playback = propertyFieldTimeline->createPlayback(context);
// Start the animation.
domain->getRootTimelineClock()->addTimelinePlayback(playback);

Member Typedef Documentation

◆ EntryContainer

◆ EntryConstIterator

Constructor & Destructor Documentation

◆ PropertyFieldAnimationTimeline() [1/2]

kanzi::PropertyFieldAnimationTimeline::PropertyFieldAnimationTimeline ( Domain * domain)
inlineexplicitprotected

Constructor.

Parameters
domainDomain.

◆ PropertyFieldAnimationTimeline() [2/2]

kanzi::PropertyFieldAnimationTimeline::PropertyFieldAnimationTimeline ( Domain * domain,
string_view objectPath,
AbstractPropertyType propertyType )
inlineexplicitprotected

Constructor.

Parameters
domainDomain.
objectPathRelative path to the object where timeline should be applied. This path is resolved when creating playback from the timeline.
propertyTypeProperty type to which timeline animation should be applied.

Member Function Documentation

◆ create() [1/2]

static TimelineSharedPtr kanzi::PropertyFieldAnimationTimeline::create ( Domain * domain,
string_view  )
inlinestatic

Creates a property field animation timeline.

Parameters
domainDomain.
Returns
The created timeline.

◆ addEntry()

void kanzi::PropertyFieldAnimationTimeline::addEntry ( PropertyField field,
FloatAnimationSharedPtr animation )
inline

Add an entry in the container of the property fields and their respective animations.

Parameters
fieldProperty field to be animated.
animationPointer to associated animation.

◆ create() [2/2]

static PropertyFieldAnimationTimelineSharedPtr kanzi::PropertyFieldAnimationTimeline::create ( Domain * domain,
string_view objectPath,
AbstractPropertyType propertyType )
static

Creates a property field animation timeline.

Parameters
domainDomain.
objectPathRelative path to the object where timeline should be applied. This path is resolved when creating playback from the timeline.
propertyTypeProperty type to which timeline animation should be applied.
Returns
The created timeline.

◆ getPropertyType()

AbstractPropertyType kanzi::PropertyFieldAnimationTimeline::getPropertyType ( ) const
inline

Gets the property type associated with the timeline.

◆ getAnimations()

EntryContainer kanzi::PropertyFieldAnimationTimeline::getAnimations ( ) const
inline

Gets the animation collection associated with the timeline.

◆ beginEntries()

EntryConstIterator kanzi::PropertyFieldAnimationTimeline::beginEntries ( ) const
inline

Returns an iterator pointing to the beginning of the associated animations container.

Returns
Iterator to the beginning of the container.

◆ endEntries()

EntryConstIterator kanzi::PropertyFieldAnimationTimeline::endEntries ( ) const
inline

Returns an iterator to the end of the associated animations container.

Returns
Iterator to the end of the container.

◆ calculateContentDuration()

optional< chrono::milliseconds > kanzi::PropertyFieldAnimationTimeline::calculateContentDuration ( )
overridevirtual

Timeline::calculateContentDuration() implementation.

Reimplemented from kanzi::Timeline.

◆ load()

static ObjectSharedPtr kanzi::PropertyFieldAnimationTimeline::load ( Domain * domain,
string_view name,
KzbFile & kzbFile,
KzbMemoryParser & parser )
static

Loads a timeline from KZB file.

Parameters
domainDomain.
nameTimeline name.
kzbFileKZB file to load timeline data from.
parserParser to parse timeline data.
Returns
Loaded timeline.

◆ createPlaybackOverride()

TimelinePlaybackSharedPtr kanzi::PropertyFieldAnimationTimeline::createPlaybackOverride ( TimelinePlaybackContext & context)
overrideprotectedvirtual

◆ loadOverride()

void kanzi::PropertyFieldAnimationTimeline::loadOverride ( Domain * domain,
string_view name,
KzbFile & kzbFile,
KzbMemoryParser & parser )
overrideprotectedvirtual

Timeline::loadOverride() implementation.

Reimplemented from kanzi::Timeline.

Friends And Related Symbol Documentation

◆ PropertyFieldAnimationTimelinePlayback


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