Struct EulerAngles

pub struct EulerAngles(/* private fields */);

Euler angles are a representation of orientation in 3D space.

Implementations

impl EulerAngles

pub fn new<A: Angle>(yaw: A, pitch: A, roll: A) -> Self

Create a new Euler angle with the given yaw, pitch, and roll.

Parameters

• yaw - The yaw angle.
• pitch - The pitch angle.
• roll - The roll angle.

pub const fn from_radians(yaw: Radian, pitch: Radian, roll: Radian) -> Self

Create a new Euler angle with the given yaw, pitch, and roll in radians.

Parameters

• yaw - The yaw angle in radians.
• pitch - The pitch angle in radians.
• roll - The roll angle in radians.

pub fn from_yaw<A: Angle>(yaw: A) -> Self

Create a new Euler angle with the given yaw.

Parameters

• yaw - The yaw angle.

pub fn from_pitch<A: Angle>(pitch: A) -> Self

Create a new Euler angle with the given pitch.

Parameters

• pitch - The pitch angle.

pub fn from_roll<A: Angle>(roll: A) -> Self

Create a new Euler angle with the given roll.

Parameters

• roll - The roll angle.

impl EulerAngles

pub const fn as_vec3(&self) -> &Vec3

Convert the Euler angles to a 3D vector.

pub fn as_vec3_mut(&mut self) -> &mut Vec3

Convert the Euler angles to a mutable 3D vector.

pub fn to_tuple<A: Angle>(&self) -> (A, A, A)

Convert the Euler angles to a tuple of yaw, pitch, and roll.

impl EulerAngles

pub const fn yaw(&self) -> Radian

Return the yaw angle of the Euler angles.

pub const fn pitch(&self) -> Radian

Return the pitch angle of the Euler angles.

pub const fn roll(&self) -> Radian

Return the roll angle of the Euler angles.

pub fn yaw_mut(&mut self) -> &mut Radian

Return a mutable reference to the yaw angle of the Euler angles.

pub fn pitch_mut(&mut self) -> &mut Radian

Return a mutable reference to the pitch angle of the Euler angles.

pub fn roll_mut(&mut self) -> &mut Radian

Return a mutable reference to the roll angle of the Euler angles.

impl EulerAngles

pub fn set_yaw<A: Angle>(&mut self, yaw: A)

Set the yaw angle of the Euler angles.

Parameters

• yaw - The new yaw angle.

pub fn set_pitch<A: Angle>(&mut self, pitch: A)

Set the pitch angle of the Euler angles.

Parameters

• pitch - The new pitch angle.

pub fn set_roll<A: Angle>(&mut self, roll: A)

Set the roll angle of the Euler angles.

Parameters

• roll - The new roll angle.

Methods from Deref<Target = Vec3>

pub fn as_slice(&self) -> &[f32]

Returns this Vec3 as a slice of f32.

pub fn as_mut_slice(&mut self) -> &mut [f32]

Returns this Vec3 as a mutable slice of f32.

pub fn as_ptr(&self) -> *const f32

Returns this vector as a ptr of f32.

pub fn as_mut_ptr(&mut self) -> *mut f32

Returns this vector as a mutable ptr of f32.

pub fn iter(&self) -> impl Iterator<Item = &f32>

Returns an iterator over the vector.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut f32>

Returns a mutable iterator over the vector.

pub fn x(&self) -> f32

Returns the X-coordinate of this 3-component vector.

pub fn y(&self) -> f32

Returns the Y-coordinate of this 3-component vector.

pub fn z(&self) -> f32

Returns the Z-coordinate of this 3-component vector.

pub fn xy(&self) -> &Vec2

Returns the xy coordinates of this vector as a Vec3.

pub fn yz(&self) -> &Vec2

Returns the yz coordinates of this vector as a Vec3.

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

Returns a mutable reference to the X-coordinate of this 3-component vector.

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

Returns a mutable reference to the Y-coordinate of this 3-component vector.

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

Returns a mutable reference to the Z-coordinate of this 3-component vector.

pub fn xy_mut(&mut self) -> &mut Vec2

Returns a mutable reference to the xy coordinates of this vector.

pub fn yz_mut(&mut self) -> &mut Vec2

Returns a mutable reference to the yz coordinates of this vector.

pub fn set_x(&mut self, x: f32)

Sets the x-component

Parameters

• x - the X-component

pub fn set_y(&mut self, y: f32)

Sets the y-component

Parameters

• y - the Y-component

pub fn set_z(&mut self, z: f32)

Sets the z-component

Parameters

• z - the Z-component

pub fn set_xy(&mut self, xy: &Vec2)

Sets the X and Y components of this vector

Parameters

• xy - the X and Y components o

