Struct ssbh_lib::formats::modl::Modl

pub struct Modl {
    pub major_version: u16,
    pub minor_version: u16,
    pub model_name: SsbhString,
    pub skeleton_file_name: SsbhString,
    pub material_file_names: SsbhArray<SsbhString>,
    pub animation_file_name: RelPtr64<SsbhString>,
    pub mesh_file_name: SsbhString8,
    pub entries: SsbhArray<ModlEntry>,
}

Defines the mesh, materials, and skeleton used to render a model. Compatible with file version 1.7.

Fields

major_version: u16

minor_version: u16

model_name: SsbhString

The name of the model such as “model”.

skeleton_file_name: SsbhString

The name of the associated Skel file such as “model.nusktb”.

material_file_names: SsbhArray<SsbhString>

The names of the associated Matl files. Smash ultimate uses a single file such as “model.numatb”.

animation_file_name: RelPtr64<SsbhString>

The name of the optional associated Anim file such as “model.nuanmb”.

mesh_file_name: SsbhString8

The name of the associated Mesh file such as “model.numshb”.

entries: SsbhArray<ModlEntry>

A collection of material assignments to the MeshObject in the Mesh determined by mesh_file_name.

Implementations

impl Modl

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 Modl

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 Modl

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Modl

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

Deserialize this value from the given Serde deserializer.

impl Serialize for Modl

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 Modl

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.