Skip to main content

AnimationIkChain

Struct AnimationIkChain 

Source
pub struct AnimationIkChain {
    pub joints: Vec<String>,
    pub pole: [f32; 3],
    pub weight_parameter: String,
    pub foot_height: f32,
}
Expand description

One two-bone IK chain, pinning the chain’s end joint (typically a foot) to the ground the physics scene finds beneath it.

joints names the chain root, middle, and end in the target skeleton – e.g. a hip, knee, and foot. The middle joint must be the direct child of the root and the end the direct child of the middle. Every frame the runtime probes straight down from the animated end joint; when a surface is within range, the chain bends so the end lands foot_height above it. Pinning pauses automatically while the character is airborne.

Fields§

§joints: Vec<String>

Names of the chain’s root, middle, and end joints, in order. Exactly three are required, matching the target skeleton’s joint names.

§pole: [f32; 3]

Bend direction in mesh space: the middle joint bows toward this vector (a knee points forward, an elbow backward).

§weight_parameter: String

Name of a declared graph parameter scaling the solve in [0, 1]; empty pins at full strength. Lets gameplay fade IK in and out.

§foot_height: f32

Height the end joint rests above the probed surface, in mesh units (the sole-to-ankle offset for a foot).

Trait Implementations§

Source§

impl Clone for AnimationIkChain

Source§

fn clone(&self) -> AnimationIkChain

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AnimationIkChain

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AnimationIkChain

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for AnimationIkChain

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for AnimationIkChain

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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.