Struct PropertyDrivenAnimationPlayer

pub struct PropertyDrivenAnimationPlayer(/* private fields */);

Use Property Driven Animation Player when you want to use a property type to control a keyframe animation. Property Driven Animation Player applies an animation with the time taken from a specific property in the node, to which you attach the player, every time that property changes.

Property Driven Animation Player applies the timeline specified in the TimelineProperty property of the player. Kanzi resolves paths to animated objects relative to the node to which you attach the player. All animations in the applied timeline are relative: values calculated in animations are added to property values instead of replacing them.

The time for the timeline is taken from a property of the node to which you attach the Property Driven Animation Player. To set the type name of this property, use the TimeControllerPropertyTypeProperty property of the player. You can use any integer and float properties. Property Driven Animation Player does not support using properties of other data types. The time calculated from the value of the property depends on its data type:

• For float properties, property value 1.0 is interpreted as 1 second. For example, if the value of the time property is 5.5f, the time for the timeline is 5.5 seconds, and so on.
• For integer properties, property value 1 is interpreted as 1 millisecond. For example, if the value of the time property is 2300, the time for the timeline is 2.3 seconds, and so on.

It is recommended to use integer properties as time controllers. Using an integer property enables precise control of the time at which the animations in the timeline are applied. If you use a floating point property as a time controller, the Property Driven Animation Player rounds it to an integer number of milliseconds. In this case the result time, at which the animations in the timeline are applied, is not precise, but you can apply various effects to a floating point time property. For example, smooth interpolation by PropertyTargetInterpolator.

Property Driven Animation Player starts to apply animations from the timeline immediately after it is attached to the node. If the time controller property cannot be resolved or if it has an unsupported data type, the player does not apply the timeline. If the time controller property is resolved but is not set to the node, the player calculates the time using the default property value.

Note that the TimelineProperty and TimeControllerPropertyTypeProperty properties are applied only once when you attach the Property Driven Animation Player to the node. New values, which you set to these properties after attaching the player, are ignored.

See: AnimationPlayer, PropertyTargetInterpolator

Examples

To create a Property Driven Animation Player and sets its timeline and time controller property:

To attach a Property Driven Animation Player to a node:

Implementations

impl PropertyDrivenAnimationPlayer

pub fn create( domain: &Domain, name: impl AsRef<KanziStr>, ) -> Result<PropertyDrivenAnimationPlayer, Error>

Creates a Property Driven Animation Player.

Arguments

• domain - Domain.
• name - Name of the Property Driven Animation Player.

Returns

Property Driven Animation Player.

impl PropertyDrivenAnimationPlayer

pub fn get_timeline(&self) -> Result<Option<Weak<Resource>>, Error>

See: TIMELINE_PROPERTY

pub fn set_timeline(&self, value: Option<&Resource>) -> Result<(), Error>

See: TIMELINE_PROPERTY

pub fn get_time_property_type_property(&self) -> Result<KanziString, Error>

See: TIME_PROPERTY_TYPE_PROPERTY_PROPERTY

pub fn set_time_property_type_property( &self, value: impl AsRef<KanziStr>, ) -> Result<(), Error>

See: TIME_PROPERTY_TYPE_PROPERTY_PROPERTY

pub fn get_relative_playback(&self) -> Result<bool, Error>

See: RELATIVE_PLAYBACK_PROPERTY

pub fn set_relative_playback(&self, value: bool) -> Result<(), Error>

See: RELATIVE_PLAYBACK_PROPERTY

pub fn get_enabled(&self) -> Result<bool, Error>

See: ENABLED_PROPERTY

pub fn set_enabled(&self, value: bool) -> Result<(), Error>

See: ENABLED_PROPERTY

Methods from Deref<Target = NodeComponent>

pub fn get_name(&self) -> Result<KanziString, Error>

See: NAME_PROPERTY

pub fn set_name(&self, value: impl AsRef<KanziStr>) -> Result<(), Error>

See: NAME_PROPERTY

pub fn get_node(&self) -> Result<Option<Weak<Node>>, Error>

Returns the node the node component is attached to or None if node component is not attached to a node.

pub fn get_state(&self) -> Result<NodeComponentState, Error>

Gets the state of node component indicating if component is attached to a node, detached from any node or in process of attaching/detaching.

Methods from Deref<Target = Object>

pub fn as_ptr(&self) -> *mut ObjectWrapper

pub fn as_wrapper(&self) -> &ObjectWrapper

pub fn as_object(&self) -> &Object

Represents any type inheriting from Object as &Object. This is useful for comparisions when PartialEq traits failed to compare objects of different types.

let child = screen.get_child(0)?;
let parent = child.get_parent()?.into_error(ErrorKind::ObjectNotFound)?;
// assert_eq!(screen, parent); // <- Fails to compile!
assert_eq!(screen.as_object(), parent.as_object());

