Use Property Driven Animation Player when you want to use a property type to control a keyframe animation. More...

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

Inheritance diagram for kanzi::PropertyDrivenAnimationPlayer:

Public Member Functions
string	getTimeControllerPropertyType () const
	Gets the value of the TimeControllerPropertyTypeProperty property of the player. More...

TimelineSharedPtr	getTimeline () const
	Gets an animation timeline from the TimelineProperty property of the player. More...

bool	isEnabled () const
	Gets the value of the EnabledProperty property. More...

bool	isRelativePlayback () const
	Gets the value of the RelativePlaybackProperty property. More...

void	setEnabled (bool enabled)
	Sets the value of the EnabledProperty property. More...

void	setRelativePlayback (bool relativePlayback)
	Sets the value of the RelativePlaybackProperty property. More...

void	setTimeControllerPropertyType (string propertyTypeName)
	Sets the value of the TimeControllerPropertyTypeProperty property of the player. More...

void	setTimeline (TimelineSharedPtr animationTimeline)
	Sets an animation timeline to the TimelineProperty property of the player. More...

Public Member Functions inherited from kanzi::NodeComponent
void	attach (NodeWeakPtr node)
	Attaches node component to node. More...

void	detach ()
	Detaches node component from the node it was attached to. 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...

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	isAttached () const
	Indicates whether node component is attached to a node. More...

bool	isAttaching () const
	Indicates whether node component is in the process of attaching 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	isDetached () const
	Indicates whether node component is detached from any node. More...

bool	isDetaching () const
	Indicates whether node component currently detaching from the node. More...

bool	isDetachingOrDetached () const
	Indicates whether node component is in the process of detaching from the node or already detached. More...

void	setName (string_view name)
	Sets the name of node component. More...

	~NodeComponent () 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...

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object. More...

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain. More...

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () 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

	PropertyObject ()

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set. More...

void	removeKzbProperties ()
	Remove all KZB properties. More...

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 PropertyDrivenAnimationPlayerSharedPtr	create (Domain *domain, string_view name)
	Creates a Property Driven Animation Player. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Returns PropertyType editor info of a Property Driven Animation Player. More...

Static Public Member Functions inherited from kanzi::NodeComponent
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	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 Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Public Attributes
static PropertyType< bool >	EnabledProperty
	Sets whether a Property Driven Animation Player applies the animation timeline. More...

static PropertyType< bool >	RelativePlaybackProperty
	Sets whether a Property Driven Animation Player plays animation timelines in a relative manner by adding the animated value to the target property value instead of replacing the property value. More...

static PropertyType< string >	TimeControllerPropertyTypeProperty
	Sets the type name of the time controller property. More...

static PropertyType< ResourceSharedPtr >	TimelineProperty
	Sets the animation timeline that the Property Driven Animation Player applies at the time that is set in the TimeControllerPropertyTypeProperty property every time the value of that property changes. More...

Static Public Attributes inherited from kanzi::NodeComponent
static PropertyType< string >	NameProperty
	Name property specifies the name of node component. More...

Protected Member Functions
void	attachOverride () override
	NodeComponent::attachOverride() implementation. 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...

void	detachOverride () override
	NodeComponent::detachOverride() implementation. More...

void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Object::onPropertyChanged() implementation. More...

	PropertyDrivenAnimationPlayer (Domain *domain, string_view name)
	Constructor. More...

void	startTimelinePlayback ()
	Starts playback of an animation timeline assigned to the player through the TimelineProperty property. More...

void	stopTimelinePlayback ()
	Stops ongoing playback of an animation timeline. More...

template<typename T >
void	updateTimelinePlaybackTime ()
	Updates timeline playback by time calculated from the time controller property. More...

Protected Member Functions inherited from kanzi::NodeComponent
template<typename TMessageType , typename TClass , typename TMethod >
Node::MessageSubscriptionToken	addNodeComponentMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TMethod method)
	Kanzi calls the message handler that you add using this function when the target name of the incoming message matches the name of this node component, or if the message is broadcast to all node components with an empty target name. More...

template<typename TMessageType >
Node::MessageSubscriptionToken	addNodeComponentMessageHandler (TMessageType &messageType, typename TMessageType::FunctionType function)
	Kanzi calls the message handler that you add using this function when the target name of the incoming message matches the name of the node component, or if the message is broadcast to all node components with an empty target name. More...

void	dispatchAbstractMessage (const AbstractMessageType &messageType, MessageArguments &messageArguments)
	Adds the name of the node component to the abstract message arguments and dispatches the message to the node of the node component. More...

template<typename TArgumentsType >
void	dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments)
	Adds the name of the node component to the message arguments and dispatches the message to the node of the node component. More...

	NodeComponent (Domain *domain, string_view name)
	Constructor. 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
