Struct bevy_math::primitives::Direction3d

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

A normalized vector pointing in a direction in 3D space

Implementations

impl Direction3d

pub const X: Self = _

A unit vector pointing along the positive X axis.

pub const Y: Self = _

A unit vector pointing along the positive Y axis.

pub const Z: Self = _

A unit vector pointing along the positive Z axis.

pub const NEG_X: Self = _

A unit vector pointing along the negative X axis.

pub const NEG_Y: Self = _

A unit vector pointing along the negative Y axis.

pub const NEG_Z: Self = _

A unit vector pointing along the negative Z axis.

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.

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.

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.

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>

pub const ZERO: Vec3 = _

pub const ONE: Vec3 = _

pub const NEG_ONE: Vec3 = _

pub const MIN: Vec3 = _

pub const MAX: Vec3 = _

pub const NAN: Vec3 = _

pub const INFINITY: Vec3 = _

pub const NEG_INFINITY: Vec3 = _

pub const X: Vec3 = _

pub const Y: Vec3 = _

pub const Z: Vec3 = _

pub const NEG_X: Vec3 = _

pub const NEG_Y: Vec3 = _

pub const NEG_Z: Vec3 = _

pub const AXES: [Vec3; 3] = _

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

[x, y, z]

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.

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.

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.

pub fn as_dvec3(&self) -> DVec3

Casts all elements of self to f64.

pub fn as_i16vec3(&self) -> I16Vec3

Casts all elements of self to i16.

pub fn as_u16vec3(&self) -> U16Vec3

Casts all elements of self to u16.

pub fn as_ivec3(&self) -> IVec3

Casts all elements of self to i32.

pub fn as_uvec3(&self) -> UVec3

Casts all elements of self to u32.

pub fn as_i64vec3(&self) -> I64Vec3

Casts all elements of self to i64.

pub fn as_u64vec3(&self) -> U64Vec3

Casts all elements of self to u64.

Trait Implementations

impl Clone for Direction3d

fn clone(&self) -> Direction3d

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Direction3d

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

Formats the value using the given formatter.

impl Deref for Direction3d

type Target = Vec3

The resulting type after dereferencing.

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

Dereferences the value.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Direction3d> for Vec3

fn from(value: Direction3d) -> Self

Converts to this type from the input type.

impl Mul<Direction3d> for Quat

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

Rotates the Direction3d using a Quat.

type Output = Direction3d

The resulting type after applying the * operator.

impl Mul<f32> for Direction3d

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Direction3d

type Output = Direction3d

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Direction3d

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

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

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.

impl Serialize for Direction3d

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Vec3> for Direction3d

type Error = InvalidDirectionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Direction3d

impl Primitive3d for Direction3d

impl StructuralPartialEq for Direction3d