pub fn get_native(&self) -> Result<NonNull<c_void>, Error>

Gets a pointer to the backing C++ instance.

pub fn is_stale(&self) -> bool

Checks whether the weak reference has expired.

pub fn get_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<<T as VariantConstraint>::RetArg, Error>

where T: PropertyTypeConstraint,

Returns the current value of a property disregarding modifiers.

Base value is affected by the following inputs where the highest entry in the list determines the base value:

1. Local value set with setProperty or loaded from kzb
2. Value set by a style affecting the property.
3. Value defined by class metadata.

Modifiers are not applied, the highest-priority base value is returned.

If no inputs to the property value can be established the system returns the value default value from property type metadata.

Arguments

• property_type - The property type identifying the property to retrieve.

Returns

The evaluated property value.

pub fn get_optional_property<T>( &self, property_type: &PropertyType<T>, ) -> Result<Option<<T as VariantConstraint>::RetArg>, Error>

where T: PropertyTypeConstraint,

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.

If there is no value sources, None is returned.

If no inputs to the property value can be established the system returns the value default value from property type metadata.

Arguments

• property_type - The property type identifying the property to retrieve.

Returns

The evaluated property value.

pub fn set_property<T>( &self, property_type: &PropertyType<T>, value: <T as VariantConstraint>::DataArg<'_>, ) -> Result<(), Error>

where T: PropertyTypeConstraint,

Sets the local value of a property type.

pub fn has_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<bool, Error>

where T: PropertyTypeConstraint,

Evaluates whether there are any inputs into the property value. Both value sources and modifiers are taken into account.

Returns

Returns true if there are inputs into the property value, false otherwise.

pub fn remove_local_value<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>

where T: PropertyTypeConstraint,

Removes the local value associated with the property.

pub fn get_metaclass(&self) -> Result<Metaclass, Error>

Returns the metaclass of the dynamic type of the object.

pub fn get_domain(&self) -> Result<Domain, Error>

Returns the domain the object belongs to.

pub fn set_flag_keep_during_patching<T>( &self, property_type: &PropertyType<T>, ) -> Result<(), Error>

where T: PropertyTypeConstraint,

Sets the flag to indicate that the property was loaded from KZB.

pub fn debug_string(&self) -> Result<String, Error>

Builds a string representation of the object intended for debugging purposes.

Trait Implementations

impl Clone for PropertyDrivenAnimationPlayer

fn clone(&self) -> PropertyDrivenAnimationPlayer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ConcreteObjectConstraint for PropertyDrivenAnimationPlayer

fn create_instance( domain: &Domain, name: impl AsRef<KanziStr>, ) -> Result<Self, Error>

impl Debug for PropertyDrivenAnimationPlayer

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for PropertyDrivenAnimationPlayer

type Target = NodeComponent

The resulting type after dereferencing.

fn deref(&self) -> &<PropertyDrivenAnimationPlayer as Deref>::Target

Dereferences the value.

impl Inheritable for PropertyDrivenAnimationPlayer

unsafe fn downcast_unchecked<T>(self) -> T

where T: Inherits<Self>,

Downcast the object to a more specific type.

unsafe fn downcast_unchecked_ref<T>(&self) -> &T

where T: Inherits<Self>,

Downcast the object reference to a more specific type.

impl Inherits<NodeComponent> for PropertyDrivenAnimationPlayer

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for PropertyDrivenAnimationPlayer

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl MetaclassConstraint for PropertyDrivenAnimationPlayer

fn get_static_metaclass() -> &'static Metaclass

Gets metaclass associated with a given type.

impl ObjectConstraint for PropertyDrivenAnimationPlayer

fn downcast<T>(self) -> Result<Option<T>, Error>

where T: MetaInherits<Self>,

Casts metaclass to a more specific type by value.

fn downcast_ref<T>(&self) -> Result<Option<&T>, Error>

where T: MetaInherits<Self>,

Casts metaclass to a more specific type by reference.

fn is_a<T>(&self) -> Result<bool, Error>

where T: MetaInherits<Self>,

Determines whether the class this metaclass describes derives from a class described by specified metaclass.

fn downgrade(self) -> Weak<Self>

fn downgrade_ref(&self) -> Weak<Self>

fn lock(self) -> ThreadObject<Self>

fn lock_ref(&self) -> ThreadObject<Self>

impl<T> PartialEq<T> for PropertyDrivenAnimationPlayer

where T: ObjectConstraint,

fn eq(&self, rhs: &T) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialEq<Weak<T>> for PropertyDrivenAnimationPlayer

where T: ObjectConstraint,

fn eq(&self, rhs: &Weak<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for PropertyDrivenAnimationPlayer