Enum skeletal_model::bone::bone_kind::BoneKind

#[repr(u8)]
pub enum BoneKind {
    Neck,
    Chest,
    Waist,
    Hip,
    ThighL,
    ThighR,
    AnkleL,
    AnkleR,
    FootL,
    FootR,
    UpperArmL,
    UpperArmR,
    ForearmL,
    ForearmR,
    WristL,
    WristR,
}

Describes the various types of bones in the skeleton.

All of this information is static rather than dynamic information. “Static” here refers to information that does not change - this information is “hard coded”. This includes:

• The parent/child relationships between the various types of bones
• The pose of the bones when performing a calibration
• Names of the bones
• Etc

Where possible, this information is provided as const functions so that they can be evaluated at compile-time.

There is also dynamic information associated with bones. “Dynamic” here refers to the fact that some bone data cannot be known up front and changes as the skeletal model receives inputs and produces outputs. This data is stored in the Skeleton as an Edge.

BoneKind is also represented as a u8, so it can be used as an index for an array. This is used for example in BoneMap. Please note that we make no stability guarantees for the particular value that any variant gets, only that these values are contiguous and start at 0. Use the variant directly or refer to the various functions implemented on this type for stability.

Variants

Neck

Chest

Waist

Hip

ThighL

ThighR

AnkleL

AnkleR

FootL

FootR

UpperArmL

UpperArmR

ForearmL

ForearmR

WristL

WristR

Implementations

impl BoneKind

pub const fn max() -> BoneKind

The bone with the largest integer value

pub const MAX: BoneKind = _

pub const fn min() -> BoneKind

The bone with the smallest integer value

pub const MIN: BoneKind = _

pub const fn root() -> Self

The root bone of the skeletal graph/tree.

pub const ROOT: BoneKind = _

pub const fn num_types() -> usize

Returns the number of unique kinds of bones. This is equivalent to the number of variants in BoneKind

pub const NUM_TYPES: usize = 16usize

pub const fn children(&self) -> &'static [Self]

Returns the children of any particular bone.

The slice is 'static, which means the lifetime of the returned slice lives for the entire duration of the program. This is because the parent/child relationship of bones is known at compile-time.

pub const fn parent(&self) -> Option<BoneKind>

The parent of a bone.

pub fn iter() -> Map<RangeInclusive<u8>, fn(_: u8) -> BoneKind>

pub fn calibration_rotation(self) -> Global<UnitQuat>

Returns the initial calibration pose of the bone. Rotating the up vector by this rotation would cause it to point in the same target direction as the bone.

pub fn calibration_rotation_local(self) -> Local<UnitQuat>

Returns the initial calibration pose of the bone, as a rotation relative to the parent bone. See also: Self::calibration_rotation

Trait Implementations

impl Clone for BoneKind

fn clone(&self) -> BoneKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BoneKind

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

Formats the value using the given formatter.

impl From<BoneKind> for EdgeKind

fn from(original: BoneKind) -> EdgeKind

Converts to this type from the input type.

impl From<BoneKind> for u8

fn from(other: BoneKind) -> Self

Converts to this type from the input type.

impl From<BoneKind> for usize

fn from(other: BoneKind) -> Self

Converts to this type from the input type.

impl FromPrimitive for BoneKind

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl Hash for BoneKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl<T> Index<BoneKind> for BoneMap<T>

type Output = T

The returned type after indexing.

fn index(&self, index: BoneKind) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<BoneKind> for Skeleton

type Output = Edge

The returned type after indexing.

fn index(&self, index: BoneKind) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<BoneKind> for BoneMap<T>

fn index_mut(&mut self, index: BoneKind) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl PartialEq<BoneKind> for BoneKind

fn eq(&self, other: &BoneKind) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToPrimitive for BoneKind

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

impl TryFrom<u8> for BoneKind

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for BoneKind

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for BoneKind

impl Eq for BoneKind

impl StructuralEq for BoneKind

impl StructuralPartialEq for BoneKind