kanzi::PropertyFieldAnimationTimeline Class Reference

The Kanzi animation system consists animations and timelines: animations define how to animate a property, and timelines map the animations to time and to objects you want to animate. More...

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

Inheritance diagram for kanzi::PropertyFieldAnimationTimeline:
kanzi::Timeline kanzi::Object kanzi::MetaObject kanzi::PropertyObject

Classes

struct  Entry
 

Public Types

typedef vector< EntryEntryContainer
 
typedef EntryContainer::const_iterator EntryConstIterator
 
- 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 intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 

Public Member Functions

void addEntry (PropertyField field, FloatAnimationSharedPtr animation)
 
AbstractPropertyType getPropertyType () const
 Gets the property type associated with the timeline. More...
 
EntryContainer getAnimations () const
 Gets the animation collection associated with the timeline. More...
 
EntryConstIterator beginEntries () const
 
EntryConstIterator endEntries () const
 
virtual optional< chrono::milliseconds > calculateContentDuration () KZ_OVERRIDE
 Calculates the duration of the content of the timeline. More...
 
- Public Member Functions inherited from kanzi::Timeline
chrono::milliseconds getStartTime () const
 Gets the start time of the timeline (in milliseconds). More...
 
void setStartTime (chrono::milliseconds startTime)
 Gets the start time of the timeline (in milliseconds). More...
 
chrono::milliseconds getClipStartTime () const
 Gets the clip start time of the timeline (in milliseconds). More...
 
void setClipStartTime (chrono::milliseconds clipStartTime)
 Sets the clip start time of the timeline (in milliseconds). More...
 
optional< chrono::milliseconds > getClipDuration () const
 Gets the clip duration of the timeline (in milliseconds). More...
 
void setClipDuration (optional< chrono::milliseconds > duration)
 Sets the clip duration of the timeline (in milliseconds). More...
 
unsigned int getRepeatCount () const
 Gets the repeat count of the timeline (zero indicates infinite repeats). More...
 
void setRepeatCount (unsigned int repeatCount)
 Sets the repeat count of the timeline (zero indicates infinite repeats). More...
 
DirectionBehavior getDirectionBehavior () const
 Gets the direction behavior of a timeline. More...
 
void setDirectionBehavior (DirectionBehavior directionBehavior)
 Sets the direction behavior of a timeline. More...
 
float getDurationScale () const
 Gets the duration scale of timeline. More...
 
void setDurationScale (float scale)
 Sets the duration scale of timeline. More...
 
float getMinimumDurationScale () const
 Gets minimum duration scale. More...
 
TimeInterval calculateClipInterval ()
 Calculates clip interval of timeline. More...
 
unsigned int calculateIterationCount ()
 Calculates number of iterations in timeline. More...
 
optional< chrono::milliseconds > calculateIterationDuration ()
 Calculates iteration duration. More...
 
optional< chrono::milliseconds > calculateDuration ()
 Calculates the duration of the timeline. More...
 
TimelinePlaybackSharedPtr createPlayback (TimelinePlaybackContext &context)
 Creates playback for timeline. 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 TimelineSharedPtr create (Domain *domain, string_view)
 
static PropertyFieldAnimationTimelineSharedPtr create (Domain *domain, string_view objectPath, AbstractPropertyType propertyType)
 
static ObjectSharedPtr load (Domain *domain, string_view name, KzbFile &kzbFile, KzbMemoryParser &parser)
 Loads timeline from KZB file. 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

 PropertyFieldAnimationTimeline (Domain *domain)
 
 PropertyFieldAnimationTimeline (Domain *domain, string_view objectPath, AbstractPropertyType propertyType)
 
virtual TimelinePlaybackSharedPtr createPlaybackOverride (TimelinePlaybackContext &context) KZ_OVERRIDE
 Creates playback of the timeline. More...
 
virtual void loadOverride (Domain *domain, string_view name, KzbFile &kzbFile, KzbMemoryParser &parser) KZ_OVERRIDE
 Timeline::loadOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::Timeline
 Timeline (Domain *domain)
 Constructor. 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)
 

Friends

class PropertyFieldAnimationTimelinePlayback
 

Additional Inherited Members

- 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

The Kanzi animation system consists animations and timelines: animations define how to animate a property, and timelines map the animations to time and to objects you want to animate.

Property field timeline applies an animation to 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.
// 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

typedef EntryContainer::const_iterator kanzi::PropertyFieldAnimationTimeline::EntryConstIterator

Constructor & Destructor Documentation

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

Member Function Documentation

static TimelineSharedPtr kanzi::PropertyFieldAnimationTimeline::create ( Domain domain,
string_view   
)
inlinestatic
void kanzi::PropertyFieldAnimationTimeline::addEntry ( PropertyField  field,
FloatAnimationSharedPtr  animation 
)
inline
static PropertyFieldAnimationTimelineSharedPtr kanzi::PropertyFieldAnimationTimeline::create ( Domain domain,
string_view  objectPath,
AbstractPropertyType  propertyType 
)
inlinestatic
AbstractPropertyType kanzi::PropertyFieldAnimationTimeline::getPropertyType ( ) const
inline

Gets the property type associated with the timeline.

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

Gets the animation collection associated with the timeline.

EntryConstIterator kanzi::PropertyFieldAnimationTimeline::beginEntries ( ) const
inline
EntryConstIterator kanzi::PropertyFieldAnimationTimeline::endEntries ( ) const
inline
virtual optional<chrono::milliseconds> kanzi::PropertyFieldAnimationTimeline::calculateContentDuration ( )
virtual

Calculates the duration of the content of the timeline.

No timeline playback properties (e.g. start time, clip start time and duration, repeat count, etc) should be used when calculating content duration. By default content duration of timeline is zero milliseconds (empty timeline).

Returns
Duration of timeline content.

Reimplemented from kanzi::Timeline.

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

Loads timeline from KZB file.

Parameters
domainDomain.
nameTimeline name.
kzbFileKZB file to load timeline data from.
parserParser to parse timeline data.
Returns
Loaded timeline.
virtual TimelinePlaybackSharedPtr kanzi::PropertyFieldAnimationTimeline::createPlaybackOverride ( TimelinePlaybackContext context)
protectedvirtual

Creates playback of the timeline.

Parameters
contextContext for playback.
Returns
Playback of the timeline.

Implements kanzi::Timeline.

virtual void kanzi::PropertyFieldAnimationTimeline::loadOverride ( Domain domain,
string_view  name,
KzbFile kzbFile,
KzbMemoryParser parser 
)
protectedvirtual

Timeline::loadOverride() implementation.

Reimplemented from kanzi::Timeline.

Friends And Related Function Documentation


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