Use ValueAccumulatorTimeline to create an animation that continuously adds the value of the input property to the target property. More...

#include <kanzi/ui/node_component/animation/value_accumulator/value_accumulator_timeline.hpp>

Inheritance diagram for kanzi::ValueAccumulatorTimeline< TAccumulatedValue >:

[legend]

Public Types
typedef shared_ptr< ValueAccumulatorTimeline< TAccumulatedValue > >	ValueAccumulatorTimelineSharedPtr
	Shared pointer for the timeline.

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< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
ValueAccumulatorBase::BoundType	getBoundType () const
	Gets the type of the minimum and maximum bounds.

chrono::milliseconds	getIncrementTimeInterval () const
	Gets the increment frequency.

weak_ptr< Object >	getInputObject () const
	Gets the object with the increment property.

AbstractPropertyType	getInputValuePropertyType () const
	Gets the type of an input property whose values you want to accumulate.

TAccumulatedValue	getMaximumAccumulatedValue () const
	Gets the maximum possible accumulated value.

TAccumulatedValue	getMinimumAccumulatedValue () const
	Gets the minimum possible accumulated value.

PropertyField	getTargetPropertyField () const
	Gets the field of a target property where you want to accumulate values.

AbstractPropertyType	getTargetPropertyType () const
	Gets the type of a target property in a field of which you want to accumulate values.

void	setBoundType (ValueAccumulatorBase::BoundType boundType)
	Sets the type of the minimum and maximum bounds.

void	setIncrementTimeInterval (chrono::milliseconds timePeriod)
	Sets the increment period.

void	setMaximumAccumulatedValue (const TAccumulatedValue &maximumValue)
	Sets the maximum possible accumulated value.

void	setMinimumAccumulatedValue (const TAccumulatedValue &minimumValue)
	Sets the minimum possible accumulated value.

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.

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 ValueAccumulatorTimelineSharedPtr	create (Domain *domain, weak_ptr< Object > inputObject, const PropertyType< TAccumulatedValue > &inputValuePropertyType, const AbstractPropertyType &targetPropertyType, PropertyField targetPropertyField)
	Creates a ValueAccumulatorTimeline.

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
virtual optional< chrono::milliseconds >	calculateContentDuration () KZ_OVERRIDE
	Timeline::calculateContentDuration() implementation.

virtual TimelinePlaybackSharedPtr	createPlaybackOverride (TimelinePlaybackContext &context) KZ_OVERRIDE
	Timeline::createPlaybackOverride() implementation.

	ValueAccumulatorTimeline (Domain *domain, weak_ptr< Object > inputObject, const PropertyType< TAccumulatedValue > &inputValuePropertyType, const AbstractPropertyType &targetPropertyType, PropertyField targetPropertyField)
	Constructor.

Protected Member Functions inherited from kanzi::Timeline
virtual void	loadOverride (Domain *domain, string_view name, KzbFile &kzbFile, KzbMemoryParser &parser)
	Loads timeline data from KZB.

	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::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.

Additional Inherited Members
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container.

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object.

Detailed Description

template<typename TAccumulatedValue>
class kanzi::ValueAccumulatorTimeline< TAccumulatedValue >

Use ValueAccumulatorTimeline to create an animation that continuously adds the value of the input property to the target property.

Used internally by FloatValueAccumulator and IntValueAccumulator.

The type parameter TAccumulatedValue can be either float or int, and the type of the input property and the target property (or target property field) must match this type.

Examples

To use ValueAccumulatorTimeline to accumulate values of an integer property into another property over time:

    // Create a Value Accumulator Timeline for an integer property.
    shared_ptr<ValueAccumulatorTimeline<int> > timeline = ValueAccumulatorTimeline<int>::create(domain, node, inputValuePropertyType,
                                                                                                targetPropertyType, PropertyFieldWhole);
    // Set the minimum and maximum values that, when added to the value of the target property,
    // set the lowest and the highest values that the Value Accumulator uses.
    timeline->setMinimumAccumulatedValue(100);
    timeline->setMaximumAccumulatedValue(1000);
 
    // Set how you want the Value Accumulator to handle the value of a property when it reaches
    // the lowest or the highest value that is defined by adding the value of the target property
    // to the minimum and maximum values.
    //
    // When set to Loop and the Value Accumulator reaches the target property value added to the
    // maximum value, the Value Accumulator sets the property value back to the value defined by
    // the target property value added to the minimum value.
    timeline->setBoundType(ValueAccumulatorBase::BoundType::Loop);
 
    // Create the playback for the timeline.
    SceneGraphTimelinePlaybackContext context(*node);
    TimelinePlaybackSharedPtr playback = timeline->createPlayback(context);
 
    // Add the playback to the root timeline clock. When you add the playback to the clock,
    // it starts incrementing the value in subsequent ticks of the clock.
    domain->getRootTimelineClock()->addTimelinePlayback(playback);

