Use a FloatValueAccumulator to increase the value of a float property type or a property field over time. More...

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

Inheritance diagram for kanzi::FloatValueAccumulator:

Classes
class	SetAccumulatedValueBoundariesMessageArguments
	Message arguments for the SetAccumulateValueBoundaries message. More...

Public Member Functions
float	getIncrementSize () const
	Gets the value of IncrementSizeProperty. More...

string	getIncrementSizeSource () const
	Gets the value of IncrementSizeSourceProperty. More...

float	getMaximumAccumulatedValue () const
	Gets the value of MaximumAccumulatedValueProperty. More...

float	getMinimumAccumulatedValue () const
	Gets the value of MinimumAccumulatedValueProperty. More...

PropertyField	getTargetPropertyField () const
	Gets the value of TargetPropertyFieldProperty. More...

string	getTargetPropertyType () const
	Gets the value of TargetPropertyTypeProperty. More...

void	setIncrementSize (float incrementSize)
	Sets the value of IncrementSizeProperty. More...

void	setIncrementSizeSource (const string &inputPropertyType)
	Sets the value of IncrementSizeSourceProperty. More...

void	setMaximumAccumulatedValue (float maximumAccumulatedValue)
	Sets the value of MaximumAccumulatedValueProperty. More...

void	setMinimumAccumulatedValue (float minimumAccumulatedValue)
	Sets the value of MinimumAccumulatedValueProperty. More...

void	setTargetPropertyField (PropertyField propertyField)
	Sets the value of TargetPropertyFieldProperty. More...

void	setTargetPropertyType (const string &targetPropertyType)
	Sets the value of TargetPropertyTypeProperty. More...

Public Member Functions inherited from kanzi::ValueAccumulatorBase
BoundType	getBoundType () const
	Gets the value of the BoundTypeProperty. More...

int	getIncrementTimeInterval () const
	Gets the value of the IncrementTimeIntervalProperty. More...

bool	isAutoplay () const
	Gets the value of AutoplayProperty. More...

void	pause ()
	Pauses the Value Accumulator. More...

void	resume ()
	Resumes a paused Value Accumulator. More...

void	setAutoplay (bool enabled)
	Sets the value of AutoplayProperty. More...

void	setBoundType (BoundType boundType)
	Sets the value of the BoundTypeProperty. More...

void	setIncrementTimeInterval (int frequencyInMilliseconds)
	Sets the value of the IncrementTimeIntervalProperty. More...

void	start ()
	Starts a Value Accumulator. More...

void	stop ()
	Stops the Value Accumulator. 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	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 FloatValueAccumulatorSharedPtr	create (Domain *domain, string_view name)
	Creates a FloatValueAccumulator. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

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

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< float >	IncrementSizeProperty
	Sets the size of the increment. More...

static PropertyType< string >	IncrementSizeSourceProperty
	Overrides the IncrementSizeProperty by reading the value from another property type that is set to the node where the value accumulator is attached to. More...

static PropertyType< float >	MaximumAccumulatedValueProperty
	Sets the maximum possible value of the target field of the target property. More...

static PropertyType< float >	MinimumAccumulatedValueProperty
	Sets the minimum possible value of the target field of the target property. More...

static MessageType< SetAccumulatedValueBoundariesMessageArguments >	SetAccumulatedValueBoundariesMessage
	Send this message to FloatValueAccumulator to set minimum and maximum values of the accumulated value. More...

static PropertyType< PropertyField >	TargetPropertyFieldProperty
	Sets the field of target the target property where you want to accumulate values of the input value property. More...

static PropertyType< string >	TargetPropertyTypeProperty
	Sets the property type of a property where you want to accumulate values of the input value property. More...

Static Public Attributes inherited from kanzi::ValueAccumulatorBase
static PropertyType< bool >	AutoplayProperty
	Sets whether a Value Accumulator starts automatically when it is attached to a node. More...

static PropertyType< BoundType >	BoundTypeProperty
	Sets the bound type. More...

static PropertyType< int >	IncrementTimeIntervalProperty
	Sets the frequency of the Value Accumulator increments, in milliseconds. More...

static MessageType< PauseMessageArguments >	PauseMessage
	Pause a Value Accumulator by sending this message to a Value Accumulator. More...

static MessageType< ResumeMessageArguments >	ResumeMessage
	Resume a Value Accumulator by sending this message to a Value Accumulator. More...

static MessageType< StartMessageArguments >	StartMessage
	Start a Value Accumulator by sending this message to a Value Accumulator. More...

static MessageType< StopMessageArguments >	StopMessage
	Stop a Value Accumulator by sending this message to a Value Accumulator. More...

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

