Struct bvh_anim::Bvh

pub struct Bvh { /* fields omitted */ }

A complete bvh file.

See the module documentation for more information.

Methods

impl Bvh

pub unsafe fn from_ffi(bvh: bvh_BvhFile) -> Result<Self, ()>

Construct a Bvh from a ffi::bvh_BvhFile.

Notes

This method is only present if the ffi feature is enabled.

Safety

This operation is unsafe because bvh may point to memory not allocated by the rust allocator, which may cause memory errors.

In addition, this method will take ownership of memory which was owned by bvh, which may cause corruption if there are still references to bvh's data.

pub fn into_ffi(self) -> bvh_BvhFile

Converts the Bvh into a ffi::bvh_BvhFile, using the default bvh_AllocCallbacks.

Notes

This method is only present if the ffi feature is enabled.

pub fn into_ffi_with_allocator(
    self,
    bvh_allocator: bvh_AllocCallbacks,
    joints_allocator: bvh_AllocCallbacks
) -> Result<bvh_BvhFile, ()>

Converts the Bvh into a ffi::bvh_BvhFile, using the given allocator callbacks to allocate memory.

Notes

This method is only present if the ffi feature is enabled.

If both allocators are the default allocators, this method will use the rust allocator, and will move the pointers over without copying them.

impl Bvh

pub fn new() -> Self

Create an empty Bvh.

pub fn from_bytes<B: AsRef<[u8]>>(bytes: B) -> Result<Self, LoadError>

Parse a sequence of bytes as if it were an in-memory Bvh file.

Examples

let bvh_string = br#"
    HIERARCHY
    ROOT Hips
    {
        OFFSET 0.0 0.0 0.0
        CHANNELS 3 Xposition Yposition Zposition
        End Site
        {
            OFFSET 0.0 0.0 0.0
        }
    }
    MOTION
    Frames: 1
    Frame Time: 0.033333333
    0.0 0.0 0.0
"#;

let bvh = Bvh::from_bytes(&bvh_string[..])?;

pub fn from_reader<R: BufReadExt>(reader: R) -> Result<Self, LoadError>

Loads the Bvh from the reader.

pub fn write_to<W: Write>(&self, writer: &mut W) -> Result<()>

Writes the Bvh using the bvh file format to the writer, with the default formatting options.

Notes

To customise the formatting, see the WriteOptions type.

Examples

let bvh = bvh! {
    // fields unspecified
};

let mut out_file = File::create("./out_file.bvh")?;
bvh.write_to(&mut out_file)?;

pub fn to_bstring(&self) -> BString

Writes the Bvh using the bvh file format into a BString with the default formatting options.

Notes

To customise the formatting, see the WriteOptions type.

pub fn root_joint(&self) -> Option<Joint>

Returns the root joint if it exists, or None if the skeleton is empty.

Examples

let bvh = Bvh::new();
assert!(bvh.root_joint().is_none());

let bvh = bvh! {
    HIERARCHY
    ROOT Hips
    {
        // Joints...
    }
    MOTION
    // Frames...
};

assert!(bvh.root_joint().is_some());

Important traits for Joints<'a>

impl<'a> Iterator for Joints<'a> type Item = Joint<'a>;

pub fn joints(&self) -> Joints

Returns an iterator over all the Joints in the Bvh.

Important traits for JointsMut<'a>

impl<'a> Iterator for JointsMut<'a> type Item = JointMut<'a>;

pub fn joints_mut(&mut self) -> JointsMut

Returns a mutable iterator over all the joints in the Bvh.

Important traits for Frames<'a>

impl<'a> Iterator for Frames<'a> type Item = &'a Frame;

pub fn frames(&self) -> Frames

Returns a Frames iterator over the frames of the bvh.

Important traits for FramesMut<'a>

impl<'a> Iterator for FramesMut<'a> type Item = &'a mut Frame;

pub fn frames_mut(&mut self) -> FramesMut

Returns a mutable iterator over the frames of the bvh.

pub fn get_motion(&self, frame: usize, channel: &Channel) -> f32

Gets the motion value at frame and Channel.

Panics

This method will panic if frame is greater than self.num_frames().

pub fn try_get_motion(&self, frame: usize, channel: &Channel) -> Option<f32>

Returns the motion value at frame and channel if they are in bounds, None otherwise.

pub fn set_motion(&mut self, frame: usize, channel: &Channel, new_motion: f32)

Updates the motion value at frame and channel to new_motion.

Panics

This method will panic if frame is greater than self.num_frames().

pub fn try_set_motion<'a>(
    &mut self,
    frame: usize,
    channel: &'a Channel,
    new_motion: f32
) -> Result<(), SetMotionError<'a>>

Updates the motion value at frame and channel to new_motion.

Notes

Returns Ok(()) if the motion value was successfully set, and Err(_) if the operation was out of bounds.

pub const fn num_frames(&self) -> usize

Get the number of frames in the Bvh.

pub const fn num_channels(&self) -> usize

Get the number of channels in the Bvh.

pub const fn frame_time(&self) -> &Duration

Get the duration each frame should play for in the Bvh.

pub fn set_frame_time(&mut self, new_frame_time: Duration)

Set the duration each frame should play for in the Bvh to new_frame_time.

Trait Implementations

impl PartialEq<Bvh> for Bvh

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

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

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

This method tests for !=.

impl Default for Bvh

fn default() -> Bvh

Returns the "default value" for a type.

impl Clone for Bvh

fn clone(&self) -> Bvh

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Bvh> for bvh_BvhFile

fn from(bvh: Bvh) -> Self

Performs the conversion.

impl Display for Bvh

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

Formats the value using the given formatter.

impl Debug for Bvh

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

Formats the value using the given formatter.

impl<'_> TryFrom<&'_ str> for Bvh

type Error = LoadError

The type returned in the event of a conversion error.

fn try_from(string: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_> TryFrom<&'_ BStr> for Bvh

type Error = LoadError

The type returned in the event of a conversion error.

fn try_from(string: &BStr) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_> TryFrom<&'_ [u8]> for Bvh

type Error = LoadError

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl FromStr for Bvh

type Err = LoadError

The associated error which can be returned from parsing.

fn from_str(string: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.