Interface template for value animations. More...
#include <kanzi/animation/value_animation.hpp>
Public Member Functions | |
| virtual TValueType | getValue (const TValueType ¤tValue, chrono::milliseconds time)=0 |
| Returns new animated value given current value and time. More... | |
 Public Member Functions inherited from kanzi::AbstractAnimation | |
| virtual | ~AbstractAnimation () |
| Destructor. More... | |
| optional< chrono::milliseconds > | getDuration () |
| Returns the duration of the animation. More... | |
| Public Member Functions inherited from kanzi::Object | |
| Object (Domain *domain) | |
| virtual | ~Object () |
| Domain * | getDomain () const |
| Returns the domain the object belongs to. More... | |
| KzuPropertyManager * | getPropertyManager () const |
| Returns the property manager of the object. More... | |
| KzuTaskScheduler * | getTaskScheduler () const |
| Returns the task scheduler of the object. More... | |
| KzuMessageDispatcher * | getMessageDispatcher () const |
| Returns the message dispatcher of the object. More... | |
| ResourceManager * | getResourceManager () const |
| Returns the resource manager of the object. More... | |
| virtual const Metaclass * | getDynamicMetaclass () const |
| Returns the metaclass of the dynamic type of the object. More... | |
| bool | isTypeOf (const Metaclass *objectType) const |
| Determines if the type of this object is the given type or derived from it. More... | |
| template<typename DataType > | |
| void | setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType value) |
| Sets the local value of a property. More... | |
| void | setProperty (const PropertyType< ResourceID > &propertyType, ResourceSharedPtr value) |
| Sets the local value of a resource id property with a resource pointer. More... | |
| template<typename DataType > | |
| DataType | getProperty (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property. More... | |
| template<typename DataType > | |
| bool | getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) 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 > | |
| void | setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType value) |
| void | setAbstractProperty (AbstractPropertyType abstractPropertyType, ResourceSharedPtr value) |
| template<typename DataType > | |
| DataType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| bool | getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const |
| bool | hasValue (AbstractPropertyType propertyType) const |
| Evaluates whether there are any inputs into the property value. More... | |
| bool | hasLocalValue (AbstractPropertyType propertyType) const |
| Evaluates whether there is a local value set for the property. More... | |
| void | removeLocalValue (AbstractPropertyType propertyType) |
| Removes the local value associated with the property. More... | |
| void | copyLocalValues (const Object &other) |
| Copies all local values from another object. More... | |
| virtual void | onPropertyChanged (AbstractPropertyType propertyType, KzuPropertyNotificationReason reason) |
| Virtual function to handle property change notifications. More... | |
| AppliedStyleEntry * | applyObjectStyle (kanzi::StyleSharedPtr style) |
| Applies a style to an object. More... | |
| void | unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry) |
| void | applyObjectStyles () |
| Apply all styles for an object node. More... | |
| void | unapplyObjectStyles () |
| Unapplies and removes all applied styles. More... | |
Protected Member Functions | |
| ValueAnimation (Domain *domain) | |
| Constructor. More... | |
| Protected Member Functions inherited from kanzi::AbstractAnimation | |
| AbstractAnimation (Domain *domain) | |
| Constructor. More... | |
| virtual optional < chrono::milliseconds > | getDurationOverride () |
| Virtual function the derived classes should overload to return duration. More... | |
| Protected Member Functions inherited from kanzi::Object | |
| void | initialize () |
| void | onCopy (const Object &other) |
Additional Inherited Members | |
| 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... | |
| Protected Types inherited from kanzi::Object | |
| typedef vector < AppliedStyleEntry * > | AppliedStyleContainer |
| Applied style container. More... | |
| Protected Attributes inherited from kanzi::Object | |
| AppliedStyleContainer | m_appliedStyles |
| Listing of applied styles applied to this object. More... | |
Interface template for value animations.
Classes derived from ValueAnimation define animation data and algorithms that animate values. For example FromToAnimation defines animations between two values and KeyframeAnimation animates values along a sequence of keyframes. ValueAnimation provides a common interface to retrieve a new animated value given current value and time.
ValueAnimation and derived classes operate only on values. You can animate values of properties by combining classes like PropertyAnimationTimeline and PropertyFieldAnimationTimeline with classes like FromToAnimation and KeyframeAnimation.
ValueAnimation is an interface template. TValueType template parameter defines the type of the animated value. For example, FloatValueAnimation defines interface to animate float values and is defined as ValueAnimation<float>.
|
inlineexplicitprotected |
Constructor.
|
pure virtual |
Returns new animated value given current value and time.
Classes derived from ValueAnimation define data and algorithms to calculate the value returned by this function.
| currentValue | Current value that is used as basis for animation calculations. |
Implemented in kanzi::KeyframeAnimation< TValueType >, and kanzi::FromToAnimation< TValueType, TEasingFunction >.
