ValueAccumulatorBase is the base class for the Value Accumulator implementations for different data types. More...

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

Inheritance diagram for kanzi::ValueAccumulatorBase:

Classes
class	PauseMessageArguments
	Message arguments for the Pause message. More...

class	ResumeMessageArguments
	Message arguments for the Resume message. More...

class	StartMessageArguments
	Message arguments for the Start message. More...

class	StopMessageArguments
	Message arguments for the Stop message. More...

Public Types
enum class	BoundType { Loop , 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
	Legacy name for NodeComponentTargetMessageArguments.

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

Public Member Functions
BoundType	getBoundType () const
	Gets the value of the BoundTypeProperty.

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

bool	isAutoplay () const
	Gets the value of AutoplayProperty.

void	pause ()
	Pauses the Value Accumulator.

void	resume ()
	Resumes a paused Value Accumulator.

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

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

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

void	start ()
	Starts a Value Accumulator.

void	stop ()
	Stops the Value Accumulator.

Public Member Functions inherited from kanzi::NodeComponent
void	attach (NodeWeakPtr node)
	Attaches node component to node.

void	detach ()
	Detaches node component from the node it was attached to.

string	getName () const
	Gets the name of node component.

NodeSharedPtr	getNode () const
	Returns the node the node component is attached to or null pointer if node component is not attached to a node.

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.

bool	isAttached () const
	Indicates whether node component is attached to a node.

bool	isAttaching () const
	Indicates whether node component is in the process of attaching to a node.

bool	isAttachingOrAttached () const
	Indicates whether node component is in the process of attaching to a node or already attached.

bool	isDetached () const
	Indicates whether node component is detached from any node.

bool	isDetaching () const
	Indicates whether node component currently detaching from the node.

bool	isDetachingOrDetached () const
	Indicates whether node component is in the process of detaching from the node or already detached.

void	setName (string_view name)
	Sets the name of node component.

	~NodeComponent () override
	Destructor.

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object.

void	applyObjectStyles ()
	Apply all styles for an object node.

Domain *	getDomain () const
	Returns the domain the object belongs to.

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object.

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain.

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object.

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object.

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object.

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object.

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it.

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers.

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container.

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object.

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object.

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers.

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type.

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers.

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property.

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property.

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value.

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications.

	PropertyObject ()

void	removeKzbProperties ()
	Remove all KZB properties.

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set.

template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property.

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type.

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

virtual	~PropertyObject ()

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

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.

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.

Static Public Attributes
static PropertyType< bool >	AutoplayProperty
	Sets whether a Value Accumulator starts automatically when it is attached to a node.

static PropertyType< BoundType >	BoundTypeProperty
	Sets the bound type.

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

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

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

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

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

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

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

virtual void	detachOverride () override
	NodeComponent::detachOverride() implementation.

virtual void	pauseOverride ()=0
	Pauses a Value Accumulator.

virtual void	resumeOverride ()=0
	Resumes a Value Accumulator.

virtual void	startOverride ()=0
	Starts a Value Accumulator.

virtual void	stopOverride ()=0
	Stops a Value Accumulator.

	ValueAccumulatorBase (Domain *domain, string_view name)
	Constructor.

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.

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.

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.

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.

