Struct ark_api::world::ValueAccessorReadWriteAnimate

pub struct ValueAccessorReadWriteAnimate<T> { /* private fields */ }

A ValueAccessor is used to set/get/animate a component value. bool and i64 types will be set to target directly when using animate.

Example:

let ball_mesh = ...;
let ball_entity = Entity::create("ball");
ball_entity.render().mesh().set(ball_mesh);
ball_entity
    .transform()
    .position() // ValueAccessor returned here
    .set(Vec3::ZERO);
let duration = 1.0; // Duration is in seconds
ball_entity
    .transform()
    .position() // ValueAccessor returned here
    .animate(Vec3::new(0.0, 2.5, -40.0), duration);

Implementations

impl<T> ValueAccessorReadWriteAnimate<T>where ValueConverter: ValueConverterTrait<T>,

pub fn new(id: Entity, component: ComponentType, param: u32) -> Selfwhere T: Sized,

Create a new value accessor for a specific entity, component and parameter.

pub fn set(&self, v: T)

Sets the value to v.

Will panic if it receives an invalid value, such as a NaN or unnormalized quaternion.

pub fn try_set(&self, v: T) -> Result<(), EntityValueError>

Tries to set the value to v, returns EntityValueError if it failed.

In contrast to set this function will return an error if it receives an invalid value, such as a NaN or unnormalized quaternion. Useful to use if you don’t want to panic because of unknown user input.

pub fn get(&self) -> T

Returns the current value.

pub fn animate(&self, v: T, duration: f32)

Will linearly animate / transition the value from the current value to the target v using duration (in seconds).

Will stop and continue from any ongoing animation.

Note: bools and integers (also all kinds of entity references) will be set to their target directly, however delay can be used to delay the set of the value.

pub fn animate_smooth(&self, v: T, duration: f32, smoothing: f32)

Will linearly animate / transition the value from the current value to the

Will stop and continue from any ongoing animation. A smoothing constant of 0 means no smoothing, higher value means more smoothing (i.e. the value will take a longer time to change).

Useful if you want to smoothen out discontinuities when animating to new targets, cancelling the old animation.

Note: bools and integers (also all kinds of entity references) will be set to their target directly, however delay can be used to delay the set of the value.

pub fn build_animation(&self) -> AnimationBuilder<T>

Starts setting up an animation of this value.

Call methods on the returned AnimationBuilder to configure it.

Trait Implementations

impl<T> ValueAccessorAnimateTrait<T> for ValueAccessorReadWriteAnimate<T>where ValueConverter: ValueConverterTrait<T>,

Implementation of trait for animating component values

fn animate(&self, v: T, duration: f32)

Will linearly animate / transition the value from the current value to the target v using duration (in seconds).

Will stop and continue from any ongoing animation.

Note: bools and integers (also all kinds of entity references) will be set to their target directly, however delay can be used to delay the set of the value.

fn animate_smooth(&self, v: T, duration: f32, smoothing: f32)

Will linearly animate / transition the value from the current value to the

Will stop and continue from any ongoing animation. A smoothing constant of 0 means no smoothing, higher value means more smoothing (i.e. the value will take a longer time to change).

Useful if you want to smoothen out discontinuities when animating to new targets, cancelling the old animation.

Note: bools and integers (also all kinds of entity references) will be set to their target directly, however delay can be used to delay the set of the value.

fn build_animation(&self) -> AnimationBuilder<T>

Starts setting up an animation of this value.

Call methods on the returned AnimationBuilder to configure it.

impl<T> ValueAccessorReadTrait<T> for ValueAccessorReadWriteAnimate<T>where ValueConverter: ValueConverterTrait<T>,

Implementation of trait for reading component values

fn get(&self) -> T

Returns the current value.

impl<T> ValueAccessorWriteTrait<T> for ValueAccessorReadWriteAnimate<T>where ValueConverter: ValueConverterTrait<T>,

Implementation of trait for writing component values

fn set(&self, v: T)

Sets the value to v.

Will panic if it receives an invalid value, such as a NaN or unnormalized quaternion.

fn try_set(&self, v: T) -> Result<(), EntityValueError>

Tries to set the value to v, returns EntityValueError if it failed.

In contrast to set this function will return an error if it receives an invalid value, such as a NaN or unnormalized quaternion. Useful to use if you don’t want to panic because of unknown user input.