Skip to main content

AvatarSpec

Struct AvatarSpec 

Source
pub struct AvatarSpec {
    pub body_height: f32,
    /* private fields */
}
Expand description

The resolved, portable description of an avatar: which part id fills each slot, plus an overall body height. Part id 0 means “empty”. Serialize it into a save, hand it to an AvatarBuilder to render.

This is the shared wire shape across the whole Pixygon ecosystem — the same JSON the Unity AvatarSpec/AvatarData bridge and the web @pixygon/avatar Studio speak (avatar-v0.1):

{ "bodyHeight": 0.5, "parts": { "Body": 11010001, "Jacket": 123456 } }

Slot keys are the AvatarSlot names; values are the stable partIds (AvatarAsset.partId — see manifest). Never key parts by name or database id.

Fields§

§body_height: f32

0..1 — lerps the overall body scale.

Implementations§

Source§

impl AvatarSpec

Source

pub fn new() -> Self

Source

pub fn get(&self, slot: AvatarSlot) -> u32

Part id in slot, or 0 if empty.

Source

pub fn set(&mut self, slot: AvatarSlot, part_id: u32)

Place part_id in slot (id 0 clears it).

Source

pub fn has(&self, slot: AvatarSlot) -> bool

Source

pub fn clear(&mut self, slot: AvatarSlot)

Source

pub fn iter(&self) -> impl Iterator<Item = (AvatarSlot, u32)> + '_

Iterate the filled (slot, part_id) pairs.

Source

pub fn from_config(config: &HashMap<String, u32>) -> Self

Build a spec from a flat slot-name → partId config (the shape the web Studio saves and resolveAvatarConfig consumes). Unknown slot names and zero ids are skipped.

Source

pub fn to_config(&self) -> HashMap<String, u32>

The flat slot-name → partId view of this spec (filled slots only).

Source

pub fn filled_count(&self) -> usize

Trait Implementations§

Source§

impl Clone for AvatarSpec

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AvatarSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AvatarSpec

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for AvatarSpec

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for AvatarSpec

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.