Struct skeletal_model::skeleton::Skeleton

source · [−]

pub struct Skeleton {
    bone_map: BoneMap<EdgeIndex>,
    graph: UnGraph<Node, Edge>,
}

Expand description

The Skeleton provides a way of reading, writing, and solving for the pose of a human wearing FBT.

See the crate::skeleton module for more information.

Fields

bone_map: BoneMap<EdgeIndex>graph: UnGraph<Node, Edge>

Implementations

source

impl Skeleton

source

pub fn solve(&mut self) -> Result<(), SolveError>

Solves for the outputs of the skeletal model.

For more info on the algorithm, see crate::skeleton.

source

fn traverse(
&mut self,
f: impl FnMut(&mut UnGraph<Node, Edge>, PoppedNode, Neighbors)
) -> Result<(), SolveError>

Traverses all edges and nodes in the graph in a breadth-first search. Calls f at the start of each traversal.

source

impl Skeleton

source

pub fn new(config: &SkeletonConfig) -> Self

Creates a new Skeleton from SkeletonConfig. Initially, the skeleton will not have any input trackers or output trackers.

source

fn find_root_nodes(&self) -> impl Iterator<Item = NodeIndex> + '_

Get the nodes of the graph that have a Some(_) Node::input_pos_g

Trait Implementations

source

impl Index<BoneKind> for Skeleton

type Output = Edge

The returned type after indexing.

source

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

Performs the indexing (container[index]) operation. Read more

Auto Trait Implementations

impl RefUnwindSafe for Skeleton

impl Send for Skeleton

impl Sync for Skeleton

impl Unpin for Skeleton

impl UnwindSafe for Skeleton

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · 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> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct skeletal_model::skeleton::Skeleton

Fields

Implementations

impl Skeleton

pub fn solve(&mut self) -> Result<(), SolveError>

fn traverse( &mut self, f: impl FnMut(&mut UnGraph<Node, Edge>, PoppedNode, Neighbors)) -> Result<(), SolveError>

impl Skeleton

pub fn new(config: &SkeletonConfig) -> Self

fn find_root_nodes(&self) -> impl Iterator<Item = NodeIndex> + '_

Trait Implementations

impl Index<BoneKind> for Skeleton

type Output = Edge

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

Auto Trait Implementations

impl RefUnwindSafe for Skeleton

impl Send for Skeleton

impl Sync for Skeleton

impl Unpin for Skeleton

impl UnwindSafe for Skeleton

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

fn is_in_subset(&self) -> bool

fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

fn traverse(
&mut self,
f: impl FnMut(&mut UnGraph<Node, Edge>, PoppedNode, Neighbors)
) -> Result<(), SolveError>

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,

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

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,