Byte Engine Docs
View on docs.rs

root_motion

Generated Rust API reference for byte_engine.

byte_engine / animation / root_motion


Module root_motion

Root-motion deltas that the animation graph player reports to gameplay.

Quick Reference

ItemKindDescription
RootMotionDeltastructThe RootMotionDelta struct carries one frame's local translation and rotation change to gameplay.

Structs

RootMotionDelta

struct RootMotionDelta {
    pub translation: math::Vector<resource_management::resources::ParentSpace>,
    pub rotation: math::Orientation,
}

Defined in crates/byte-engine/src/animation/root_motion.rs:10-15

The RootMotionDelta struct carries one frame's local translation and rotation change to gameplay.

Its default is Self::IDENTITY.

Fields

  • translation: math::Vector<resource_management::resources::ParentSpace>

    Translation to apply in the skeleton root's parent space.

  • rotation: math::Orientation

    Rotation to apply after the previous root rotation.

Implementations

  • const IDENTITY: Self
  • fn between(previous: LocalTransform, current: LocalTransform) -> Self

    Calculates the shortest local transform delta between two sampled root poses.

  • fn then(self, next: Self) -> Self

    Composes this delta followed by next.

    Translation remains in the skeleton root's parent space, so segment

    translations add directly. Use this to join root-motion segments across

    a looping clip boundary.

  • fn blend(self, other: Self, factor: f32) -> Self

    Blends two root-motion deltas for pose blending.

Trait Implementations

impl ArchivePointee for RootMotionDelta
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for RootMotionDelta
impl Clone for RootMotionDelta
impl Copy for RootMotionDelta
impl Debug for RootMotionDelta
  • fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Default for RootMotionDelta
impl Downcast for RootMotionDelta
  • fn into_any(self: Box<T>) -> Box<dyn Any>
  • fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
  • fn as_any(&self) -> &dyn Any
  • fn as_any_mut(&mut self) -> &mut dyn Any
impl DowncastSync for RootMotionDelta
  • fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
impl Instrument for RootMotionDelta
impl LayoutRaw for RootMotionDelta
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for RootMotionDelta
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for RootMotionDelta
impl Pointee for RootMotionDelta
  • type Metadata = ()
impl Read for RootMotionDelta
impl<R> ReadPrimitive for RootMotionDelta
impl StructuralPartialEq for RootMotionDelta
impl WithSubscriber for RootMotionDelta

On this page