Protected Member Functions
virtual void	attachOverride () override
	ValueAccumulatorBase::attachOverride() implementation. More...

virtual void	detachOverride () override
	ValueAccumulatorBase::detachOverride() implementation. More...

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

virtual void	pauseOverride () override
	ValueAccumulatorBase::pauseOverride() implementation. More...

virtual void	resumeOverride () override
	ValueAccumulatorBase::resumeOverride() implementation. More...

virtual void	startOverride () override
	ValueAccumulatorBase::startOverride() implementation. More...

virtual void	stopOverride () override
	ValueAccumulatorBase::stopOverride() implementation. More...

Protected Member Functions inherited from kanzi::ValueAccumulatorBase
	ValueAccumulatorBase (Domain *domain, string_view name)
	Constructor. 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)

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::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 &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
Public Types inherited from kanzi::ValueAccumulatorBase
enum	BoundType { BoundType::Loop, BoundType::Clamp }
	Sets how a Value Accumulator handles the increments when it reaches the limits of the range of increments. More...

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

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

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

Detailed Description

Use a FloatValueAccumulator to increase the value of a float property type or a property field over time.

To use a FloatValueAccumulator, set:

The property type on the node whose value you want to increment. You set this in the TargetPropertyTypeProperty. If the target property type is a compound property type, to set the property field that you want to increment, use the TargetPropertyFieldProperty.
The size of the increment:
- To set increments of fixed size, set the IncrementSizeProperty.
- To define the size of increments with a property, set the IncrementSizeSourceProperty. For example, this way you can change the size of increments during application runtime.
The frequency of increments in milliseconds. You set this in the IncrementTimeIntervalProperty.
The range for the total sum of the increments:
- Set the lowest value with the MinimumAccumulatedValueProperty.
- Set the highest value with the MaximumAccumulatedValueProperty.
Keep in mind that the final value of the target property is the base value of the property plus the total sum of the increments added by a Value Accumulator.
How you want the Value Accumulator to handle the increments when it reaches the limits of the range of increments. You set this in the BoundTypeProperty. When the value of the target property reaches the limits of the range:
- BoundType::Clamp clamps the value
- BoundType::Loop wraps the value

Examples

