Struct AnimationPlayer

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

Use the Animation Player to play back an animation timeline that you set using the TimelineProperty property in that Animation Player. Kanzi resolves paths to animated nodes relative to the node where you attach an Animation Player.

To control the playback of an Animation Player, send these messages to the node where you attached the Animation Player:

• PlayMessage to start an animation timeline.
• PauseMessage to pause a running animation timeline.
• ResumeMessage to resume a paused or stopped animation timeline.
• StopMessage to stop a running or paused animation timeline.

By default, an Animation Player does not start playback until you send the PlayMessage message to the node. To set an Animation Player to start the playback when you attach the Animation Player to a node, enable the AutoplayEnabledProperty property.

When you start the playback of an Animation Player by sending to it the PlayMessage or ResumeMessage message, or if the AutoplayEnabledProperty property is enabled, the player adds its timeline as a child to a parallel timeline and applies all playback settings from its PlaybackModeProperty, DurationScaleProperty and RepeatCountProperty properties to it. If you start the playback by sending a PlayMessage message with playback arguments, the player adds its parallel timeline as a child to yet another parallel timeline and applies playback settings from the PlayMessageArguments to it.

See: PropertyDrivenAnimationPlayer, PropertyTargetInterpolator

Examples

To create animation player and set timeline:

To attach animation player to the node:

To start animation player:

To pause animation player:

To resume animation player:

To stop animation player:

To detach animation player from the node:

Implementations

impl AnimationPlayer

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

Creates animation player.

Arguments

• domain - Domain.
• name - Name of animation player.

Returns

animation player.

impl AnimationPlayer

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_autoplay_enabled(&self) -> Result<bool, Error>

See: AUTOPLAY_ENABLED_PROPERTY

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

See: AUTOPLAY_ENABLED_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_restore_original_values_after_playback(&self) -> Result<bool, Error>

See: RESTORE_ORIGINAL_VALUES_AFTER_PLAYBACK_PROPERTY

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

See: RESTORE_ORIGINAL_VALUES_AFTER_PLAYBACK_PROPERTY

pub fn get_playback_mode(&self) -> Result<KzuTimeLineEntryPlaybackMode, Error>

See: PLAYBACK_MODE_PROPERTY

pub fn set_playback_mode( &self, value: KzuTimeLineEntryPlaybackMode, ) -> Result<(), Error>

See: PLAYBACK_MODE_PROPERTY

pub fn get_duration_scale(&self) -> Result<f32, Error>

See: DURATION_SCALE_PROPERTY

pub fn set_duration_scale(&self, value: f32) -> Result<(), Error>

See: DURATION_SCALE_PROPERTY

pub fn get_repeat_count(&self) -> Result<i32, Error>

See: REPEAT_COUNT_PROPERTY

pub fn set_repeat_count(&self, value: i32) -> Result<(), Error>

See: REPEAT_COUNT_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 AnimationPlayer

fn clone(&self) -> AnimationPlayer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConcreteObjectConstraint for AnimationPlayer

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

impl Debug for AnimationPlayer

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

Formats the value using the given formatter.

impl Deref for AnimationPlayer

type Target = NodeComponent

The resulting type after dereferencing.

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

Dereferences the value.

impl Inheritable for AnimationPlayer

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 AnimationPlayer

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<Object> for AnimationPlayer

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl MetaclassConstraint for AnimationPlayer

fn get_static_metaclass() -> &'static Metaclass

Gets metaclass associated with a given type.

impl ObjectConstraint for AnimationPlayer

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 AnimationPlayer

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 AnimationPlayer

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 AnimationPlayer