Struct Dir3A

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

A normalized SIMD vector pointing in a direction in 3D space.

This type stores a 16 byte aligned Vec3A. This may or may not be faster than Dir3: make sure to benchmark!

Implementations

impl Dir3A

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 const AXES: [Self; 3] = _

The directional axes.

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

Create a direction from a finite, nonzero Vec3A, normalizing it.

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: Vec3A) -> Self

Create a Dir3A from a Vec3A that is already normalized.

Warning

value must be normalized, i.e its length must be 1.0.

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

Create a direction from a finite, nonzero Vec3A, normalizing it and 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.

pub fn from_xyz_unchecked(x: f32, y: f32, z: f32) -> Self

Create a direction from its x, y, and z components, assuming the resulting vector is normalized.

Warning

The vector produced from x, y, and z must be normalized, i.e its length must be 1.0.

pub const fn as_vec3a(&self) -> Vec3A

Returns the inner Vec3A

pub fn slerp(self, rhs: Self, s: f32) -> Self

Performs a spherical linear interpolation between self and rhs based on the value s.

This corresponds to interpolating between the two directions at a constant angular velocity.

When s == 0.0, the result will be equal to self. When s == 1.0, the result will be equal to rhs.

Example

let dir1 = Dir3A::X;
let dir2 = Dir3A::Y;

let result1 = dir1.slerp(dir2, 1.0 / 3.0);
assert_relative_eq!(
    result1,
    Dir3A::from_xyz(0.75_f32.sqrt(), 0.5, 0.0).unwrap(),
    epsilon = 0.000001
);

let result2 = dir1.slerp(dir2, 0.5);
assert_relative_eq!(result2, Dir3A::from_xyz(0.5_f32.sqrt(), 0.5_f32.sqrt(), 0.0).unwrap());

pub fn fast_renormalize(self) -> Self

Returns self after an approximate normalization, assuming the value is already nearly normalized. Useful for preventing numerical error accumulation.

See Dir3::fast_renormalize for an example of when such error accumulation might occur.

Methods from Deref<Target = Vec3A>

pub const ZERO: Vec3A = _

pub const ONE: Vec3A = _

pub const NEG_ONE: Vec3A = _

pub const MIN: Vec3A = _

pub const MAX: Vec3A = _

pub const NAN: Vec3A = _

pub const INFINITY: Vec3A = _

pub const NEG_INFINITY: Vec3A = _

pub const X: Vec3A = _

pub const Y: Vec3A = _

pub const Z: Vec3A = _

pub const NEG_X: Vec3A = _

pub const NEG_Y: Vec3A = _

pub const NEG_Z: Vec3A = _

pub const AXES: [Vec3A; 3] = _

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

[x, y, z]

pub fn move_towards(&self, rhs: Vec3A, d: f32) -> Vec3A

Moves towards rhs based on the value d.

When d is 0.0, the result will be equal to self. When d is equal to self.distance(rhs), the result will be equal to rhs. Will not go past rhs.

pub fn any_orthogonal_vector(&self) -> Vec3A

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) -> Vec3A

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) -> (Vec3A, Vec3A)

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_i8vec3(&self) -> I8Vec3

Casts all elements of self to i8.

pub fn as_u8vec3(&self) -> U8Vec3

Casts all elements of self to u8.

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 Dir3A

fn clone(&self) -> Dir3A

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dir3A

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

Formats the value using the given formatter.

impl Deref for Dir3A

type Target = Vec3A

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for Dir3A

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Distribution<Dir3A> for Standard

Available on crate feature rand only.

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Dir3A

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl Ease for Dir3A

Available on crate feature curve only.

fn interpolating_curve_unbounded(start: Self, end: Self) -> impl Curve<Self>

Given start and end values, produce a curve with unlimited domain that:

impl From<Dir3> for Dir3A

fn from(value: Dir3) -> Self

Converts to this type from the input type.

impl From<Dir3A> for Dir3

fn from(value: Dir3A) -> Self

Converts to this type from the input type.

impl From<Dir3A> for Vec3A

fn from(value: Dir3A) -> Self

Converts to this type from the input type.

impl FromReflect for Dir3A

where Dir3A: Any + Send + Sync, Vec3A: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl FromRng for Dir3A

Available on crate feature rand only.

fn from_rng<R: Rng + ?Sized>(rng: &mut R) -> Self

Construct a value of this type uniformly at random using rng as the source of randomness.

impl GetTypeRegistration for Dir3A

where Dir3A: Any + Send + Sync, Vec3A: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl Mul<Dir3A> for Quat

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

Rotates the Dir3A using a Quat.

type Output = Dir3A

The resulting type after applying the * operator.

impl Mul<Dir3A> for f32

type Output = Vec3A

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Dir3A

type Output = Vec3A

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Dir3A

type Output = Dir3A

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Dir3A

fn eq(&self, other: &Dir3A) -> 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 PartialReflect for Dir3A

where Dir3A: Any + Send + Sync, Vec3A: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn clone_value(&self) -> Box<dyn PartialReflect>

Clones the value as a Reflect trait object.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for Dir3A

where Dir3A: Any + Send + Sync, Vec3A: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl Serialize for Dir3A

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StableInterpolate for Dir3A

fn interpolate_stable(&self, other: &Self, t: f32) -> Self

Interpolate between this value and the other given value using the parameter t. At t = 0.0, a value equivalent to self is recovered, while t = 1.0 recovers a value equivalent to other, with intermediate values interpolating between the two. See the trait-level documentation for details.

fn interpolate_stable_assign(&mut self, other: &Self, t: f32)

A version of interpolate_stable that assigns the result to self for convenience.

fn smooth_nudge(&mut self, target: &Self, decay_rate: f32, delta: f32)

Smoothly nudge this value towards the target at a given decay rate. The decay_rate parameter controls how fast the distance between self and target decays relative to the units of delta; the intended usage is for decay_rate to generally remain fixed, while delta is something like delta_time from an updating system. This produces a smooth following of the target that is independent of framerate.

impl TryFrom<Vec3A> for Dir3A

type Error = InvalidDirectionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TupleStruct for Dir3A

where Dir3A: Any + Send + Sync, Vec3A: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, index: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn field_len(&self) -> usize

Returns the number of fields in the tuple struct.

fn iter_fields(&self) -> TupleStructFieldIter<'_>

Returns an iterator over the values of the tuple struct’s fields.

fn clone_dynamic(&self) -> DynamicTupleStruct

Clones the struct into a DynamicTupleStruct.

fn get_represented_tuple_struct_info(&self) -> Option<&'static TupleStructInfo>

Will return None if TypeInfo is not available.

impl TypePath for Dir3A

where Dir3A: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Dir3A

where Dir3A: Any + Send + Sync, Vec3A: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for Dir3A

impl Primitive3d for Dir3A

impl StructuralPartialEq for Dir3A