Enum ssbh_data::skel_data::BillboardType

pub enum BillboardType {
    Disabled = 0,
    XAxisViewPointAligned = 1,
    YAxisViewPointAligned = 2,
    Unk3 = 3,
    XYAxisViewPointAligned = 4,
    YAxisViewPlaneAligned = 6,
    XYAxisViewPlaneAligned = 8,
}

Billboarding reorients a MeshObject parented to a bone based on the camera. This effect is commonly used for 2D sprites for particles and distant objects like trees.

View plane alignment does not take into account the object’s position. This means a rectangular sprite will not appear distorted regardless of its position on screen. For aligning a rectangular sprite to the screen with no distortion, use BillboardType::XYAxisViewPlaneAligned.

Viewpoint oriented billboards do take into account the object’s position. This means a rectangular sprite positioned on the edges of the screen will appear slightly warped due to perspective projection. For example, BillboardType::XYAxisViewPointAligned will appear to point towards the camera axes at the center of the screen in pause mode in Smash Ultimate.

Variants

Disabled = 0

Disable billboarding for this bone.

XAxisViewPointAligned = 1

The bone rotates along the X-axis to face the camera.

YAxisViewPointAligned = 2

The bone rotates along the Y-axis to face the camera.

Unk3 = 3

Likely identical to BillboardType::Disabled

XYAxisViewPointAligned = 4

The bone rotates along the X and Y axes to face the camera.

YAxisViewPlaneAligned = 6

The bone rotates along the Y-axis to face the camera.

XYAxisViewPlaneAligned = 8

The bone rotates along the X and Y axes to face the camera.

Trait Implementations

impl BinRead for BillboardType

type Args<'__binrw_generated_args_lifetime> = ()

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

fn read_options<R>( __binrw_generated_var_reader: &mut R, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: <BillboardType as BinRead>::Args<'_> ) -> Result<BillboardType, Error>

where R: Read + Seek,

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

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

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

Read Self from the reader using default 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_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek, Self: ReadEndian,

Read Self from the reader using the given arguments.

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 Clone for BillboardType

fn clone(&self) -> BillboardType

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BillboardType

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

Formats the value using the given formatter.

impl PartialEq for BillboardType

fn eq(&self, other: &BillboardType) -> 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 ReadEndian for BillboardType

const ENDIAN: EndianKind = <u8 as binrw::meta::ReadEndian>::ENDIAN

The endianness of the type.

impl SsbhWrite for BillboardType

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

where W: Write + Seek,

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

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.

impl Copy for BillboardType

impl Eq for BillboardType

impl StructuralPartialEq for BillboardType