Struct funnybones::Skeleton

pub struct Skeleton { /* private fields */ }

A collection of Bones. connected by Joints.

Implementations

impl Skeleton

pub fn push_bone(&mut self, bone: impl Into<LabeledBoneKind>) -> BoneId

Creates a new Bone into the skeleton. Returns the unique id of the created bone.

The first bone pushed is considered the root of the skeleton. All other bones must be connected to the root directly or indirectly through Joints.

pub fn bones(&self) -> &[Bone]

Returns the list of bones in this skeleton.

pub fn joints(&self) -> &[Joint]

Returns the list of joints in this skeleton.

pub fn bone(&self, id: BoneId) -> Option<&Bone>

Returns the bone for a given id, or none if not found.

pub fn bone_mut(&mut self, id: BoneId) -> Option<&mut Bone>

Returns an exclusive reference to the bone for a given id, or none if not found.

pub fn joint(&self, id: JointId) -> Option<&Joint>

Returns the joint for a given id, or none if not found.

pub fn joint_mut(&mut self, id: JointId) -> Option<&mut Joint>

Returns an exclusive reference to the joint for a given id, or none if not found.

pub fn connections_to(&self, axis: BoneAxis) -> Option<&[JointId]>

Returns a list of joints connected to a specific bone axis.

pub fn push_joint(&mut self, joint: Joint) -> JointId

Creates a new Joint in the skeleton, connecting two bones together by their axis. Returns the unique id of the created joint.

pub fn find_joint_by_label(&self, label: &str) -> Option<JointId>

Finds an existing Joint by its label.

pub fn find_bone_by_label(&self, label: &str) -> Option<BoneId>

Finds an existing Bone by its label.

pub fn set_translation(&mut self, translation: Coordinate)

Sets a translation to be applied to the entire skeleton.

pub fn translation(&self) -> Coordinate

Returns the translation applied to the entire skeleton.

pub fn set_rotation(&mut self, rotation: Rotation)

Sets a base rotation to apply to the entire skeleton.

pub const fn rotation(&self) -> Rotation

Returns the base rotation being applied to the entire skeleton.

pub fn solve(&mut self)

Updates the solved positions of all bones in this skeleton that are connected either directly or indirectly to the root bone via Joints.

Trait Implementations

impl Debug for Skeleton

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

Formats the value using the given formatter.

impl Default for Skeleton

fn default() -> Skeleton

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Skeleton

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Index<BoneId> for Skeleton

type Output = Bone

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<JointId> for Skeleton

type Output = Joint

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<BoneId> for Skeleton

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

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

impl IndexMut<JointId> for Skeleton

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

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

impl PartialEq for Skeleton

fn eq(&self, other: &Skeleton) -> 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 Skeleton

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Skeleton