Struct ssbh_lib::formats::anim::Anim

pub struct Anim {
    pub major_version: u16,
    pub minor_version: u16,
    pub final_frame_index: f32,
    pub unk1: u16,
    pub unk2: u16,
    pub name: SsbhString,
    pub animations: SsbhArray<AnimGroup>,
    pub buffer: SsbhByteBuffer,
    pub unk_data: Option<UnkData>,
}

Skeletal and material animation. Compatible with file version 2.0 and 2.1.

Fields

major_version: u16

minor_version: u16

final_frame_index: f32

unk1: u16

unk2: u16

name: SsbhString

animations: SsbhArray<AnimGroup>

buffer: SsbhByteBuffer

unk_data: Option<UnkData>

Implementations

impl Anim

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

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

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 Anim

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 Anim

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Anim

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

Deserialize this value from the given Serde deserializer.

impl Serialize for Anim

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 Anim

fn write_ssbh<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.