Struct ssbh_lib::formats::skel::Skel

pub struct Skel {
    pub major_version: u16,
    pub minor_version: u16,
    pub bone_entries: SsbhArray<SkelBoneEntry>,
    pub world_transforms: SsbhArray<Matrix4x4>,
    pub inv_world_transforms: SsbhArray<Matrix4x4>,
    pub transforms: SsbhArray<Matrix4x4>,
    pub inv_transforms: SsbhArray<Matrix4x4>,
}

An ordered, hierarchical collection of bones and their associated transforms. Each bone entry has transformation matrices stored at the corresponding locations in the transform arrays. The transforms array can be used to calculate the remaining arrays. Compatible with file version 1.0.

Fields

major_version: u16

minor_version: u16

bone_entries: SsbhArray<SkelBoneEntry>

A skeleton consisting of an ordered heirarchy of bones.

world_transforms: SsbhArray<Matrix4x4>

The transformation in world space for each bone in bone_entries. The world space transform for a bone is calculated by accumulating the transformations in transforms with the transformation of the bone’s parent recursively.

inv_world_transforms: SsbhArray<Matrix4x4>

The inverses of the matrices in world_transforms.

transforms: SsbhArray<Matrix4x4>

The associated transformation for each of the bones in bone_entries relative to its parent’s world transform. If the bone has no parent, this is equivalent to the corresponding value in world_transforms.

inv_transforms: SsbhArray<Matrix4x4>

The inverses of the matrices in transforms.

Implementations

impl Skel

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self, ReadSsbhError>

Tries to read the current SSBH type from path. The entire file is buffered for performance.

pub fn read<R: Read + Seek>(reader: &mut R) -> Result<Self, ReadSsbhError>

Tries to read the current SSBH type from reader. For best performance when opening from a file, use from_file instead.

pub fn write<W: Write + Seek>(&self, writer: &mut W) -> Result<()>

pub fn write_to_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

Trait Implementations

impl BinRead for Skel

type Args = ()

The type of arguments needed to be supplied in order to read this type, usually a tuple.

fn read_options<R: Read + Seek>(
    __binread_generated_var_reader: &mut R,
    __binread_generated_var_options: &ReadOptions,
    __binread_generated_var_arguments: Self::Args
) -> BinResult<Self>

Read the type from the reader

fn read<R>(reader: &mut R) -> Result<Self, Error> where
    R: Read + Seek, 

Read the type from the reader while assuming no arguments have been passed

fn read_args<R>(reader: &mut R, args: Self::Args) -> Result<Self, Error> where
    R: Read + Seek, 

Read the type from the reader using the specified arguments

fn after_parse<R>(
    &mut self,
    &mut R,
    &ReadOptions,
    Self::Args
) -> Result<(), Error> where
    R: Read + Seek, 

fn args_default() -> Option<Self::Args>

The default arguments to be used when using the read shortcut method. Override this for any type that optionally requries arguments

impl Debug for Skel

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Skel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Skel

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

Serialize this value into the given Serde serializer.

impl SsbhWrite for Skel

fn ssbh_write<W: Write + Seek>(
    &self,
    writer: &mut W,
    data_ptr: &mut u64
) -> Result<()>

Writes the byte representation of self to writer and update data_ptr as needed to ensure the next relative offset is correctly calculated.

fn size_in_bytes(&self) -> u64

The offset in bytes between successive elements in an array of this type. This should include any alignment or padding. For most types, this is simply the value of std::mem::size_of.

fn alignment_in_bytes(&self) -> u64

The alignment of the relative_offset for types stored in a RelPtr64.