void	initialize ()

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (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::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (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...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (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	timeControllerPropertyNoticationHandler (PropertyObject &, const T &, PropertyNotificationReason, void *userData)
	Notification handler for time property. More...

Static Protected Member Functions inherited from kanzi::NodeComponent
template<typename TMessageType >
static void	nodeComponentMessageHandler (const NodeComponent *nodeComponent, const typename TMessageType::FunctionType &function, typename TMessageType::ArgumentsType &messageArguments)
	Handler function for node component messages. More...

Additional Inherited Members
Public Types inherited from kanzi::NodeComponent
using	NodeComponentMessageArguments = NodeComponentTargetMessageArguments
	Legacy name for NodeComponentTargetMessageArguments. More...

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 PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	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

Use Property Driven Animation Player when you want to use a property type to control a keyframe animation.

Property Driven Animation Player applies an animation with the time taken from a specific property in the node, to which you attach the player, every time that property changes.

Property Driven Animation Player applies the timeline specified in the TimelineProperty property of the player. Kanzi resolves paths to animated objects relative to the node to which you attach the player. All animations in the applied timeline are relative: values calculated in animations are added to property values instead of replacing them.

The time for the timeline is taken from a property of the node to which you attach the Property Driven Animation Player. To set the type name of this property, use the TimeControllerPropertyTypeProperty property of the player. You can use any integer and float properties. Property Driven Animation Player does not support using properties of other data types. The time calculated from the value of the property depends on its data type:

For float properties, property value 1.0 is interpreted as 1 second. For example, if the value of the time property is 5.5f, the time for the timeline is 5.5 seconds, and so on.
For integer properties, property value 1 is interpreted as 1 millisecond. For example, if the value of the time property is 2300, the time for the timeline is 2.3 seconds, and so on.

It is recommended to use integer properties as time controllers. Using an integer property enables precise control of the time at which the animations in the timeline are applied. If you use a floating point property as a time controller, the Property Driven Animation Player rounds it to an integer number of milliseconds. In this case the result time, at which the animations in the timeline are applied, is not precise, but you can apply various effects to a floating point time property. For example, smooth interpolation by PropertyTargetInterpolator.

Property Driven Animation Player starts to apply animations from the timeline immediately after it is attached to the node. If the time controller property cannot be resolved or if it has an unsupported data type, the player does not apply the timeline. If the time controller property is resolved but is not set to the node, the player calculates the time using the default property value.

Note that the TimelineProperty and TimeControllerPropertyTypeProperty properties are applied only once when you attach the Property Driven Animation Player to the node. New values, which you set to these properties after attaching the player, are ignored.

See also: AnimationPlayer, PropertyTargetInterpolator

Examples

To create a Property Driven Animation Player and sets its timeline and time controller property:

        // Create property driven animation player.
        PropertyDrivenAnimationPlayerSharedPtr player = PropertyDrivenAnimationPlayer::create(domain, "player");
        // Set timeline.
        player->setTimeline(timeline);
        // Set type name of time controller property.
        player->setTimeControllerPropertyType(timePropertyType.getName());

To attach a Property Driven Animation Player to a node:

node->addNodeComponent(player);

Constructor & Destructor Documentation

◆ PropertyDrivenAnimationPlayer()

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

explicitprotected

Constructor.

Parameters

domain	Domain.
name	Name of animation player.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::PropertyDrivenAnimationPlayer::makeEditorInfo ( )

static

Returns PropertyType editor info of a Property Driven Animation Player.

◆ create()

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

static

Creates a Property Driven Animation Player.

Parameters

domain	Domain.
name	Name of the Property Driven Animation Player.

Returns: Property Driven Animation Player.

◆ setTimeline()

void kanzi::PropertyDrivenAnimationPlayer::setTimeline ( TimelineSharedPtr animationTimeline )

Sets an animation timeline to the TimelineProperty property of the player.

Parameters

animationTimeline timeline.

◆ getTimeline()

TimelineSharedPtr kanzi::PropertyDrivenAnimationPlayer::getTimeline ( ) const

Gets an animation timeline from the TimelineProperty property of the player.

Returns: timelime.

◆ setTimeControllerPropertyType()

void kanzi::PropertyDrivenAnimationPlayer::setTimeControllerPropertyType ( string propertyTypeName )

Sets the value of the TimeControllerPropertyTypeProperty property of the player.

Parameters

propertyTypeName Name of property type.

◆ getTimeControllerPropertyType()

string kanzi::PropertyDrivenAnimationPlayer::getTimeControllerPropertyType ( ) const

Gets the value of the TimeControllerPropertyTypeProperty property of the player.

Returns: Name of property type.

◆ setRelativePlayback()

void kanzi::PropertyDrivenAnimationPlayer::setRelativePlayback ( bool relativePlayback )

Sets the value of the RelativePlaybackProperty property.

Parameters

relativePlayback Sets whether the playback is relative.

◆ isRelativePlayback()

bool kanzi::PropertyDrivenAnimationPlayer::isRelativePlayback ( ) const

Gets the value of the RelativePlaybackProperty property.

Returns: If the playback is relative, true, otherwise false.

◆ setEnabled()

void kanzi::PropertyDrivenAnimationPlayer::setEnabled ( bool enabled )

Sets the value of the EnabledProperty property.

Parameters

enabled Sets whether to apply the animation timeline.

◆ isEnabled()

bool kanzi::PropertyDrivenAnimationPlayer::isEnabled ( ) const

Gets the value of the EnabledProperty property.

Returns: If the animation timeline is applied, true, otherwise false.

◆ attachOverride()

void kanzi::PropertyDrivenAnimationPlayer::attachOverride ( )

overrideprotectedvirtual

NodeComponent::attachOverride() implementation.

Reimplemented from kanzi::NodeComponent.

◆ detachOverride()

void kanzi::PropertyDrivenAnimationPlayer::detachOverride ( )

overrideprotectedvirtual

NodeComponent::detachOverride() implementation.

Reimplemented from kanzi::NodeComponent.

◆ onPropertyChanged()

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

overrideprotectedvirtual

Object::onPropertyChanged() implementation.

Reimplemented from kanzi::PropertyObject.

◆ timeControllerPropertyNoticationHandler()

template<typename T >

static void kanzi::PropertyDrivenAnimationPlayer::timeControllerPropertyNoticationHandler	(	PropertyObject &	,
		const T &	,
		PropertyNotificationReason	,
		void *	userData
	)

staticprotected

Notification handler for time property.

◆ startTimelinePlayback()

void kanzi::PropertyDrivenAnimationPlayer::startTimelinePlayback ( )

protected

Starts playback of an animation timeline assigned to the player through the TimelineProperty property.

If the playback is running, does nothing.

◆ stopTimelinePlayback()

void kanzi::PropertyDrivenAnimationPlayer::stopTimelinePlayback ( )

protected

Stops ongoing playback of an animation timeline.

If the playback is already stopped, does nothing.

◆ updateTimelinePlaybackTime()

template<typename T >

void kanzi::PropertyDrivenAnimationPlayer::updateTimelinePlaybackTime ( )

protected

Updates timeline playback by time calculated from the time controller property.

◆ convertToMilliseconds() [1/2]

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

protected

Converts integer number of milliseconds to chrono duration in milliseconds.

Parameters

milliseconds Number of milliseconds to convert to duration.

Returns: result duration.

◆ convertToMilliseconds() [2/2]

chrono::milliseconds kanzi::PropertyDrivenAnimationPlayer::convertToMilliseconds ( float seconds )

protected

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

Parameters

seconds Number of seconds to convert to duration.

Returns: result duration.

Member Data Documentation

◆ TimelineProperty

PropertyType<ResourceSharedPtr> kanzi::PropertyDrivenAnimationPlayer::TimelineProperty

static

Sets the animation timeline that the Property Driven Animation Player applies at the time that is set in the TimeControllerPropertyTypeProperty property every time the value of that property changes.

◆ TimeControllerPropertyTypeProperty

PropertyType<string> kanzi::PropertyDrivenAnimationPlayer::TimeControllerPropertyTypeProperty

static

Sets the type name of the time controller property.

The time controller property can be any property of float or integer type in the node to which the Property Driven Animation Player is attached. When attached, Property Driven Animation Player uses the type name to find the time controller property in the node. It then uses the value of the time controller property to calculate the time at which to apply the animation timeline set in the TimelineProperty property.

◆ RelativePlaybackProperty

PropertyType<bool> kanzi::PropertyDrivenAnimationPlayer::RelativePlaybackProperty

static

Sets whether a Property Driven Animation Player plays animation timelines in a relative manner by adding the animated value to the target property value instead of replacing the property value.

By default, relative playback is disabled.

◆ EnabledProperty

PropertyType<bool> kanzi::PropertyDrivenAnimationPlayer::EnabledProperty

static

Sets whether a Property Driven Animation Player applies the animation timeline.

The default value is true. When you modify the value of the EnabledProperty property in a Property Driven Animation Player that is attached to a node, the effect is immediate. You do not have to reattach the player.

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

kanzi/ui/node_component/animation/property_driven_animation_player.hpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Examples

Constructor & Destructor Documentation

◆ PropertyDrivenAnimationPlayer()

Member Function Documentation

◆ makeEditorInfo()

◆ create()

◆ setTimeline()

◆ getTimeline()

◆ setTimeControllerPropertyType()

◆ getTimeControllerPropertyType()

◆ setRelativePlayback()

◆ isRelativePlayback()

◆ setEnabled()

◆ isEnabled()

◆ attachOverride()

◆ detachOverride()

◆ onPropertyChanged()

◆ timeControllerPropertyNoticationHandler()

◆ startTimelinePlayback()

◆ stopTimelinePlayback()

◆ updateTimelinePlaybackTime()

◆ convertToMilliseconds() [1/2]

◆ convertToMilliseconds() [2/2]

Member Data Documentation

◆ TimelineProperty

◆ TimeControllerPropertyTypeProperty

◆ RelativePlaybackProperty

◆ EnabledProperty