Enum bvh_anim::ChannelType

pub enum ChannelType {
    RotationX,
    RotationY,
    RotationZ,
    PositionX,
    PositionY,
    PositionZ,
}

The available degrees of freedom along which a Joint may be manipulated.

Variants

RotationX

Can be rotated along the x axis.

RotationY

Can be rotated along the y axis.

RotationZ

Can be rotated along the z axis.

PositionX

Can be translated along the x axis.

PositionY

Can be translated along the y axis.

PositionZ

Can be translated along the z axis.

Methods

impl ChannelType

pub fn from_bytes<B: ?Sized>(s: &B) -> Result<Self, ParseChannelError> where
    B: AsRef<[u8]>, 

Attempt to parse a bvh channel byte string into a ChannelType. Returns Err if the string cannot be parsed.

Examples

assert_eq!(
    ChannelType::from_bytes("Xrotation").unwrap(),
    ChannelType::RotationX);

let err = ChannelType::from_bytes("Hello").unwrap_err();
assert_eq!(err.into_inner(), "Hello");

pub fn is_rotation(&self) -> bool

Returns true if this channel corresponds to a rotational transform, otherwise false.

Example

let channel_type = ChannelType::RotationX;
assert!(channel_type.is_rotation());

pub fn is_position(&self) -> bool

Returns true if this channel corresponds to a positional transform, otherwise false.

Example

let channel_type = ChannelType::PositionZ;
assert!(channel_type.is_position());

pub fn axis(&self) -> Axis

Get the Axis about which this Channel transforms.

Example

let channel_type = ChannelType::PositionX;
assert_eq!(channel_type.axis(), Axis::X);

pub fn axis_vector<T: Clone + One + Zero>(&self) -> Vector3<T>

Returns the Vector3 of the channel axis. See the Axis::vector Axis::vector method for more info.

pub fn as_str(&self) -> &'static str

Returns the string representation of the ChannelType.

pub fn as_bstr(&self) -> &'static BStr

Returns the string representation of the ChannelType.

Trait Implementations

impl Copy for ChannelType

impl PartialEq<ChannelType> for ChannelType

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

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

#[must_use]

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

This method tests for !=.

impl Clone for ChannelType

fn clone(&self) -> ChannelType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<ChannelType> for bvh_ChannelType

fn from(channel_ty: ChannelType) -> Self

Performs the conversion.

impl From<bvh_ChannelType> for ChannelType

fn from(channel_ty: bvh_ChannelType) -> Self

Performs the conversion.

impl Eq for ChannelType

impl Display for ChannelType

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

Formats the value using the given formatter.

impl Debug for ChannelType

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

Formats the value using the given formatter.

impl Hash for ChannelType

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].

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

type Error = ParseChannelError

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 ChannelType

type Error = ParseChannelError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ParseChannelError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl FromStr for ChannelType

type Err = ParseChannelError

The associated error which can be returned from parsing.

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

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