Struct ssbh_lib::formats::adj::Adj

pub struct Adj {
    pub entries: Vec<AdjEntry>,
    pub index_buffer: Vec<i16>,
}

Mesh adjacency data for model.adjb files.

Fields

entries: Vec<AdjEntry>

A collection containing an entry for each MeshObject with adjacency information in index_buffer

index_buffer: Vec<i16>

A flattened list of adjacent vertex indices for entries

Each vertex for each MeshObject stores the indices for vertices from adjacent faces in the corresponding section of the buffer. The shared vertex for the adjacent face is not explicitly stored, so an adjacent triangle can be encoded as just two index values.

The section of adjacent vertices for each vertex is padded with the value -1. to ensure all vertices have an equal number of buffer elements. The shared vertex of each face is implied. For example, the vertex with index 0 is adjacent to the triangle face with vertex indices (0, 1, 2). This would be encoded in the buffer as [1, 2, -1, -1, ...].

Smash Ultimate uses 18 elements for each vertex. This allows for 9 adjacent triangle faces instead of 6 since we omit the shared vertex.

Implementations

impl Adj

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

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

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

Tries to read the 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<()>

Tries to write the type to writer. For best performance when writing to a file, use write_to_file instead.

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

Tries to write the type to path. The entire file is buffered for performance.

Trait Implementations

impl BinRead for Adj

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of read_args() and read_options().

fn read_options<R: Read + Seek>( __binrw_generated_var_reader: &mut R, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_> ) -> BinResult<Self>

Read Self from the reader using the given Endian and arguments.

fn read_be<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming big-endian byte order.

fn read_le<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming little-endian byte order.

fn read_ne<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read T from the reader assuming native-endian byte order.

fn read_be_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming big-endian byte order, using the given arguments.

fn read_le_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming little-endian byte order, using the given arguments.

fn read_ne_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read T from the reader, assuming native-endian byte order, using the given arguments.

impl Debug for Adj

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

Formats the value using the given formatter.

impl PartialEq for Adj

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SsbhWrite for Adj

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

Writes the byte representation of self to writer. data_ptr is assumed to be the absolute offset where the next data stored behind an offset will be written. Struct that contains no offsets as fields can skip updating data_ptr.

fn write<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek,

Writes the byte representation of self to writer. This is a convenience method for ssbh_write that handles initializing the data pointer.

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.

fn alignment_in_bytes() -> u64

The alignment for pointers of this type, which is useful for offset calculations.

impl Eq for Adj

impl StructuralPartialEq for Adj