Struct BlendAnimationsByIndex 

pub struct BlendAnimationsByIndex<T>
where
    T: EntityId,
{
    pub base: BasePoseNode<T>,
    pub index_parameter: String,
    pub inputs: Vec<IndexedBlendInput<T>>,
    pub prev_index: Cell<Option<u32>>,
    pub blend_time: Cell<f32>,
    pub output_pose: RefCell<AnimationPose<T>>,
}

A node that switches between given animations using index and smoothly blends from one animation to another while switching. It is very useful for situations when you need to switch between different animations. For example you could have an aim state, it is suitable for any weapon (you don’t need to create a ton of states like aim_rifle, aim_pistol, etc), but actual weapon holding animation should be different based on actual weapon a character is holding. In this case you create a BlendAnimationsByIndex node, add a few inputs where each input uses different weapon holding animation and in your game all you need to do is to set an index parameter in the machine parameters. The node will automatically perform smooth transition between different animations.

Fields

base: BasePoseNode<T>

Base node.

index_parameter: String

A name of index parameter that will be used to switch between input poses.

inputs: Vec<IndexedBlendInput<T>>

A set of input poses.

prev_index: Cell<Option<u32>>

Index of a previously active input pose.

blend_time: Cell<f32>

Current blend time.

output_pose: RefCell<AnimationPose<T>>

Output pose of the node.

Implementations

impl<T> BlendAnimationsByIndex<T>

where T: EntityId,

pub const BASE: &'static str = "base"

pub const INDEX_PARAMETER: &'static str = "index_parameter"

pub const INPUTS: &'static str = "inputs"

impl<T> BlendAnimationsByIndex<T>

where T: EntityId,

pub fn new( index_parameter: String, inputs: Vec<IndexedBlendInput<T>>, ) -> BlendAnimationsByIndex<T>

Creates new BlendAnimationsByIndex node using given index parameter name and a set of inputs.

pub fn children(&self) -> Vec<Handle<PoseNode<T>>>

Return a set of handle of children nodes.

Methods from Deref<Target = BasePoseNode<T>>

pub const POSITION: &'static str = "position"

Trait Implementations

impl<T> AnimationPoseSource<T> for BlendAnimationsByIndex<T>

where T: EntityId,

fn eval_pose( &self, nodes: &Pool<PoseNode<T>>, params: &ParameterContainer, animations: &AnimationContainer<T>, dt: f32, ) -> Ref<'_, AnimationPose<T>>

Evaluates animation pose and returns a reference to it.

fn pose(&self) -> Ref<'_, AnimationPose<T>>

Returns a reference to inner pose of a node.

fn collect_animation_events( &self, nodes: &Pool<PoseNode<T>>, params: &ParameterContainer, animations: &AnimationContainer<T>, strategy: AnimationEventCollectionStrategy, ) -> Vec<(Handle<Animation<T>>, AnimationEvent)>

Collects animation events from internals.

impl<T> Clone for BlendAnimationsByIndex<T>

where T: Clone + EntityId,

fn clone(&self) -> BlendAnimationsByIndex<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for BlendAnimationsByIndex<T>

where T: Debug + EntityId,

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

Formats the value using the given formatter.

impl<T> Default for BlendAnimationsByIndex<T>

where T: Default + EntityId,

fn default() -> BlendAnimationsByIndex<T>

Returns the “default value” for a type.

impl<T> DerefMut for BlendAnimationsByIndex<T>

where T: EntityId,

fn deref_mut(&mut self) -> &mut <BlendAnimationsByIndex<T> as Deref>::Target

Mutably dereferences the value.

impl<T> PartialEq for BlendAnimationsByIndex<T>

where T: PartialEq + EntityId,

fn eq(&self, other: &BlendAnimationsByIndex<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> Reflect for BlendAnimationsByIndex<T>

where T: EntityId, BlendAnimationsByIndex<T>: 'static, BasePoseNode<T>: Reflect, String: Reflect, Vec<IndexedBlendInput<T>>: Reflect,

fn source_path() -> &'static str

fn type_name(&self) -> &'static str

fn doc(&self) -> &'static str

fn assembly_name(&self) -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn fields_info(&self, func: &mut dyn FnMut(&[FieldInfo<'_, '_>]))

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

fn set( &mut self, value: Box<dyn Reflect>, ) -> Result<Box<dyn Reflect>, Box<dyn Reflect>>

fn as_any(&self, func: &mut dyn FnMut(&(dyn Any + 'static)))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut (dyn Any + 'static)))

fn as_reflect(&self, func: &mut dyn FnMut(&(dyn Reflect + 'static)))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut (dyn Reflect + 'static)))

fn fields(&self, func: &mut dyn FnMut(&[&(dyn Reflect + 'static)]))

fn fields_mut( &mut self, func: &mut dyn FnMut(&mut [&mut (dyn Reflect + 'static)]), )

fn field( &self, name: &str, func: &mut dyn FnMut(Option<&(dyn Reflect + 'static)>), )

fn field_mut( &mut self, name: &str, func: &mut dyn FnMut(Option<&mut (dyn Reflect + 'static)>), )

fn set_field( &mut self, field: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, Box<dyn Reflect>>), )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn as_array(&self, func: &mut dyn FnMut(Option<&(dyn ReflectArray + 'static)>))

fn as_array_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectArray + 'static)>), )

fn as_list(&self, func: &mut dyn FnMut(Option<&(dyn ReflectList + 'static)>))

fn as_list_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectList + 'static)>), )

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&(dyn ReflectInheritableVariable + 'static)>), )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectInheritableVariable + 'static)>), )

fn as_hash_map( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHashMap + 'static)>), )

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHashMap + 'static)>), )

impl<T> Visit for BlendAnimationsByIndex<T>

where T: EntityId, BasePoseNode<T>: Visit, String: Visit, Vec<IndexedBlendInput<T>>: Visit, Cell<Option<u32>>: Visit, Cell<f32>: Visit,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

Read or write this value, depending on whether Visitor::is_reading() is true or false.

impl<T> Deref for BlendAnimationsByIndex<T>

where T: EntityId,

type Target = BasePoseNode<T>

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> StructuralPartialEq for BlendAnimationsByIndex<T>

where T: EntityId,