Use a Property Target Interpolator when you want to dynamically set the target value of a property and want to interpolate the current value to the target value over time. More...

Inheritance diagram for PropertyTargetInterpolator:

[legend]

Static Public Member Functions
static ObjectRef< PropertyTargetInterpolator >	create (Domain domain, String name)
	Creates a Property Target Interpolator.

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	setFlagKeepDuringPatching (PropertyType< TDataType > propertyType)
	Sets the flag to indicate that the property was loaded from KZB.

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 PropertyTargetInterpolatorMetadata
DynamicPropertyType< Float >	AccelerationProperty
	Acceleration coefficient of property interpolation.

DynamicMessageType< PropertyTargetInterpolatorMetadata.CompletedMessageArguments >	CompletedMessage
	Occurs when property target interpolator completes interpolation.

DynamicPropertyType< Float >	DragProperty
	Drag coefficient of property interpolation.

DynamicPropertyType< KzuPropertyBinaryTargetAttribute >	InterpolatedPropertyFieldProperty
	The field of a property on a node which is interpolated from its previous value to new one by property target interpolator.

DynamicPropertyType< String >	InterpolatedPropertyTypeProperty
	The property type of a property on a node which is interpolated from its previous value to new one by property target interpolator.

AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.PropertyTargetInterpolator")
	Metaclass for PropertyTargetInterpolator.

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 Interpolator when you want to dynamically set the target value of a property and want to interpolate the current value to the target value over time.

With a Property Target Interpolator you can automatically animate the change of a property value to achieve a smooth transition. Without a Property Target Interpolator Kanzi immediately applies a new value to a property. For example, when you use the KanziObject.setProperty() function, Kanzi immediately applies a new value.

Member Function Documentation

◆ create()

static ObjectRef< PropertyTargetInterpolator > create	(	Domain	domain,
		String	name )

static

Creates a Property Target Interpolator.

Parameters

domain	Domain.
name	Name of the Property Target Interpolator.

Returns: The Property Target Interpolator.

Member Data Documentation

◆ metaclass

final Metaclass metaclass

static

Initial value:

=

com.rightware.kanzi.metadata.PropertyTargetInterpolatorMetadata.metaclass

The Metaclass for the class.

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ create()

Member Data Documentation

◆ metaclass