Kanzi  3.9.7
Kanzi Engine API
kanzi::ValueAccumulatorTimeline< TAccumulatedValue > Class Template Reference

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. More...
 
- 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< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 

Public Member Functions

ValueAccumulatorBase::BoundType getBoundType () const
 Gets the type of the minimum and maximum bounds. More...
 
chrono::milliseconds getIncrementTimeInterval () const
 Gets the increment frequency. More...
 
weak_ptr< ObjectgetInputObject () const
 Gets the object with the increment property. More...
 
AbstractPropertyType getInputValuePropertyType () const
 Gets the type of an input property whose values you want to accumulate. More...
 
TAccumulatedValue getMaximumAccumulatedValue () const
 Gets the maximum possible accumulated value. More...
 
TAccumulatedValue getMinimumAccumulatedValue () const
 Gets the minimum possible accumulated value. More...
 
PropertyField getTargetPropertyField () const
 Gets the field of a target property where you want to accumulate values. More...
 
AbstractPropertyType getTargetPropertyType () const
 Gets the type of a target property in a field of which you want to accumulate values. More...
 
void setBoundType (ValueAccumulatorBase::BoundType boundType)
 Sets the type of the minimum and maximum bounds. More...
 
void setIncrementTimeInterval (chrono::milliseconds timePeriod)
 Sets the increment period. More...
 
void setMaximumAccumulatedValue (const TAccumulatedValue &maximumValue)
 Sets the maximum possible accumulated value. More...
 
void setMinimumAccumulatedValue (const TAccumulatedValue &minimumValue)
 Sets the minimum possible accumulated value. More...
 
- Public Member Functions inherited from kanzi::Timeline
TimeInterval calculateClipInterval ()
 Calculates clip interval of timeline. More...
 
optional< chrono::milliseconds > calculateDuration ()
 Calculates the duration of the timeline. More...
 
unsigned int calculateIterationCount ()
 Calculates number of iterations in timeline. More...
 
optional< chrono::milliseconds > calculateIterationDuration ()
 Calculates iteration duration. More...
 
TimelinePlaybackSharedPtr createPlayback (TimelinePlaybackContext &context)
 Creates playback for timeline. More...
 
optional< chrono::milliseconds > getClipDuration () const
 Gets the clip duration of the timeline (in milliseconds). More...
 
chrono::milliseconds getClipStartTime () const
 Gets the clip start time of the timeline (in milliseconds). More...
 
DirectionBehavior getDirectionBehavior () const
 Gets the direction behavior of a timeline. More...
 
float getDurationScale () const
 Gets the duration scale of timeline. More...
 
float getMinimumDurationScale () const
 Gets minimum duration scale. More...
 
unsigned int getRepeatCount () const
 Gets the repeat count of the timeline (zero indicates infinite repeats). More...
 
chrono::milliseconds getStartTime () const
 Gets the start time of the timeline (in milliseconds). More...
 
void setClipDuration (optional< chrono::milliseconds > duration)
 Sets the clip duration of the timeline (in milliseconds). More...
 
void setClipStartTime (chrono::milliseconds clipStartTime)
 Sets the clip start time of the timeline (in milliseconds). More...
 
void setDirectionBehavior (DirectionBehavior directionBehavior)
 Sets the direction behavior of a timeline. More...
 
void setDurationScale (float scale)
 Sets the duration scale of timeline. More...
 
void setRepeatCount (unsigned int repeatCount)
 Sets the repeat count of the timeline (zero indicates infinite repeats). More...
 
void setStartTime (chrono::milliseconds startTime)
 Gets the start time of the timeline (in milliseconds). 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...
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain. More...
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () 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 addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 Adds a property modifier without notifying handlers. More...
 
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
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications. More...
 
 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)
 
KZ_DEPRECATED void validatePropertyModifiers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
void validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
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. 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

virtual optional< chrono::milliseconds > calculateContentDuration () KZ_OVERRIDE
 Timeline::calculateContentDuration() implementation. More...
 
virtual TimelinePlaybackSharedPtr createPlaybackOverride (TimelinePlaybackContext &context) KZ_OVERRIDE
 Timeline::createPlaybackOverride() implementation. More...
 
 ValueAccumulatorTimeline (Domain *domain, weak_ptr< Object > inputObject, const PropertyType< TAccumulatedValue > &inputValuePropertyType, const AbstractPropertyType &targetPropertyType, PropertyField targetPropertyField)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::Timeline
virtual void loadOverride (Domain *domain, string_view name, KzbFile &kzbFile, KzbMemoryParser &parser)
 Loads timeline data from KZB. More...
 
 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
void initialize ()
 
 MetaObject ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value. More...
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (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. More...
 
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::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (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...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the top-level value source for a given property descriptor. More...
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
 Notifies all property handlers on a property storage. More...
 
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 validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers without notifying handlers. More...
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers and notifies handlers. More...
 

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

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

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

Shared pointer for the timeline.

Constructor & Destructor Documentation

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
domainDomain.
inputObjectObject with the increment size property.
inputValuePropertyTypeType of an input property whose values you want to accumulate.
targetPropertyTypeType of a target property in the field of which you want to accumulate values.
targetPropertyFieldField of target property where you want to accumulate values.

Member Function Documentation

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
domainDomain.
inputObjectObject with the increment size property.
inputValuePropertyTypeType of an input property whose values you want to accumulate.
targetPropertyTypeType of a target property in the field of which you want to accumulate values.
targetPropertyFieldField of target property where you want to accumulate values.
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.
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.
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.
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.
template<typename TAccumulatedValue >
void kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::setMinimumAccumulatedValue ( const TAccumulatedValue &  minimumValue)

Sets the minimum possible accumulated value.

Parameters
minimumValueThe minimum accumulated value.
template<typename TAccumulatedValue >
TAccumulatedValue kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::getMinimumAccumulatedValue ( ) const

Gets the minimum possible accumulated value.

Returns
The minimum accumulated value.
template<typename TAccumulatedValue >
void kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::setMaximumAccumulatedValue ( const TAccumulatedValue &  maximumValue)

Sets the maximum possible accumulated value.

Parameters
maximumValueThe maximum accumulated value.
template<typename TAccumulatedValue >
TAccumulatedValue kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::getMaximumAccumulatedValue ( ) const

Gets the maximum possible accumulated value.

Returns
The maximum accumulated value.
template<typename TAccumulatedValue >
ValueAccumulatorBase::BoundType kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::getBoundType ( ) const

Gets the type of the minimum and maximum bounds.

Returns
The bound type.
template<typename TAccumulatedValue >
void kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::setBoundType ( ValueAccumulatorBase::BoundType  boundType)

Sets the type of the minimum and maximum bounds.

Parameters
boundTypeThe type of the bounds.
template<typename TAccumulatedValue >
void kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::setIncrementTimeInterval ( chrono::milliseconds  timePeriod)

Sets the increment period.

Parameters
timePeriodThe time between two increments.
template<typename TAccumulatedValue >
chrono::milliseconds kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::getIncrementTimeInterval ( ) const

Gets the increment frequency.

Returns
The increment frequency.
template<typename TAccumulatedValue >
virtual TimelinePlaybackSharedPtr kanzi::ValueAccumulatorTimeline< TAccumulatedValue >::createPlaybackOverride ( TimelinePlaybackContext context)
protectedvirtual
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: