kanzi::FromToAnimationBase< TValueType > Class Template Reference

Template base class for from-to animations. More...

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

Inheritance diagram for kanzi::FromToAnimationBase< TValueType >:

Public Member Functions
AnimationEasingMode	getEasingMode () const
	Returns the easing function of the animation.
optional< TValueType >	getFrom () const
	Returns "From" value of the animation.
optional< TValueType >	getTo () const
	Returns "To" value of the animation.
bool	hasFrom () const
	If the animation has a "From" value, returns true, otherwise false.
bool	hasTo () const
	If the animation has a "To" value, returns true, otherwise false.
void	setDuration (chrono::milliseconds duration)
	Sets the animation duration.
void	setEasingMode (AnimationEasingMode mode)
	Sets the easing function of the animation.
void	setFrom (optional< TValueType > from)
	Sets "From" value of the animation.
void	setTo (optional< TValueType > to)
	Sets "To" value of the animation.
Public Member Functions inherited from kanzi::ValueAnimation< TValueType >
virtual TValueType	getValue (const TValueType &currentValue, chrono::milliseconds time)=0
	Returns new animated value given current value and time.
Public Member Functions inherited from kanzi::AbstractAnimation
optional< chrono::milliseconds >	getDuration ()
	Returns the duration of the animation.
	~AbstractAnimation () override
	Destructor.
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.
Domain *	getDomain () const
	Returns the domain the object belongs to.
const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object.
MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain.
detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object.
ResourceManager *	getResourceManager () 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 PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Returns an empty PropertyType editor information.
Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	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 Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Protected Member Functions
	FromToAnimationBase (Domain *domain, chrono::milliseconds duration, optional< TValueType > from, optional< TValueType > to)
	Constructor.
optional< chrono::milliseconds >	getDurationOverride () override
	AbstractAnimation::getDurationOverride() implementation.
Protected Member Functions inherited from kanzi::ValueAnimation< TValueType >
	ValueAnimation (Domain *domain)
	Constructor.
Protected Member Functions inherited from kanzi::AbstractAnimation
	AbstractAnimation (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::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value.
AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (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::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage.
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.
PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type.
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.
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.
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.

Protected Attributes
chrono::milliseconds	m_duration
	Animation duration.
AnimationEasingMode	m_easingMode
	Easing mode.
optional< TValueType >	m_from
	"From" value of the animation.
optional< TValueType >	m_to
	"To" value of the animation.
Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object.

Additional Inherited Members
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.

Detailed Description

template<typename TValueType>
class kanzi::FromToAnimationBase< TValueType >

Template base class for from-to animations.

Template Parameters

TValueType

Defines the type of the value you want to animate. For example, float, bool, int, ColorRGBA.

Deriving from FromToAnimationBase defines a from-to animation. Use the from-to animation to define from which -> to which value you would want to to animate a property, with the help of an easing curve that defines the rate of change for the animation.

Constructor & Destructor Documentation

FromToAnimationBase()

template<typename TValueType >

kanzi::FromToAnimationBase< TValueType >::FromToAnimationBase ( Domain * domain, chrono::milliseconds duration, optional< TValueType > from, optional< TValueType > to )

inlineexplicitprotected

Constructor.

By default, the easing function is set to AnimationEaseIn.

Parameters

domain	Domain.
duration	Animation duration in milliseconds.
from	Value from which you want to animate the property, if omitted(that is, set to nullopt), the current value of the property will be used.
to	Value to which you want to animate the property, if omitted(that is, set to nullopt), the current value of the property will be used.

Member Function Documentation

makeEditorInfo()

template<typename TValueType >

static PropertyTypeEditorInfoSharedPtr kanzi::FromToAnimationBase< TValueType >::makeEditorInfo ( )

inlinestatic

Returns an empty PropertyType editor information.

getFrom()

template<typename TValueType >

optional< TValueType > kanzi::FromToAnimationBase< TValueType >::getFrom ( ) const

inline

Returns "From" value of the animation.

Returns

"From" value of the animation.

setFrom()

template<typename TValueType >

void kanzi::FromToAnimationBase< TValueType >::setFrom ( optional< TValueType > from )

inline

Sets "From" value of the animation.

Parameters

from	"From" value of the animation.

hasFrom()

template<typename TValueType >

bool kanzi::FromToAnimationBase< TValueType >::hasFrom ( ) const

inline

If the animation has a "From" value, returns true, otherwise false.

Returns

If the animation has a "From" value, true, otherwise false.

getTo()

template<typename TValueType >

optional< TValueType > kanzi::FromToAnimationBase< TValueType >::getTo ( ) const

inline

Returns "To" value of the animation.

Returns

"To" value of the animation.

setTo()

template<typename TValueType >

void kanzi::FromToAnimationBase< TValueType >::setTo ( optional< TValueType > to )

inline

Sets "To" value of the animation.

Parameters

to	"To" value of the animation.

hasTo()

template<typename TValueType >

bool kanzi::FromToAnimationBase< TValueType >::hasTo ( ) const

inline

If the animation has a "To" value, returns true, otherwise false.

Returns

If the animation has a "To" value, true, otherwise false.

setDuration()

template<typename TValueType >

void kanzi::FromToAnimationBase< TValueType >::setDuration ( chrono::milliseconds duration )

inline

Sets the animation duration.

Parameters

duration

Animation duration in milliseconds.

setEasingMode()

template<typename TValueType >

void kanzi::FromToAnimationBase< TValueType >::setEasingMode ( AnimationEasingMode mode )

inline

Sets the easing function of the animation.

Parameters

mode	Easing function of the animation.

See also

AnimationEasingMode enum for the list.

getEasingMode()

template<typename TValueType >

AnimationEasingMode kanzi::FromToAnimationBase< TValueType >::getEasingMode ( ) const

inline

Returns the easing function of the animation.

Returns

Easing function of the animation.

getDurationOverride()

template<typename TValueType >

optional< chrono::milliseconds > kanzi::FromToAnimationBase< TValueType >::getDurationOverride ( )

inlineoverrideprotectedvirtual

AbstractAnimation::getDurationOverride() implementation.

Reimplemented from kanzi::AbstractAnimation.

Member Data Documentation

m_duration

template<typename TValueType >

chrono::milliseconds kanzi::FromToAnimationBase< TValueType >::m_duration

protected

Animation duration.

m_from

template<typename TValueType >

optional<TValueType> kanzi::FromToAnimationBase< TValueType >::m_from

protected

"From" value of the animation.

m_to

template<typename TValueType >

optional<TValueType> kanzi::FromToAnimationBase< TValueType >::m_to

protected

"To" value of the animation.

m_easingMode

template<typename TValueType >

AnimationEasingMode kanzi::FromToAnimationBase< TValueType >::m_easingMode

protected

Easing mode.

---

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

• kanzi/core.ui/animation/from_to_animation.hpp