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>
Classes | |
class | SetAccumulatedValueBoundariesMessageArguments |
Message arguments for the SetAccumulateValueBoundaries message. More... | |
Public Member Functions | |
float | getIncrementSize () const |
Gets the value of IncrementSizeProperty. | |
string | getIncrementSizeSource () const |
Gets the value of IncrementSizeSourceProperty. | |
float | getMaximumAccumulatedValue () const |
Gets the value of MaximumAccumulatedValueProperty. | |
float | getMinimumAccumulatedValue () const |
Gets the value of MinimumAccumulatedValueProperty. | |
PropertyField | getTargetPropertyField () const |
Gets the value of TargetPropertyFieldProperty. | |
string | getTargetPropertyType () const |
Gets the value of TargetPropertyTypeProperty. | |
void | setIncrementSize (float incrementSize) |
Sets the value of IncrementSizeProperty. | |
void | setIncrementSizeSource (const string &inputPropertyType) |
Sets the value of IncrementSizeSourceProperty. | |
void | setMaximumAccumulatedValue (float maximumAccumulatedValue) |
Sets the value of MaximumAccumulatedValueProperty. | |
void | setMinimumAccumulatedValue (float minimumAccumulatedValue) |
Sets the value of MinimumAccumulatedValueProperty. | |
void | setTargetPropertyField (PropertyField propertyField) |
Sets the value of TargetPropertyFieldProperty. | |
void | setTargetPropertyType (const string &targetPropertyType) |
Sets the value of TargetPropertyTypeProperty. | |
![]() | |
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. | |
![]() | |
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. | |
![]() | |
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 | |
![]() | |
bool | isTypeOf (const Metaclass *objectType) const |
Determines if the type of this object is the given type or derived from it. | |
virtual | ~MetaObject () |
![]() | |
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 FloatValueAccumulatorSharedPtr | create (Domain *domain, string_view name) |
Creates a FloatValueAccumulator. | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
![]() | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
![]() | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
![]() | |
static const Metaclass * | getStaticMetaclass () |
Returns the metaclass of Object class. | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Default implementation that returns empty editor info. | |
![]() | |
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< float > | IncrementSizeProperty |
Sets the size of the increment. | |
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. | |
static PropertyType< float > | MaximumAccumulatedValueProperty |
Sets the maximum possible value of the target field of the target property. | |
static PropertyType< float > | MinimumAccumulatedValueProperty |
Sets the minimum possible value of the target field of the target property. | |
static MessageType< SetAccumulatedValueBoundariesMessageArguments > | SetAccumulatedValueBoundariesMessage |
Send this message to FloatValueAccumulator to set minimum and maximum values of the accumulated value. | |
static PropertyType< PropertyField > | TargetPropertyFieldProperty |
Sets the field of target the target property where you want to accumulate values of the input value property. | |
static PropertyType< string > | TargetPropertyTypeProperty |
Sets the property type of a property where you want to accumulate values of the input value property. | |
![]() | |
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 PropertyType< string > | NameProperty |
Name property specifies the name of node component. | |
Additional Inherited Members | |
![]() | |
enum class | BoundType { Loop , Clamp } |
Sets how a Value Accumulator handles the increments when it reaches the limits of the range of increments. More... | |
![]() | |
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... | |
![]() | |
typedef PropertyStorageContainer::const_iterator | PropertyStorageConstIterator |
typedef vector< PropertyStoragePtr > | PropertyStorageContainer |
typedef PropertyStorageContainer::iterator | PropertyStorageIterator |
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage > | PropertyStoragePtr |
typedef PropertyStorageContainer::reverse_iterator | PropertyStorageReverseIterator |
![]() | |
typedef vector< AppliedStyleEntrySharedPtr > | AppliedStyleContainer |
Applied style container. | |
![]() | |
template<typename TMessageType > | |
static void | nodeComponentMessageHandler (const NodeComponent *nodeComponent, const typename TMessageType::FunctionType &function, typename TMessageType::ArgumentsType &messageArguments) |
Handler function for node component messages. | |
![]() | |
AppliedStyleContainer | m_appliedStyles |
Listing of applied styles applied to this object. | |
Use a FloatValueAccumulator to increase the value of a float property type or a property field over time.
To use a FloatValueAccumulator, set:
The range for the total sum of the increments:
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.
To use a Float Value Accumulator to accumulate values of a property into a field of another property over time:
|
explicitprotected |
Constructor.
domain | Domain. |
name | Name of the node component. |
string kanzi::FloatValueAccumulator::getIncrementSizeSource | ( | ) | const |
Gets the value of IncrementSizeSourceProperty.
Sets the value of IncrementSizeSourceProperty.
float kanzi::FloatValueAccumulator::getIncrementSize | ( | ) | const |
Gets the value of IncrementSizeProperty.
Sets the value of IncrementSizeProperty.
string kanzi::FloatValueAccumulator::getTargetPropertyType | ( | ) | const |
Gets the value of TargetPropertyTypeProperty.
Sets the value of TargetPropertyTypeProperty.
PropertyField kanzi::FloatValueAccumulator::getTargetPropertyField | ( | ) | const |
Gets the value of TargetPropertyFieldProperty.
void kanzi::FloatValueAccumulator::setTargetPropertyField | ( | PropertyField | propertyField | ) |
Sets the value of TargetPropertyFieldProperty.
float kanzi::FloatValueAccumulator::getMinimumAccumulatedValue | ( | ) | const |
Gets the value of MinimumAccumulatedValueProperty.
Sets the value of MinimumAccumulatedValueProperty.
float kanzi::FloatValueAccumulator::getMaximumAccumulatedValue | ( | ) | const |
Gets the value of MaximumAccumulatedValueProperty.
Sets the value of MaximumAccumulatedValueProperty.
|
static |
|
static |
Creates a FloatValueAccumulator.
domain | Domain. |
name | Name of the node component. |
ValueAccumulatorBase::startOverride() implementation.
Implements kanzi::ValueAccumulatorBase.
ValueAccumulatorBase::stopOverride() implementation.
Implements kanzi::ValueAccumulatorBase.
ValueAccumulatorBase::pauseOverride() implementation.
Implements kanzi::ValueAccumulatorBase.
ValueAccumulatorBase::resumeOverride() implementation.
Implements kanzi::ValueAccumulatorBase.
ValueAccumulatorBase::attachOverride() implementation.
Reimplemented from kanzi::ValueAccumulatorBase.
ValueAccumulatorBase::detachOverride() implementation.
Reimplemented from kanzi::ValueAccumulatorBase.
|
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.
|
static |
Sets the size of the increment.
This value can be overridden by setting the IncrementSizePropertyTypeProperty.
|
static |
Sets the property type of a property where you want to accumulate values of the input value property.
|
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.
|
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.
|
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.
|
static |
Send this message to FloatValueAccumulator to set minimum and maximum values of the accumulated value.