Struct ambient_api_core::animation::PlayClipFromUrlNodeRef

pub struct PlayClipFromUrlNodeRef(pub AnimationNodeRef);

Play clip from url 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 PlayClipFromUrlNodeRef

pub fn new(url: impl Into<String>) -> Self

Create a new node.

pub fn from_entity(entity: EntityId) -> Self

Use an existing node

pub fn looping(&self, value: bool)

Set if the animation should loop or not

pub fn set_play_mode(&self, mode: PlayMode)

Set how the animation is played

pub fn restart(&self)

Start playing the animation from the beginning

pub fn set_retargeting(&self, retargeting: AnimationRetargeting)

Set up retargeting

pub fn apply_base_pose(&self, value: bool)

If true, the base pose from the model of the animation clip will be applied to the animation

Some animations will only work if the base pose of the character is the same as the animations base pose, so we apply the pose from the animations model to make sure they correspond

This exists mostly because some FBX animations have pre-rotations, and to apply them to character models which don’t have the same pre-rotations we need to make sure they’re up to sync

I.e. this is mostly relevant for retargeting

pub fn peek_clip_duration(&self) -> Option<f32>

Returns None if the duration hasn’t been loaded yet

pub async fn clip_duration(&self) -> f32

Returns the duration of this clip. This is async because it needs to wait for the clip to load before the duration can be returned.

pub fn peek_bind_ids(&self) -> Option<Vec<String>>

Returns None if the clip hasn’t been loaded yet

pub async fn bind_ids(&self) -> Vec<String>

Returns the bind ids of this clip. This is async because it needs to wait for the clip to load before the bind ids can be returned.

pub async fn wait_for_load(&self)

Wait until the clip has been loaded

Trait Implementations

impl AsRef<AnimationNodeRef> for PlayClipFromUrlNodeRef

fn as_ref(&self) -> &AnimationNodeRef

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

impl Clone for PlayClipFromUrlNodeRef

fn clone(&self) -> PlayClipFromUrlNodeRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlayClipFromUrlNodeRef

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

Formats the value using the given formatter.

impl Copy for PlayClipFromUrlNodeRef