Struct Animation 

pub struct Animation {
    pub header: AnimationHeader,
    pub joints: Vec<JointData>,
    pub constraints: Vec<Constraint>,
}

Fields

header: AnimationHeader

joints: Vec<JointData>

constraints: Vec<Constraint>

Implementations

impl Animation

pub fn new() -> Self

pub fn set_priority(&mut self, priority: i32) -> &mut Self

pub fn set_duration(&mut self, duration: f32) -> &mut Self

pub fn set_joint_priority(&mut self, priority: i32) -> &mut Self

pub fn drop_empty_joints(&mut self) -> &mut Self

pub fn drop_position_keys(&mut self) -> &mut Self

pub fn drop_position( &mut self, joints: impl Fn(&JointData) -> bool, ) -> &mut Self

pub fn drop_zero_position_keys(&mut self, epsilon: f32) -> &mut Self

pub fn drop_rotation_keys(&mut self) -> &mut Self

pub fn drop_rotation( &mut self, joints: impl Fn(&JointData) -> bool, ) -> &mut Self

pub fn cleanup_keys(&mut self) -> &mut Self

pub fn cleanup_keys_with(&mut self, strategy: DuplicateKeyStrategy) -> &mut Self

Cleanup duplicate keyframe times with a customizable strategy.

pub fn joint(&self, name: &str) -> Option<&JointData>

pub fn joint_mut(&mut self, name: &str) -> Option<&mut JointData>

pub fn position_reset_from_skeleton<'a>( skeleton: &SkeletonDefinition, joint_names: impl IntoIterator<Item = &'a str>, priority: i32, ) -> Result<Self>

pub fn position_reset_from_bones<'a>( bones: impl IntoIterator<Item = &'a SkeletonBone>, priority: i32, ) -> Result<Self>

pub fn add_skeleton_positions( &mut self, skeleton: &SkeletonDefinition, ) -> Result<&mut Self>

pub fn from_llsd(llsd: &Llsd, check_enabled: bool) -> Result<Self>

Creates an animation from LLSD data, typically from Firestorm poser files.

This function parses LLSD-XML data exported by Firestorm’s poser system and converts it into an animation structure. Firestorm stores pose data in LLSD-XML format in the user’s configuration directory.

Arguments

• llsd - The parsed LLSD data containing joint poses
• check_enabled - If true, only includes joints where the “enabled” field is true

File Locations

Firestorm poser files are typically found at:

• Linux: ~/.firestorm_x64/user_settings/poses/
• Windows: %APPDATA%/Firestorm_x64/user_settings/poses/
• macOS: ~/Library/Application Support/Firestorm_x64/user_settings/poses/

Example

use std::fs::File;
use std::io::BufReader;
use avatar_anim::Animation;

// Load LLSD-XML file from Firestorm poses directory
let file = BufReader::new(File::open("my_pose.xml")?);
let llsd = llsd_rs::xml::from_reader(file).map_err(|e| avatar_anim::AnimError::Llsd(e.to_string()))?;

// Convert to animation, including only enabled joints
let animation = Animation::from_llsd(&llsd, true)?;

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self>

Load an animation from a .anim file

Example

use avatar_anim::Animation;

let animation = Animation::from_file("my_animation.anim")?;

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

Save an animation to a .anim file

Example

use avatar_anim::Animation;

let animation = Animation::default();
animation.to_file("output.anim")?;

pub fn from_llsd_file<P: AsRef<Path>>( path: P, check_enabled: bool, ) -> Result<Self>

Load LLSD-XML data from a Firestorm pose file

Example

use avatar_anim::Animation;

let animation = Animation::from_llsd_file("pose.xml", true)?;

Trait Implementations

impl BinRead for Animation

type Args<'a> = ()

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

fn read_options<R: Read + Seek>( reader: &mut R, endian: Endian, _args: 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 BinWrite for Animation

type Args<'a> = ()

The type used for the args parameter of write_args() and write_options().

fn write_options<W: Write + Seek>( &self, writer: &mut W, endian: Endian, _args: Self::Args<'_>, ) -> BinResult<()>

Write Self to the writer using the given Endian and arguments.

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

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming big-endian byte order.

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

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming little-endian byte order.

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

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming native-endian byte order.

fn write_be_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming big-endian byte order, using the given arguments.

fn write_le_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming little-endian byte order, using the given arguments.

fn write_ne_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming native-endian byte order, using the given arguments.

impl Clone for Animation

fn clone(&self) -> Animation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Animation

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

Formats the value using the given formatter.

impl Default for Animation

fn default() -> Animation

Returns the “default value” for a type.

impl PartialEq for Animation

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Animation