pub fn set_yz(&mut self, xy: &Vec2)

Sets the Y and Z components of this vector

Parameters

• yz - the Y and Z components of the Vec3

pub fn set(&mut self, other: &Vec3)

Sets all the components of this vector the values from other.

Parameters

• other - the other Vec3 to set.

pub fn square_magnitude(&self) -> f32

Computes the square magnitude of this two-component vector.

pub fn magnitude(&self) -> f32

Computes the magnitude of this vector.

Where possible, consider using Vec3::square_magnitude as this will avoid the need to compute the square-root.

pub fn is_normalized(&self) -> bool

Queries whether this vector is normalized (e.g. has a magnitude of 1).

pub fn normalize(&mut self)

Normalizes this vector.

pub fn normalized(&self) -> Vector3

Returns normalized vector.

pub fn rotate_x<A: Angle>(&mut self, angle: A)

Rotates this vector around the X axis by angle A.

Parameters

• angle - the angle to rotate

pub fn rotate_y<A: Angle>(&mut self, angle: A)

Rotates this vector around the Y axis by angle A.

Parameters

• angle - the angle to rotate

pub fn rotate_z<A: Angle>(&mut self, angle: A)

Rotates this vector around the Y axis by angle A.

Parameters

• angle - the angle to rotate

pub fn is_finite(&self) -> bool

Returns whether all components of this Vec are finite.

Example

Basic use:

let finite = Vector3::UNIT_X;
let not_finite = Vector3::new(f32::INFINITY, 3.0, 0.0);

assert!(finite.is_finite());
assert!(!not_finite.is_finite());

pub fn is_infinite(&self) -> bool

Returns whether any component of this vec are infinite.

This is the inverse operation of is_finite.

Example

Basic use:

let finite = Vector3::UNIT_X;
let not_finite = Vector3::new(f32::INFINITY, 3.0, 0.0);

assert!(!finite.is_infinite());
assert!(not_finite.is_infinite());

pub fn is_nan(&self) -> bool

Returns whether any component of this vec are nan.

pub fn abs(&self) -> Vector3

Computes the absolute value of self

pub fn min(&self, rhs: &Vec3) -> Vector3

Computes the minimum of each vector.

Parameters

• lhs - the left vector
• rhs - the right vector

pub fn max(&self, rhs: &Vec3) -> Vector3

Computes the maximum of each vector.

Parameters

• lhs - the left vector
• rhs - the right vector

Trait Implementations

impl Add for &EulerAngles

type Output = EulerAngles

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl Add for EulerAngles

type Output = EulerAngles

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign<&EulerAngles> for EulerAngles

fn add_assign(&mut self, rhs: &EulerAngles)

Performs the += operation.

impl AddAssign for EulerAngles

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl AsMut<Vec3> for EulerAngles

fn as_mut(&mut self) -> &mut Vec3

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<Vec3> for EulerAngles

fn as_ref(&self) -> &Vec3

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<Vec3> for EulerAngles

fn borrow(&self) -> &Vec3

Immutably borrows from an owned value.

impl BorrowMut<Vec3> for EulerAngles

fn borrow_mut(&mut self) -> &mut Vec3

Mutably borrows from an owned value.

impl Clone for EulerAngles

fn clone(&self) -> EulerAngles

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EulerAngles

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

Formats the value using the given formatter.

impl Default for EulerAngles

fn default() -> EulerAngles

Returns the “default value” for a type.

impl Deref for EulerAngles

type Target = Vec3

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for EulerAngles

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Div<f32> for &EulerAngles

type Output = EulerAngles

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Self::Output

Performs the / operation.

impl Div<f32> for EulerAngles

type Output = EulerAngles

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Self::Output

Performs the / operation.

impl Mul<&EulerAngles> for f32

type Output = EulerAngles

The resulting type after applying the * operator.

fn mul(self, rhs: &EulerAngles) -> Self::Output

Performs the * operation.

impl Mul<EulerAngles> for f32

type Output = EulerAngles

The resulting type after applying the * operator.

fn mul(self, rhs: EulerAngles) -> Self::Output

Performs the * operation.

impl Mul<f32> for &EulerAngles

type Output = EulerAngles

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Self::Output

Performs the * operation.

impl Mul<f32> for EulerAngles

type Output = EulerAngles

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Self::Output

Performs the * operation.

impl PartialEq for EulerAngles

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Sub for &EulerAngles

type Output = EulerAngles

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl Sub for EulerAngles

type Output = EulerAngles

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign<&EulerAngles> for EulerAngles

fn sub_assign(&mut self, rhs: &EulerAngles)

Performs the -= operation.

impl SubAssign for EulerAngles

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for EulerAngles

impl StructuralPartialEq for EulerAngles