Kanzi  3.9.4
Kanzi Engine API
kanzi::ValueAccumulatorBase Class Referenceabstract

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:
[legend]

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

Public Member Functions

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...
 
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 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)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
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 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...
 

Static Public Attributes

static PropertyType< bool > AutoplayProperty
 Sets whether a Value Accumulator starts automatically when it is attached to a node. More...
 
static PropertyType< BoundTypeBoundTypeProperty
 Sets the bound type. More...
 
static PropertyType< int > IncrementTimeIntervalProperty
 Sets the frequency of the Value Accumulator increments, in milliseconds. More...
 
static MessageType< PauseMessageArgumentsPauseMessage
 Pause a Value Accumulator by sending this message to a Value Accumulator. More...
 
static MessageType< ResumeMessageArgumentsResumeMessage
 Resume a Value Accumulator by sending this message to a Value Accumulator. More...
 
static MessageType< StartMessageArgumentsStartMessage
 Start a Value Accumulator by sending this message to a Value Accumulator. More...
 
static MessageType< StopMessageArgumentsStopMessage
 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
 NodeComponent::attachOverride() implementation. More...
 
virtual void detachOverride () override
 NodeComponent::detachOverride() implementation. More...
 
virtual void pauseOverride ()=0
 Pauses a Value Accumulator. More...
 
virtual void resumeOverride ()=0
 Resumes a Value Accumulator. More...
 
virtual void startOverride ()=0
 Starts a Value Accumulator. More...
 
virtual void stopOverride ()=0
 Stops a Value Accumulator. More...
 
 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::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)
 
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 &propertyStorage, PropertyNotificationReason reason)
 
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 validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 

Additional Inherited Members

- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 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

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

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

Enumerator
Loop 

Limits the total accumulated value between the maximim 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
domainDomain.
nameName 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
frequencyInMillisecondsThe 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

◆ detachOverride()

virtual void kanzi::ValueAccumulatorBase::detachOverride ( )
overrideprotectedvirtual

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