Use a FloatValueAccumulator to increase the value of a float property type or a property field over time. More...
Static Public Member Functions | |
static ObjectRef< FloatValueAccumulator > | create (Domain domain, String name) |
Creates a FloatValueAccumulator. More... | |
Static Public Attributes | |
static final Metaclass | metaclass |
The Metaclass for the class. More... | |
Static Public Attributes inherited from ValueAccumulator | |
static final Metaclass | metaclass |
The Metaclass for the class. More... | |
Static Public Attributes inherited from NodeComponent | |
static final Metaclass | metaclass |
The Metaclass for the class. More... | |
Static Public Attributes inherited from KanziObject | |
static final Metaclass | metaclass = new AbstractMetaclass("Kanzi.Object") |
The Metaclass for the class. | |
Additional Inherited Members | |
Public Member Functions inherited from NodeComponent | |
void | close () |
Close the object, and release native resources. | |
String | getName () |
Gets the value of NameProperty. More... | |
Node | getNode () |
Returns the node the node component is attached to or null if node component is not attached to a node. More... | |
NodeComponentState | getState () |
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... | |
boolean | isAttached () |
Indicates whether node component is attached to a node. More... | |
boolean | isAttaching () |
Indicates whether node component is in the process of attaching to a node. More... | |
boolean | isAttachingOrAttached () |
Indicates whether node component is in the process of attaching to a node or already attached. More... | |
boolean | isDetached () |
Indicates whether node component is detached from any node. More... | |
boolean | isDetaching () |
Indicates whether node component currently detaching from the node. More... | |
boolean | isDetachingOrDetached () |
Indicates whether node component is in the process of detaching from the node or already detached. More... | |
void | setName (String value) |
Sets the value of NameProperty. More... | |
Public Member Functions inherited from KanziObject | |
boolean | equals (Object object) |
Domain | getDomain () |
Returns the domain the object belongs to. More... | |
Metaclass | getDynamicMetaclass () |
Returns the metaclass of the dynamic type of the object. More... | |
long | getNative () |
Gets a pointer to the backing C++ instance. More... | |
TDataType | getOptionalProperty (PropertyType< TDataType > propertyType) |
Returns the current value of a property type, but does not use the default value if there are no inputs to the property value. More... | |
TDataType | getProperty (PropertyType< TDataType > propertyType) |
Returns the current value of a property type. More... | |
int | hashCode () |
boolean | hasValue (PropertyType< TDataType > propertyType) |
Evaluates whether there are any inputs into the property value. More... | |
boolean | isStale () |
Test if the object is stale i.e. More... | |
void | removeLocalValue (PropertyType< TDataType > propertyType) |
Removes the local value associated with the property. More... | |
void | setProperty (PropertyType< TDataType > propertyType, TDataType value) |
Sets the local value of a property type. More... | |
ObjectRef< TType > | tryCreateObjectRef (Class< TType > clazz) |
Tries to create an owning ObjectRef instance to this KanziObject. More... | |
Public Attributes inherited from NodeComponentMetadata | |
AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.NodeComponent") |
Metaclass for NodeComponent. | |
DynamicPropertyType< String > | NameProperty |
Name. More... | |
Public Attributes inherited from ValueAccumulatorMetadata | |
DynamicPropertyType< Boolean > | AutoplayProperty |
Sets whether the Value Accumulator starts automatically when it is attached to the node. More... | |
DynamicPropertyType< ValueAccumulatorBaseEnums.BoundType > | BoundTypeProperty |
Sets how the Value Accumulator limits the total accumulated value between the minimum and maximum value boundaries. More... | |
DynamicPropertyType< Integer > | IncrementTimeIntervalProperty |
Sets the frequency of increments in milliseconds. More... | |
AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.ValueAccumulator") |
Metaclass for ValueAccumulator. | |
DynamicMessageType< ValueAccumulatorMetadata.PauseMessageArguments > | PauseMessage |
Pauses the animation applied by a Value Accumulator to its target property value. More... | |
DynamicMessageType< ValueAccumulatorMetadata.ResumeMessageArguments > | ResumeMessage |
Resumes the paused animation applied by a Value Accumulator to its target property value. More... | |
DynamicMessageType< ValueAccumulatorMetadata.StartMessageArguments > | StartMessage |
Starts the animation applied by a Value Accumulator to its target property value. More... | |
DynamicMessageType< ValueAccumulatorMetadata.StopMessageArguments > | StopMessage |
Stops the animation applied by a Value Accumulator to its target property value. More... | |
Public Attributes inherited from FloatValueAccumulatorMetadata | |
DynamicPropertyType< Float > | IncrementSizeProperty |
The size of the increments of this Float Value Accumulator. More... | |
DynamicPropertyType< String > | IncrementSizeSourceProperty |
The property type set on this node that determines the increment size of this Float Value Accumulator. More... | |
DynamicPropertyType< Float > | MaximumAccumulatedValueProperty |
The maximum total accumulated float value. More... | |
AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.FloatValueAccumulator") |
Metaclass for FloatValueAccumulator. | |
DynamicPropertyType< Float > | MinimumAccumulatedValueProperty |
The minimum total accumulated float value. More... | |
DynamicMessageType< FloatValueAccumulatorMetadata.SetAccumulatedValueBoundariesMessageArguments > | SetAccumulatedValueBoundariesMessage |
Sets the minimum and maximum total accumulated float value. More... | |
DynamicPropertyType< PropertyField > | TargetPropertyFieldProperty |
The field of the target property on a node which where the values of the input property are accumulated. More... | |
DynamicPropertyType< String > | TargetPropertyTypeProperty |
The property type on this node that this Float Value Accumulator updates. More... | |
Protected Member Functions inherited from NodeComponent | |
NodeComponent (Domain domain, long handle, Metaclass metaclass) | |
Wraps a given native Node Component. More... | |
void | attachOverride () |
Called when the Trigger is attached to a node. | |
void | detachOverride () |
Called when a Trigger is detached from a Node. | |
void | initialize () |
Initializes the Node Component. | |
void | removeNodeComponentMessageFilter (Node.MessageSubscriptionToken token) |
Removes message handler added via NodeComponent#addNodeComponentMessageHandler function. More... | |
Static Protected Member Functions inherited from NodeComponent | |
static< Derived extends NodeComponent > ObjectRef< Derived > | createDerived (Domain domain, String name, Metaclass metaclass) |
Creates a derived class instance. More... | |
Use a FloatValueAccumulator to increase the value of a float property type or a property field over time.
|
static |
Creates a FloatValueAccumulator.
domain | Domain. |
name | Name of the node component. |