Skip to main content

Rig

Struct Rig 

Source
pub struct Rig {
    pub rig_version: u32,
    pub parts: Vec<RigPart>,
    pub clips: BTreeMap<String, Clip>,
    pub provenance: RigProvenance,
}
Expand description

One rig document.

Fields§

§rig_version: u32

The document version; RIG_VERSION.

§parts: Vec<RigPart>

One display entity each, in emission order.

§clips: BTreeMap<String, Clip>

Named clips. A frame is one transform per part, in Self::parts order, in the rig’s own frame: origin at the assembly’s mark (the cell’s centre at the mark’s floor plane), +z the rig’s front.

§provenance: RigProvenance

Where the rig came from (ADR-0013’s record, as a piece’s metadata carries it).

Implementations§

Source§

impl Rig

Source

pub fn clip_names(&self) -> Vec<&str>

The clip names, in the order the compiler numbers them.

Source

pub fn clip_index(&self, name: &str) -> Option<usize>

The compiler’s index for a clip: its position in name order.

Source

pub fn rest_pose(&self) -> Option<Vec<Transform>>

The rest pose: each part’s rest, else the first frame of the first clip. None only for a rig check refuses.

Source

pub fn frame_count(&self) -> usize

Total frames across every clip — the count of frame functions the compiler emits for this rig.

Trait Implementations§

Source§

impl Clone for Rig

Source§

fn clone(&self) -> Self

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 Rig

Source§

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

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

impl<'de> Deserialize<'de> for Rig

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 PartialEq for Rig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Rig

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
Source§

impl StructuralPartialEq for Rig

Auto Trait Implementations§

§

impl Freeze for Rig

§

impl RefUnwindSafe for Rig

§

impl Send for Rig

§

impl Sync for Rig

§

impl Unpin for Rig

§

impl UnsafeUnpin for Rig

§

impl UnwindSafe for Rig

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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, !>

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.