Struct bvh_anim::write::WriteOptions

pub struct WriteOptions {
    pub indent: IndentStyle,
    pub line_terminator: LineTerminator,
    pub offset_significant_figures: usize,
    pub frame_time_significant_figures: usize,
    pub motion_values_significant_figures: usize,
    // some fields omitted
}

Specify formatting options for writing a Bvh.

Fields

indent: IndentStyle

Which indentation style to use for nested bones.

line_terminator: LineTerminator

Which style new line terminator to use when writing the bvh.

offset_significant_figures: usize

Number of significant figures to use when writing OFFSET values.

frame_time_significant_figures: usize

Number of significant figures to use when writing the Frame Time value.

motion_values_significant_figures: usize

Number of significant figures to use when writing MOTION values.

Methods

impl WriteOptions

pub fn new() -> Self

Create a new WriteOptions with default values.

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

Output the Bvh file to the writer with the given options.

pub fn write_to_string(&self, bvh: &Bvh) -> BString

Output the Bvh file to the string with the given options.

pub const fn with_indent(self, indent: IndentStyle) -> Self

Sets indent on self to the new IndentStyle.

pub fn with_line_terminator(self, line_terminator: LineTerminator) -> Self

Sets line_terminator on self to the new LineTerminator.

pub const fn with_offset_significant_figures(
    self,
    offset_significant_figures: usize
) -> Self

Sets offset_significant_figures on self to the new offset_significant_figures.

pub const fn with_frame_time_significant_figures(
    self,
    frame_time_significant_figures: usize
) -> Self

Sets motion_values_significant_figures on self to the new motion_values_significant_figures.

pub const fn with_motion_values_significant_figures(
    self,
    motion_values_significant_figures: usize
) -> Self

Sets motion_values_significant_figures on self to the new motion_values_significant_figures.

Trait Implementations

impl PartialEq<WriteOptions> for WriteOptions

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

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

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

This method tests for !=.

impl Default for WriteOptions

fn default() -> Self

Returns the "default value" for a type.

impl Clone for WriteOptions

fn clone(&self) -> WriteOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for WriteOptions

impl Debug for WriteOptions

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

Formats the value using the given formatter.

impl Hash for WriteOptions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].