PropertyTargetEasingInterpolator Class Reference
Use a Property Target Easing Interpolator when you want to create a smooth transition between the current value of a property and a value that you set dynamically. More...
Inheritance diagram for PropertyTargetEasingInterpolator:
Static Public Member Functions | |
| static ObjectRef< PropertyTargetEasingInterpolator > | create (Domain domain, String name) |
| Creates an instance of PropertyTargetEasingInterpolator. | |
Static Public Attributes | |
| static final Metaclass | metaclass |
| The Metaclass for the class. | |
 Static Public Attributes inherited from NodeComponent | |
| static final Metaclass | metaclass |
| The Metaclass for the class. | |
| 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. | |
| Node | getNode () |
| Returns the node the node component is attached to or null if node component is not attached to a node. | |
| 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. | |
| boolean | isAttached () |
| Indicates whether node component is attached to a node. | |
| boolean | isAttaching () |
| Indicates whether node component is in the process of attaching to a node. | |
| boolean | isAttachingOrAttached () |
| Indicates whether node component is in the process of attaching to a node or already attached. | |
| boolean | isDetached () |
| Indicates whether node component is detached from any node. | |
| boolean | isDetaching () |
| Indicates whether node component currently detaching from the node. | |
| boolean | isDetachingOrDetached () |
| Indicates whether node component is in the process of detaching from the node or already detached. | |
| void | setName (String value) |
| Sets the value of #NameProperty. | |
| Public Member Functions inherited from KanziObject | |
| boolean | equals (Object object) |
| Domain | getDomain () |
| Returns the domain the object belongs to. | |
| Metaclass | getDynamicMetaclass () |
| Returns the metaclass of the dynamic type of the object. | |
| long | getNative () |
| Gets a pointer to the backing C++ instance. | |
| 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. | |
| TDataType | getProperty (PropertyType< TDataType > propertyType) |
| Returns the current value of a property type. | |
| int | hashCode () |
| boolean | hasValue (PropertyType< TDataType > propertyType) |
| Evaluates whether there are any inputs into the property value. | |
| boolean | isStale () |
| Test if the object is stale i.e. | |
| void | removeLocalValue (PropertyType< TDataType > propertyType) |
| Removes the local value associated with the property. | |
| void | setProperty (PropertyType< TDataType > propertyType, TDataType value) |
| Sets the local value of a property type. | |
| ObjectRef< TType > | tryCreateObjectRef (Class< TType > clazz) |
| Tries to create an owning ObjectRef instance to this KanziObject. | |
| Public Attributes inherited from NodeComponentMetadata | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.NodeComponent") |
| Metaclass for NodeComponent. | |
| DynamicPropertyType< String > | NameProperty |
| Name. | |
| Public Attributes inherited from PropertyTargetEasingInterpolatorMetadata | |
| DynamicMessageType< NodeComponentMetadata.NodeComponentSourceMessageArguments > | CompletedMessage |
| Occurs when Property Target Easing Interpolator completes its interpolation. | |
| DynamicPropertyType< PropertyTargetEasingInterpolatorEnums.EasingFunction > | EasingFunctionProperty |
| Sets the easing function that defines the curve of the interpolation. | |
| DynamicPropertyType< AnimationEasingMode > | EasingModeProperty |
| Sets how to apply the easing function to the interpolation. | |
| DynamicPropertyType< Boolean > | EnabledProperty |
| Sets whether the Property Target Easing Interpolator interpolates the value of the Interpolated Property Type. | |
| DynamicPropertyType< PropertyField > | InterpolatedPropertyFieldProperty |
| The property field of the Interpolated Property Type you want to interpolate from its previous value to a new value using this Property Target Easing Interpolator. | |
| DynamicPropertyType< String > | InterpolatedPropertyTypeProperty |
| The property type you want to interpolate from its previous value to a new value using this Property Target Easing Interpolator. | |
| DynamicPropertyType< Integer > | InterpolationDurationProperty |
| Sets the duration of the interpolation in milliseconds. | |
| DynamicPropertyType< PropertyTargetEasingTimelineEnums.InterpolationIfInterruptedMode > | InterpolationIfInterruptedProperty |
| Sets what happens if a new value is set to the interpolated property before interpolation to its previous value completes: | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.PropertyTargetEasingInterpolator") |
| Metaclass for PropertyTargetEasingInterpolator. | |
| DynamicPropertyType< Boolean > | NotifyInterpolationCompletedProperty |
| Sets whether the Property Target Easing Interpolator dispatches a Completed message every time it completes interpolation. | |
| DynamicMessageType< PropertyTargetEasingInterpolatorMetadata.SetEnabledMessageArguments > | SetEnabledMessage |
| Enables or disables the interpolation performed by Property Target Easing Interpolator. | |
| Protected Member Functions inherited from NodeComponent | |
| NodeComponent (Domain domain, long handle, Metaclass metaclass) | |
| Wraps a given native Node Component. | |
| 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 com.rightware.kanzi.NodeComponent#addNodeComponentMessageHandler function. | |
| 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. | |
Detailed Description
Use a Property Target Easing Interpolator when you want to create a smooth transition between the current value of a property and a value that you set dynamically.
In a Property Target Easing Interpolator you can set the easing curve, easing mode, and the duration of the transition. When you set a property value without a Property Target Easing Interpolator, Kanzi applies the value to that property immediately. For example, when you use the KanziObject.setProperty() function, Kanzi applies the value immediately.
Member Function Documentation
◆ create()
|
static |
Creates an instance of PropertyTargetEasingInterpolator.
- Parameters
-
domain The UI domain to which the PropertyTargetEasingInterpolator belongs. name The name of the PropertyTargetEasingInterpolator.
- Returns
- The created PropertyTargetEasingInterpolator.