pub struct Direction3d(/* private fields */);
Expand description

A normalized vector pointing in a direction in 3D space

Implementations§

source§

impl Direction3d

source

pub const X: Self = _

A unit vector pointing along the positive X axis.

source

pub const Y: Self = _

A unit vector pointing along the positive Y axis.

source

pub const Z: Self = _

A unit vector pointing along the positive Z axis.

source

pub const NEG_X: Self = _

A unit vector pointing along the negative X axis.

source

pub const NEG_Y: Self = _

A unit vector pointing along the negative Y axis.

source

pub const NEG_Z: Self = _

A unit vector pointing along the negative Z axis.

source

pub fn new(value: Vec3) -> Result<Self, InvalidDirectionError>

Create a direction from a finite, nonzero Vec3.

Returns Err(InvalidDirectionError) if the length of the given vector is zero (or very close to zero), infinite, or NaN.

source

pub fn new_unchecked(value: Vec3) -> Self

Create a Direction3d from a Vec3 that is already normalized.

Warning

value must be normalized, i.e it’s length must be 1.0.

source

pub fn new_and_length(value: Vec3) -> Result<(Self, f32), InvalidDirectionError>

Create a direction from a finite, nonzero Vec3, also returning its original length.

Returns Err(InvalidDirectionError) if the length of the given vector is zero (or very close to zero), infinite, or NaN.

source

pub fn from_xyz(x: f32, y: f32, z: f32) -> Result<Self, InvalidDirectionError>

Create a direction from its x, y, and z components.

Returns Err(InvalidDirectionError) if the length of the vector formed by the components is zero (or very close to zero), infinite, or NaN.

Methods from Deref<Target = Vec3>§

source

pub const ZERO: Vec3 = _

source

pub const ONE: Vec3 = _

source

pub const NEG_ONE: Vec3 = _

source

pub const MIN: Vec3 = _

source

pub const MAX: Vec3 = _

source

pub const NAN: Vec3 = _

source

pub const INFINITY: Vec3 = _

source

pub const NEG_INFINITY: Vec3 = _

source

pub const X: Vec3 = _

source

pub const Y: Vec3 = _

source

pub const Z: Vec3 = _

source

pub const NEG_X: Vec3 = _

source

pub const NEG_Y: Vec3 = _

source

pub const NEG_Z: Vec3 = _

source

pub const AXES: [Vec3; 3] = _

source

pub fn to_array(&self) -> [f32; 3]

[x, y, z]

source

pub fn any_orthogonal_vector(&self) -> Vec3

Returns some vector that is orthogonal to the given one.

The input vector must be finite and non-zero.

The output vector is not necessarily unit length. For that use Self::any_orthonormal_vector() instead.

source

pub fn any_orthonormal_vector(&self) -> Vec3

Returns any unit vector that is orthogonal to the given one.

The input vector must be unit length.

Panics

Will panic if self is not normalized when glam_assert is enabled.

source

pub fn any_orthonormal_pair(&self) -> (Vec3, Vec3)

Given a unit vector return two other vectors that together form an orthonormal basis. That is, all three vectors are orthogonal to each other and are normalized.

Panics

Will panic if self is not normalized when glam_assert is enabled.

source

pub fn as_dvec3(&self) -> DVec3

Casts all elements of self to f64.

source

pub fn as_i16vec3(&self) -> I16Vec3

Casts all elements of self to i16.

source

pub fn as_u16vec3(&self) -> U16Vec3

Casts all elements of self to u16.

source

pub fn as_ivec3(&self) -> IVec3

Casts all elements of self to i32.

source

pub fn as_uvec3(&self) -> UVec3

Casts all elements of self to u32.

source

pub fn as_i64vec3(&self) -> I64Vec3

Casts all elements of self to i64.

source

pub fn as_u64vec3(&self) -> U64Vec3

Casts all elements of self to u64.

Trait Implementations§

source§

impl Clone for Direction3d

source§

fn clone(&self) -> Direction3d

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Direction3d

source§

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

Formats the value using the given formatter. Read more
source§

impl Deref for Direction3d

§

type Target = Vec3

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl<'de> Deserialize<'de> for Direction3d

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl From<Direction3d> for Vec3

source§

fn from(value: Direction3d) -> Self

Converts to this type from the input type.
source§

impl Mul<Direction3d> for Quat

source§

fn mul(self, direction: Direction3d) -> Self::Output

Rotates the Direction3d using a Quat.

§

type Output = Direction3d

The resulting type after applying the * operator.
source§

impl Mul<f32> for Direction3d

§

type Output = Vec3

The resulting type after applying the * operator.
source§

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

Performs the * operation. Read more
source§

impl Neg for Direction3d

§

type Output = Direction3d

The resulting type after applying the - operator.
source§

fn neg(self) -> Self::Output

Performs the unary - operation. Read more
source§

impl PartialEq for Direction3d

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for Direction3d

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl TryFrom<Vec3> for Direction3d

§

type Error = InvalidDirectionError

The type returned in the event of a conversion error.
source§

fn try_from(value: Vec3) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl Copy for Direction3d

source§

impl Primitive3d for Direction3d

source§

impl StructuralPartialEq for Direction3d

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,