	NodeComponent (Domain *domain, string_view name)
	Constructor.

void	removeNodeComponentMessageFilter (Node::MessageSubscriptionToken subscriptionToken)
	Removes message handler added via addNodeComponentMessageHandler function.

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.

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.

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

Detailed Description

ValueAccumulatorBase is the base class for the Value Accumulator implementations for different data types.

It defines the common property and message types for different Value Accumulators.

See also: IntValueAccumulator, FloatValueAccumulator

Since: Kanzi 3.9.2

Member Enumeration Documentation

◆ BoundType

enum class kanzi::ValueAccumulatorBase::BoundType

strong

Sets how a Value Accumulator handles the increments when it reaches the limits of the range of increments.

For an IntValueAccumulator you can set the boundaries with the IntValueAccumulator::MinimumAccumulatedValueProperty and IntValueAccumulator::MaximumAccumulatedValueProperty.
For an FloatValueAccumulator you can set the boundaries with the FloatValueAccumulator::MinimumAccumulatedValueProperty and FloatValueAccumulator::MaximumAccumulatedValueProperty.

Enumerator
Loop	Limits the total accumulated value between the maximum and minimum values by wrapping the value.
Clamp	Limits the total accumulated value between the maximum and minimum values by clamping the value.

Constructor & Destructor Documentation

◆ ValueAccumulatorBase()

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

explicitprotected

Constructor.

Parameters

domain	Domain.
name	Name of the ValueAccumulator.

Member Function Documentation

◆ isAutoplay()

bool kanzi::ValueAccumulatorBase::isAutoplay ( ) const

Gets the value of AutoplayProperty.

See also: setAutoplay()

◆ setAutoplay()

void kanzi::ValueAccumulatorBase::setAutoplay ( bool enabled )

Sets the value of AutoplayProperty.

See also: isAutoplay()

◆ getBoundType()

BoundType kanzi::ValueAccumulatorBase::getBoundType ( ) const

Gets the value of the BoundTypeProperty.

See also: setBoundType()

◆ setBoundType()

void kanzi::ValueAccumulatorBase::setBoundType ( BoundType boundType )

Sets the value of the BoundTypeProperty.

See also: getBoundType()

◆ getIncrementTimeInterval()

int kanzi::ValueAccumulatorBase::getIncrementTimeInterval ( ) const

Gets the value of the IncrementTimeIntervalProperty.

Returns: The frequency in milliseconds at which the Value Accumulator adds the input property to the target property.

See also: setIncrementInterval()

◆ setIncrementTimeInterval()

void kanzi::ValueAccumulatorBase::setIncrementTimeInterval ( int frequencyInMilliseconds )

Sets the value of the IncrementTimeIntervalProperty.

Parameters

frequencyInMilliseconds The frequency in milliseconds at which the Value Accumulator adds the input property to the target property.

See also: getIncrementInterval()

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ValueAccumulatorBase::makeEditorInfo ( )

static

◆ start()

void kanzi::ValueAccumulatorBase::start ( )

Starts a Value Accumulator.

When a Value Accumulator starts, it resets the accumulated value to zero and starts incrementing the value. ValueAccumulatorBase calls this function when it receives a StartMessage.

◆ stop()

void kanzi::ValueAccumulatorBase::stop ( )

Stops the Value Accumulator.

When a Value Accumulator stops, it resets the accumulated value to zero and stops incrementing the value. ValueAccumulatorBase calls this function when it receives a StopMessage.

◆ pause()

void kanzi::ValueAccumulatorBase::pause ( )

Pauses the Value Accumulator.

The paused Value Accumulator continues applying the value that has been accumulated so far, but stops incrementing it. ValueAccumulatorBase calls this function when it receives a PauseMessage.

◆ resume()

void kanzi::ValueAccumulatorBase::resume ( )

Resumes a paused Value Accumulator.

The resumed Value Accumulator continues applying and incrementing the accumulated value. ValueAccumulatorBase calls this function when it receives a ResumeMessage.

◆ attachOverride()

virtual void kanzi::ValueAccumulatorBase::attachOverride ( )

overrideprotectedvirtual

NodeComponent::attachOverride() implementation.

Reimplemented from kanzi::NodeComponent.

Reimplemented in kanzi::FloatValueAccumulator, and kanzi::IntValueAccumulator.

◆ detachOverride()

virtual void kanzi::ValueAccumulatorBase::detachOverride ( )

overrideprotectedvirtual

NodeComponent::detachOverride() implementation.

Reimplemented from kanzi::NodeComponent.

Reimplemented in kanzi::FloatValueAccumulator, and kanzi::IntValueAccumulator.

◆ startOverride()

virtual void kanzi::ValueAccumulatorBase::startOverride ( )

protectedpure virtual

Starts a Value Accumulator.

A derived Value Accumulator class must implement this function and start the value accumulation there.

Implemented in kanzi::FloatValueAccumulator, and kanzi::IntValueAccumulator.

◆ stopOverride()

virtual void kanzi::ValueAccumulatorBase::stopOverride ( )

protectedpure virtual

Stops a Value Accumulator.

A derived Value Accumulator class must implement this function and stop the value accumulation there.

Implemented in kanzi::FloatValueAccumulator, and kanzi::IntValueAccumulator.

◆ pauseOverride()

virtual void kanzi::ValueAccumulatorBase::pauseOverride ( )

protectedpure virtual

Pauses a Value Accumulator.

A derived Value Accumulator class must implement this function and pause the value accumulation there.

Implemented in kanzi::FloatValueAccumulator, and kanzi::IntValueAccumulator.

◆ resumeOverride()

virtual void kanzi::ValueAccumulatorBase::resumeOverride ( )

protectedpure virtual

Resumes a Value Accumulator.

A derived Value Accumulator class must implement this function and resume the value accumulation there.

Implemented in kanzi::FloatValueAccumulator, and kanzi::IntValueAccumulator.

Member Data Documentation

◆ AutoplayProperty

PropertyType<bool> kanzi::ValueAccumulatorBase::AutoplayProperty

static

Sets whether a Value Accumulator starts automatically when it is attached to a node.

See also: isAutoplay(), setAutoplay()

◆ BoundTypeProperty

PropertyType<BoundType> kanzi::ValueAccumulatorBase::BoundTypeProperty

static

Sets the bound type.

The default is Loop.

See also: setBoundType(), getBoundType()

◆ IncrementTimeIntervalProperty

PropertyType<int> kanzi::ValueAccumulatorBase::IncrementTimeIntervalProperty

static

Sets the frequency of the Value Accumulator increments, in milliseconds.

See also: getIncrementInterval(), setIncrementInterval()

◆ StartMessage

MessageType<StartMessageArguments> kanzi::ValueAccumulatorBase::StartMessage

static

Start a Value Accumulator by sending this message to a Value Accumulator.

◆ StopMessage

MessageType<StopMessageArguments> kanzi::ValueAccumulatorBase::StopMessage

static

Stop a Value Accumulator by sending this message to a Value Accumulator.

◆ PauseMessage

MessageType<PauseMessageArguments> kanzi::ValueAccumulatorBase::PauseMessage

static

Pause a Value Accumulator by sending this message to a Value Accumulator.

◆ ResumeMessage

MessageType<ResumeMessageArguments> kanzi::ValueAccumulatorBase::ResumeMessage

static

Resume a Value Accumulator by sending this message to a Value Accumulator.

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

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ BoundType

Constructor & Destructor Documentation

◆ ValueAccumulatorBase()

Member Function Documentation

◆ isAutoplay()

◆ setAutoplay()

◆ getBoundType()

◆ setBoundType()

◆ getIncrementTimeInterval()

◆ setIncrementTimeInterval()

◆ makeEditorInfo()

◆ start()

◆ stop()

◆ pause()

◆ resume()

◆ attachOverride()

◆ detachOverride()

◆ startOverride()

◆ stopOverride()

◆ pauseOverride()

◆ resumeOverride()

Member Data Documentation

◆ AutoplayProperty

◆ BoundTypeProperty

◆ IncrementTimeIntervalProperty

◆ StartMessage

◆ StopMessage

◆ PauseMessage

◆ ResumeMessage