Skip to main content

Anim

Struct Anim 

Source
pub struct Anim { /* private fields */ }
Expand description

Partially decoded animation file.

Contains parsed header metadata and raw binary animation data. The header provides information about the animation’s properties, while the actual keyframe data remains in binary form.

§Fields

  • version - Animation file format version
  • uk_1 - Unknown field (purpose not yet identified)
  • frame_rate - Animation playback speed in frames per second
  • skeleton_name - Name of the skeleton this animation is for
  • end_time - Animation duration in seconds
  • bone_count - Number of bones animated in this file
  • data - Raw binary animation data (keyframes, curves, etc.)

§Getters/Setters

All fields have public getters, mutable getters, and setters via the getset crate:

  • version(), version_mut(), set_version()
  • uk_1(), uk_1_mut(), set_uk_1()
  • frame_rate(), frame_rate_mut(), set_frame_rate()
  • skeleton_name(), skeleton_name_mut(), set_skeleton_name()
  • end_time(), end_time_mut(), set_end_time()
  • bone_count(), bone_count_mut(), set_bone_count()
  • data(), data_mut(), set_data()

§Example

use rpfm_lib::files::{Decodeable, anim::Anim};
use std::io::Cursor;

let mut reader = Cursor::new(anim_data);
let anim = Anim::decode(&mut reader, &None).unwrap();

// Check if animation matches expected skeleton
if anim.skeleton_name().contains("humanoid") {
    println!("Found humanoid animation: {} seconds at {} fps",
        anim.end_time(), anim.frame_rate());
}

Implementations§

Source§

impl Anim

Source

pub fn version(&self) -> &u32

Animation file format version.

Source

pub fn uk_1(&self) -> &u32

Unknown field (purpose not yet identified).

Source

pub fn frame_rate(&self) -> &f32

Animation playback speed in frames per second.

Source

pub fn skeleton_name(&self) -> &String

Name of the skeleton this animation targets.

Source

pub fn end_time(&self) -> &f32

Animation duration in seconds.

Source

pub fn bone_count(&self) -> &u32

Number of bones animated in this file.

Source

pub fn data(&self) -> &Vec<u8>

Raw binary animation data (keyframes, curves, etc.).

Source§

impl Anim

Source

pub fn version_mut(&mut self) -> &mut u32

Animation file format version.

Source

pub fn uk_1_mut(&mut self) -> &mut u32

Unknown field (purpose not yet identified).

Source

pub fn frame_rate_mut(&mut self) -> &mut f32

Animation playback speed in frames per second.

Source

pub fn skeleton_name_mut(&mut self) -> &mut String

Name of the skeleton this animation targets.

Source

pub fn end_time_mut(&mut self) -> &mut f32

Animation duration in seconds.

Source

pub fn bone_count_mut(&mut self) -> &mut u32

Number of bones animated in this file.

Source

pub fn data_mut(&mut self) -> &mut Vec<u8>

Raw binary animation data (keyframes, curves, etc.).

Source§

impl Anim

Source

pub fn set_version(&mut self, val: u32) -> &mut Self

Animation file format version.

Source

pub fn set_uk_1(&mut self, val: u32) -> &mut Self

Unknown field (purpose not yet identified).

Source

pub fn set_frame_rate(&mut self, val: f32) -> &mut Self

Animation playback speed in frames per second.

Source

pub fn set_skeleton_name(&mut self, val: String) -> &mut Self

Name of the skeleton this animation targets.

Source

pub fn set_end_time(&mut self, val: f32) -> &mut Self

Animation duration in seconds.

Source

pub fn set_bone_count(&mut self, val: u32) -> &mut Self

Number of bones animated in this file.

Source

pub fn set_data(&mut self, val: Vec<u8>) -> &mut Self

Raw binary animation data (keyframes, curves, etc.).

Trait Implementations§

Source§

impl Clone for Anim

Source§

fn clone(&self) -> Anim

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Anim

Source§

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

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

impl Decodeable for Anim

Source§

fn decode<R: ReadBytes>( data: &mut R, _extra_data: &Option<DecodeableExtraData<'_>>, ) -> Result<Self>

Decodes binary data into the implementing type. Read more
Source§

impl Default for Anim

Source§

fn default() -> Anim

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

impl<'de> Deserialize<'de> for Anim

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 Encodeable for Anim

Source§

fn encode<W: WriteBytes>( &mut self, buffer: &mut W, _extra_data: &Option<EncodeableExtraData<'_>>, ) -> Result<()>

Encodes the implementing type into binary data. Read more
Source§

impl PartialEq for Anim

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Anim

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
Source§

impl StructuralPartialEq for Anim

Auto Trait Implementations§

§

impl Freeze for Anim

§

impl RefUnwindSafe for Anim

§

impl Send for Anim

§

impl Sync for Anim

§

impl Unpin for Anim

§

impl UnsafeUnpin for Anim

§

impl UnwindSafe for Anim

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

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

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

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

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

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

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

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

Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,