Skip to main content

AnimatorController

Struct AnimatorController 

Source
pub struct AnimatorController {
    pub states: HashMap<String, AnimationState>,
    pub transitions: Vec<Transition>,
    pub params: HashMap<String, ParamValue>,
    pub layers: Vec<AnimationLayer>,
    pub clips: HashMap<String, AnimationClip>,
    /* private fields */
}
Expand description

Drives one or more AnimationLayers with shared parameter space.

Fields§

§states: HashMap<String, AnimationState>§transitions: Vec<Transition>§params: HashMap<String, ParamValue>§layers: Vec<AnimationLayer>§clips: HashMap<String, AnimationClip>

Clip library for fetching clips by name.

Implementations§

Source§

impl AnimatorController

Source

pub fn new() -> Self

Source

pub fn add_state(&mut self, state: AnimationState)

Source

pub fn add_clip(&mut self, clip: AnimationClip)

Source

pub fn add_transition(&mut self, t: Transition)

Source

pub fn add_layer(&mut self, layer: AnimationLayer)

Source

pub fn set_float(&mut self, name: &str, v: f32)

Source

pub fn set_bool(&mut self, name: &str, v: bool)

Source

pub fn set_int(&mut self, name: &str, v: i32)

Source

pub fn set_trigger(&mut self, name: &str)

Set a trigger (one-shot bool that resets after being consumed).

Source

pub fn get_float(&self, name: &str) -> f32

Source

pub fn get_bool(&self, name: &str) -> bool

Source

pub fn start(&mut self, state_name: &str)

Source

pub fn start_layer(&mut self, layer_name: &str, state_name: &str)

Source

pub fn tick(&mut self, dt: f32) -> AnimationOutput

Advance all layers by dt seconds and evaluate transitions. Returns blended output across all layers.

Source

pub fn drain_events(&mut self) -> Vec<FiredEvent>

Drain all fired animation events since last call.

Source

pub fn play(&mut self, state_name: &str)

Force the base layer into a specific state immediately.

Source

pub fn cross_fade(&mut self, state_name: &str, duration: f32)

Cross-fade to a state over duration seconds.

Source

pub fn normalized_time(&self) -> f32

Current normalized time of the base layer’s active state.

Source

pub fn current_state(&self) -> Option<&str>

Name of the currently active state on the base layer.

Source

pub fn is_transitioning(&self) -> bool

Whether the base layer is transitioning.

Trait Implementations§

Source§

impl Default for AnimatorController

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,