To use a Float Value Accumulator to accumulate values of a property into a field of another property over time:

    // Create a Float Value Accumulator.
    FloatValueAccumulatorSharedPtr accumulator = FloatValueAccumulator::create(domain, "accumulator");
    // Set the property type whose value you want to use to set the size of the increment.
    accumulator->setIncrementSizeSource(inputValuePropertyType.getName());
    // Set the target property type and its property field whose values you want to increment.
    accumulator->setTargetPropertyType(targetPropertyType.getName());
    accumulator->setTargetPropertyField(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.
    accumulator->setMinimumAccumulatedValue(0.1f);
    accumulator->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.
    accumulator->setBoundType(ValueAccumulatorBase::BoundType::Loop);
    // Add the Value Accumulator to the node.
    node->addNodeComponent(accumulator);

See also: IntValueAccumulator

Since: Kanzi 3.9.2

Constructor & Destructor Documentation

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

explicitprotected

Constructor.

Parameters

domain	Domain.
name	Name of the node component.

Member Function Documentation

string kanzi::FloatValueAccumulator::getIncrementSizeSource ( ) const

Gets the value of IncrementSizeSourceProperty.

See also: setIncrementSizeSource()

void kanzi::FloatValueAccumulator::setIncrementSizeSource ( const string & inputPropertyType )

Sets the value of IncrementSizeSourceProperty.

See also: getIncrementSizeSource()

float kanzi::FloatValueAccumulator::getIncrementSize ( ) const

Gets the value of IncrementSizeProperty.

See also: setIncrementSize()

void kanzi::FloatValueAccumulator::setIncrementSize ( float incrementSize )

Sets the value of IncrementSizeProperty.

See also: getIncrementSize()

string kanzi::FloatValueAccumulator::getTargetPropertyType ( ) const

Gets the value of TargetPropertyTypeProperty.

See also: setTargetPropertyType()

void kanzi::FloatValueAccumulator::setTargetPropertyType ( const string & targetPropertyType )

Sets the value of TargetPropertyTypeProperty.

See also: getTargetPropertyType()

PropertyField kanzi::FloatValueAccumulator::getTargetPropertyField ( ) const

Gets the value of TargetPropertyFieldProperty.

See also: setTargetPropertyField()

void kanzi::FloatValueAccumulator::setTargetPropertyField ( PropertyField propertyField )

Sets the value of TargetPropertyFieldProperty.

See also: getTargetPropertyField()

float kanzi::FloatValueAccumulator::getMinimumAccumulatedValue ( ) const

Gets the value of MinimumAccumulatedValueProperty.

See also: setMinimumAccumulatedValue()

void kanzi::FloatValueAccumulator::setMinimumAccumulatedValue ( float minimumAccumulatedValue )

Sets the value of MinimumAccumulatedValueProperty.

See also: getMinimumAccumulatedValue()

float kanzi::FloatValueAccumulator::getMaximumAccumulatedValue ( ) const

Gets the value of MaximumAccumulatedValueProperty.

See also: setMaximumAccumulatedValue()

void kanzi::FloatValueAccumulator::setMaximumAccumulatedValue ( float maximumAccumulatedValue )

Sets the value of MaximumAccumulatedValueProperty.

See also: getMaximumAccumulatedValue()

static PropertyTypeEditorInfoSharedPtr kanzi::FloatValueAccumulator::makeEditorInfo ( )

static

static FloatValueAccumulatorSharedPtr kanzi::FloatValueAccumulator::create	(	Domain *	domain,
		string_view	name
	)

static

Creates a FloatValueAccumulator.

Parameters

domain	Domain.
name	Name of the node component.

Returns: FloatValueAccumulator.

virtual void kanzi::FloatValueAccumulator::startOverride ( )

overrideprotectedvirtual

ValueAccumulatorBase::startOverride() implementation.

Implements kanzi::ValueAccumulatorBase.

virtual void kanzi::FloatValueAccumulator::stopOverride ( )

overrideprotectedvirtual

ValueAccumulatorBase::stopOverride() implementation.

Implements kanzi::ValueAccumulatorBase.

virtual void kanzi::FloatValueAccumulator::pauseOverride ( )

overrideprotectedvirtual

ValueAccumulatorBase::pauseOverride() implementation.

Implements kanzi::ValueAccumulatorBase.

virtual void kanzi::FloatValueAccumulator::resumeOverride ( )

overrideprotectedvirtual

ValueAccumulatorBase::resumeOverride() implementation.

Implements kanzi::ValueAccumulatorBase.

virtual void kanzi::FloatValueAccumulator::attachOverride ( )

overrideprotectedvirtual

ValueAccumulatorBase::attachOverride() implementation.

Reimplemented from kanzi::ValueAccumulatorBase.

virtual void kanzi::FloatValueAccumulator::detachOverride ( )

overrideprotectedvirtual

ValueAccumulatorBase::detachOverride() implementation.

Reimplemented from kanzi::ValueAccumulatorBase.

Member Data Documentation

PropertyType<string> kanzi::FloatValueAccumulator::IncrementSizeSourceProperty

static

Overrides the IncrementSizeProperty by reading the value from another property type that is set to the node where the value accumulator is attached to.

See also: getIncrementSizeSource(), setIncrementSizeSource()

PropertyType<float> kanzi::FloatValueAccumulator::IncrementSizeProperty

static

Sets the size of the increment.

This value can be overridden by setting the IncrementSizePropertyTypeProperty.

See also: getIncrementSize(), setIncrementSize()

PropertyType<string> kanzi::FloatValueAccumulator::TargetPropertyTypeProperty

static

Sets the property type of a property where you want to accumulate values of the input value property.

See also: getTargetPropertyType(), setTargetPropertyType()

PropertyType<PropertyField> kanzi::FloatValueAccumulator::TargetPropertyFieldProperty

static

Sets the field of target the target property where you want to accumulate values of the input value property.

The default value of this property is PropertyFieldWhole.

See also: getTargetPropertyField(), setTargetPropertyField()

PropertyType<float> kanzi::FloatValueAccumulator::MinimumAccumulatedValueProperty

static

Sets the minimum possible value of the target field of the target property.

This property is only used if clamping of accumulated value is enabled.

See also: getMinimumAccumulatedValue(), setMinimumAccumulatedValue()

PropertyType<float> kanzi::FloatValueAccumulator::MaximumAccumulatedValueProperty

static

Sets the maximum possible value of the target field of the target property.

This property is only used if clamping of accumulated value is enabled.

See also: getMaximumAccumulatedValue(), setMaximumAccumulatedValue()

MessageType<SetAccumulatedValueBoundariesMessageArguments> kanzi::FloatValueAccumulator::SetAccumulatedValueBoundariesMessage

static

Send this message to FloatValueAccumulator to set minimum and maximum values of the accumulated value.

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

kanzi/ui/node_component/animation/float_value_accumulator.hpp

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Examples

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation