Struct ambient_api::animation::BlendNodeRef

pub struct BlendNodeRef(pub AnimationNodeRef);

Blend animation node. This is an animation node which can be plugged into an animation player or other animation nodes.

This is just a reference to an entity which lives in the ecs. You need to call despawn to remove it.

Tuple Fields

0: AnimationNodeRef

Implementations

impl BlendNodeRef

pub fn new( left: impl AsRef<AnimationNodeRef>, right: impl AsRef<AnimationNodeRef>, weight: f32 ) -> BlendNodeRef

Create a new blend animation node.

If the weight is 0, only the left animation will play. If the weight is 1, only the right animation will play. Values in between blend between the two animations.

pub fn from_entity(entity: EntityId) -> BlendNodeRef

Use an existing node

pub fn set_weight(&self, weight: f32)

Set the weight of this blend node.

If the weight is 0, only the left animation will play. If the weight is 1, only the right animation will play. Values in between blend between the two animations.

pub fn set_mask(&self, weights: Vec<(BindId, f32)>)

Sets the mask of this blend node.

For example blend_node.set_mask(vec![("LeftLeg".to_string(), 1.)]) means that the LeftLeg is always controlled by the right animation.

pub fn set_mask_humanoid_lower_body(&self, weight: f32)

Sets a mask value to all bones of a humanoids lower body

pub fn set_mask_humanoid_upper_body(&self, weight: f32)

Sets a mask value to all bones of a humanoids upper body

Trait Implementations

impl AsRef<AnimationNodeRef> for BlendNodeRef

fn as_ref(&self) -> &AnimationNodeRef

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for BlendNodeRef

fn clone(&self) -> BlendNodeRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlendNodeRef

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

Formats the value using the given formatter.

impl Copy for BlendNodeRef