Struct ssbh_lib::formats::mesh::Mesh

pub struct Mesh {
    pub major_version: u16,
    pub minor_version: u16,
    pub model_name: SsbhString,
    pub bounding_info: BoundingInfo,
    pub unk1: u32,
    pub objects: SsbhArray<MeshObject>,
    pub buffer_sizes: SsbhArray<u32>,
    pub polygon_index_size: u64,
    pub vertex_buffers: SsbhArray<SsbhByteBuffer>,
    pub index_buffer: SsbhByteBuffer,
    pub rigging_buffers: SsbhArray<MeshRiggingGroup>,
}

The vertex buffers and associated geometric data for a mesh. Compatible with file version 1.8 and 1.10.

Fields

major_version: u16

minor_version: u16

model_name: SsbhString

bounding_info: BoundingInfo

unk1: u32

objects: SsbhArray<MeshObject>

buffer_sizes: SsbhArray<u32>

polygon_index_size: u64

vertex_buffers: SsbhArray<SsbhByteBuffer>

The shared buffers for vertex attribute data such as positions and normals for all the MeshObject in objects.

index_buffer: SsbhByteBuffer

The shared buffer for vertex indices for all the MeshObject in objects.

rigging_buffers: SsbhArray<MeshRiggingGroup>

A collection of vertex skinning data stored as a one to many mapping from MeshObject to SkelBoneEntry. The collection should be sorted in ascending order based on mesh_object_name and mesh_object_sub_index. This is likely to facilitate an efficient binary search by MeshObject.

Implementations

impl Mesh

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 Mesh

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 Mesh

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Mesh

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

Deserialize this value from the given Serde deserializer.

impl Serialize for Mesh

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 Mesh

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.