Kanzi 3.9.10
PropertyAnimationTimeline Class Reference

The Kanzi animation system consists of animations, which define how to animate properties, and timelines, which map animations to time and to the objects that you want to animate. More...

Inheritance diagram for PropertyAnimationTimeline:
[legend]

Static Public Member Functions

static ObjectRef< Timelinecreate (Domain domain, String name)
 Creates new PropertyAnimationTimeline instance and returns it.
 
static ObjectRef< PropertyAnimationTimelinecreate (Domain domain, String objectPath, PropertyType<?> propertyType, AbstractAnimation animation)
 Creates a PropertyAnimationTimeline instance and returns it.
 

Static Public Attributes

static final Metaclass metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from Timeline
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 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< TTypetryCreateObjectRef (Class< TType > clazz)
 Tries to create an owning ObjectRef instance to this KanziObject.
 
- Public Attributes inherited from TimelineMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Animation.Timeline")
 Metaclass for Timeline.
 
- Public Attributes inherited from PropertyAnimationTimelineMetadata
AbstractMetaclass metaclass
 Metaclass for PropertyAnimationTimeline.
 

Detailed Description

The Kanzi animation system consists of animations, which define how to animate properties, and timelines, which map animations to time and to the objects that you want to animate.

Member Function Documentation

◆ create() [1/2]

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

Creates new PropertyAnimationTimeline instance and returns it.

Parameters
domainDomain.
nameName of PropertyAnimationTimeline.
Returns
New PropertyAnimationTimeline instance.

◆ create() [2/2]

static ObjectRef< PropertyAnimationTimeline > create ( Domain domain,
String objectPath,
PropertyType<?> propertyType,
AbstractAnimation animation )
static

Creates a PropertyAnimationTimeline instance and returns it.

Parameters
domainDomain.
objectPathRelative path to the object to which to apply the timeline. This path is resolved when creating the playback from the timeline.
propertyTypeThe property type to which to apply the timeline animation.
animationThe animation to apply to the target property.
Returns
New PropertyAnimationTimeline instance.

Member Data Documentation

◆ metaclass

final Metaclass metaclass
static
Initial value:
=
com.rightware.kanzi.metadata.PropertyAnimationTimelineMetadata.metaclass

The Metaclass for the class.