Enum funnybones::BoneKind

pub enum BoneKind {
    Rigid {
        length: f32,
    },
    Jointed {
        start_length: f32,
        end_length: f32,
        inverse: bool,
    },
}

A representation of a bone structure inside of a Skeleton.

Variants

Rigid

A single bone of a fixed length.

Fields

length: f32

The length of the bone.

Jointed

Two bones connected with a joint that automatically adjusts its angle as needed.

Fields

start_length: f32

The length of the bone connected closest to the root of the skeleton.

end_length: f32

The length of the bone connected furthes from the root of the skeleton.

inverse: bool

The bend of the simulated joint always goes in one of two directions. This boolean toggles which direction the bend goes in.

Implementations

impl BoneKind

pub fn with_label(self, label: impl Into<String>) -> LabeledBoneKind

Attaches a label to this bone when pushed into a skeleton.

pub fn full_length(&self) -> f32

Returns the full length of this bone.

pub fn is_inverse(&self) -> bool

Returns true if this is a jointed bone that bends inversely.

pub fn set_inverse(&mut self, new_inverse: bool)

Sets whether to bend inversely.

This function only affects a jointed bone kind.

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<'de> Deserialize<'de> for BoneKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BoneKind> for LabeledBoneKind

fn from(kind: BoneKind) -> Self

Converts to this type from the input type.

impl PartialEq for BoneKind

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for BoneKind

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for BoneKind

impl StructuralPartialEq for BoneKind