To use ValueAccumulatorTimeline to accumulate values of an float property into a field of another property over time:

    // Create a Value Accumulator Timeline for a float property.
    shared_ptr<ValueAccumulatorTimeline<float> > timeline = ValueAccumulatorTimeline<float>::create(domain, node, inputValuePropertyType,
                                                                                                    targetPropertyType, PropertyFieldVectorX);
    // Set the minimum and maximum values that, when added to the value of the target property,
    // set the lowest and the highest values that the Value Accumulator uses.
    timeline->setMinimumAccumulatedValue(0.1f);
    timeline->setMaximumAccumulatedValue(0.8f);
 
    // Set how you want the Value Accumulator to handle the value of a property when it reaches
    // the lowest or the highest value that is defined by adding the value of the target property
    // to the minimum and maximum values.
    //
    // When set to Loop and the Value Accumulator reaches the target property value added to the
    // maximum value, the Value Accumulator sets the property value back to the value defined by
    // the target property value added to the minimum value.
    timeline->setBoundType(ValueAccumulatorBase::BoundType::Loop);
 
    // Set the frequency of the increments in milliseconds.
    timeline->setIncrementTimeInterval(chrono::milliseconds(1));
 
    // Create the playback for the timeline.
    SceneGraphTimelinePlaybackContext context(*node);
    TimelinePlaybackSharedPtr playback = timeline->createPlayback(context);
 
    // Add the playback to the root timeline clock. When you add the playback to the clock,
    // it starts incrementing the value in subsequent ticks of the clock.
    domain->getRootTimelineClock()->addTimelinePlayback(playback);

See also: FloatValueAccumulator, IntValueAccumulator, ValueAccumulatorTimelinePlayback

Since: Kanzi 3.9.2

Member Typedef Documentation

◆ ValueAccumulatorTimelineSharedPtr

template<typename TAccumulatedValue >

typedef shared_ptr<ValueAccumulatorTimeline<TAccumulatedValue> > kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::ValueAccumulatorTimelineSharedPtr

Shared pointer for the timeline.

Constructor & Destructor Documentation

◆ ValueAccumulatorTimeline()

template<typename TAccumulatedValue >

kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::ValueAccumulatorTimeline	(	Domain *	domain,
		weak_ptr< Object >	inputObject,
		const PropertyType< TAccumulatedValue > &	inputValuePropertyType,
		const AbstractPropertyType &	targetPropertyType,
		PropertyField	targetPropertyField )

explicitprotected

Constructor.

Parameters

domain	Domain.
inputObject	Object with the increment size property.
inputValuePropertyType	Type of an input property whose values you want to accumulate.
targetPropertyType	Type of a target property in the field of which you want to accumulate values.
targetPropertyField	Field of target property where you want to accumulate values.

Member Function Documentation

◆ create()

template<typename TAccumulatedValue >

static ValueAccumulatorTimelineSharedPtr kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::create	(	Domain *	domain,
		weak_ptr< Object >	inputObject,
		const PropertyType< TAccumulatedValue > &	inputValuePropertyType,
		const AbstractPropertyType &	targetPropertyType,
		PropertyField	targetPropertyField )

static

Creates a ValueAccumulatorTimeline.

Parameters

domain	Domain.
inputObject	Object with the increment size property.
inputValuePropertyType	Type of an input property whose values you want to accumulate.
targetPropertyType	Type of a target property in the field of which you want to accumulate values.
targetPropertyField	Field of target property where you want to accumulate values.

◆ getInputObject()

template<typename TAccumulatedValue >

weak_ptr< Object > kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::getInputObject ( ) const

Gets the object with the increment property.

Returns: The object with the increment property.

◆ getInputValuePropertyType()

template<typename TAccumulatedValue >

AbstractPropertyType kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::getInputValuePropertyType ( ) const

Gets the type of an input property whose values you want to accumulate.

Returns: Type of an input property whose values you want to accumulate.

◆ getTargetPropertyType()

template<typename TAccumulatedValue >

AbstractPropertyType kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::getTargetPropertyType ( ) const

Gets the type of a target property in a field of which you want to accumulate values.

Returns: Type of a target property in a field of which you want to accumulate values.

◆ getTargetPropertyField()

template<typename TAccumulatedValue >

PropertyField kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::getTargetPropertyField ( ) const

Gets the field of a target property where you want to accumulate values.

Returns: Field of a target property where you want to accumulate values.

◆ setMinimumAccumulatedValue()

template<typename TAccumulatedValue >

void kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::setMinimumAccumulatedValue ( const TAccumulatedValue & minimumValue )

Sets the minimum possible accumulated value.

Parameters

minimumValue The minimum accumulated value.

◆ getMinimumAccumulatedValue()

template<typename TAccumulatedValue >

TAccumulatedValue kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::getMinimumAccumulatedValue ( ) const

Gets the minimum possible accumulated value.

Returns: The minimum accumulated value.

◆ setMaximumAccumulatedValue()

template<typename TAccumulatedValue >

void kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::setMaximumAccumulatedValue ( const TAccumulatedValue & maximumValue )

Sets the maximum possible accumulated value.

Parameters

maximumValue The maximum accumulated value.

◆ getMaximumAccumulatedValue()

template<typename TAccumulatedValue >

TAccumulatedValue kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::getMaximumAccumulatedValue ( ) const

Gets the maximum possible accumulated value.

Returns: The maximum accumulated value.

◆ getBoundType()

template<typename TAccumulatedValue >

ValueAccumulatorBase::BoundType kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::getBoundType ( ) const

Gets the type of the minimum and maximum bounds.

Returns: The bound type.

◆ setBoundType()

template<typename TAccumulatedValue >

void kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::setBoundType ( ValueAccumulatorBase::BoundType boundType )

Sets the type of the minimum and maximum bounds.

Parameters

boundType The type of the bounds.

◆ setIncrementTimeInterval()

template<typename TAccumulatedValue >

void kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::setIncrementTimeInterval ( chrono::milliseconds timePeriod )

Sets the increment period.

Parameters

timePeriod The time between two increments.

◆ getIncrementTimeInterval()

template<typename TAccumulatedValue >

chrono::milliseconds kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::getIncrementTimeInterval ( ) const

Gets the increment frequency.

Returns: The increment frequency.

◆ createPlaybackOverride()

template<typename TAccumulatedValue >

virtual TimelinePlaybackSharedPtr kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::createPlaybackOverride ( TimelinePlaybackContext & context )

protectedvirtual

Timeline::createPlaybackOverride() implementation.

Implements kanzi::Timeline.

◆ calculateContentDuration()

template<typename TAccumulatedValue >

virtual optional< chrono::milliseconds > kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::calculateContentDuration ( )

protectedvirtual

Timeline::calculateContentDuration() implementation.

Reimplemented from kanzi::Timeline.

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

kanzi/ui/node_component/animation/value_accumulator/value_accumulator_timeline.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Examples

Member Typedef Documentation

◆ ValueAccumulatorTimelineSharedPtr

Constructor & Destructor Documentation

◆ ValueAccumulatorTimeline()

Member Function Documentation

◆ create()

◆ getInputObject()

◆ getInputValuePropertyType()

◆ getTargetPropertyType()

◆ getTargetPropertyField()

◆ setMinimumAccumulatedValue()

◆ getMinimumAccumulatedValue()

◆ setMaximumAccumulatedValue()

◆ getMaximumAccumulatedValue()

◆ getBoundType()

◆ setBoundType()

◆ setIncrementTimeInterval()

◆ getIncrementTimeInterval()

◆ createPlaybackOverride()

◆ calculateContentDuration()