Struct Dir4 

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

A normalized vector pointing in a direction in 4D space

Implementations

impl Dir4

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 W: Self

A unit vector pointing along the positive W 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 NEG_W: Self

A unit vector pointing along the negative W axis.

pub const AXES: [Self; 4]

The directional axes.

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

Create a direction from a finite, nonzero Vec4, 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: Vec4) -> Self

Create a Dir4 from a Vec4 that is already normalized.

Warning

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

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

Create a direction from a finite, nonzero Vec4, 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_xyzw( x: f32, y: f32, z: f32, w: f32, ) -> Result<Self, InvalidDirectionError>

Create a direction from its x, y, z, and w 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_xyzw_unchecked(x: f32, y: f32, z: f32, w: f32) -> Self

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

Warning

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

pub const fn as_vec4(&self) -> Vec4

Returns the inner Vec4

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.

Methods from Deref<Target = Vec4>

pub const ZERO: Vec4

pub const ONE: Vec4

pub const NEG_ONE: Vec4

pub const MIN: Vec4

pub const MAX: Vec4

pub const NAN: Vec4

pub const INFINITY: Vec4

pub const NEG_INFINITY: Vec4

pub const X: Vec4

pub const Y: Vec4

pub const Z: Vec4

pub const W: Vec4

pub const NEG_X: Vec4

pub const NEG_Y: Vec4

pub const NEG_Z: Vec4

pub const NEG_W: Vec4

pub const AXES: [Vec4; 4]

pub const USES_CORE_SIMD: bool = false

pub const USES_NEON: bool = false

pub const USES_SCALAR_MATH: bool = false

pub const USES_SSE2: bool = true

pub const USES_WASM32_SIMD: bool = false

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

Converts self to [x, y, z, w]

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

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 as_dvec4(&self) -> DVec4

Casts all elements of self to f64.

pub fn as_i8vec4(&self) -> I8Vec4

Casts all elements of self to i8.

pub fn as_u8vec4(&self) -> U8Vec4

Casts all elements of self to u8.

pub fn as_i16vec4(&self) -> I16Vec4

Casts all elements of self to i16.

pub fn as_u16vec4(&self) -> U16Vec4

Casts all elements of self to u16.

pub fn as_ivec4(&self) -> IVec4

Casts all elements of self to i32.

pub fn as_uvec4(&self) -> UVec4

Casts all elements of self to u32.

pub fn as_i64vec4(&self) -> I64Vec4

Casts all elements of self to i64.

pub fn as_u64vec4(&self) -> U64Vec4

Casts all elements of self to u64.

pub fn as_usizevec4(&self) -> USizeVec4

Casts all elements of self to usize.

Trait Implementations

impl AbsDiffEq for Dir4

Available on crate feature approx only.

type Epsilon = f32

Used for specifying relative comparisons.

fn default_epsilon() -> f32

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: f32) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl Clone for Dir4

fn clone(&self) -> Dir4

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dir4

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

Formats the value using the given formatter.

impl Deref for Dir4

type Target = Vec4

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for Dir4

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Dir4

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

Formats the value using the given formatter.

impl From<Dir4> for Vec4

fn from(value: Dir4) -> Self

Converts to this type from the input type.

impl FromReflect for Dir4

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 GetTypeRegistration for Dir4

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<Dir4> for f32

type Output = Vec4

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Dir4

type Output = Vec4

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Dir4

type Output = Dir4

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Dir4

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

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

Returns the TypeInfo of the type represented by this value.

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 reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

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

Applies a reflected value to this value.

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

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

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

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

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for Dir4

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 RelativeEq for Dir4

Available on crate feature approx only.

fn default_max_relative() -> f32

The default relative tolerance for testing values that are far-apart.

fn relative_eq(&self, other: &Self, epsilon: f32, max_relative: f32) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.

impl Serialize for Dir4

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Vec4> for Dir4

type Error = InvalidDirectionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TupleStruct for Dir4

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 to_dynamic_tuple_struct(&self) -> DynamicTupleStruct

Creates a new DynamicTupleStruct from this tuple struct.

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

Will return None if TypeInfo is not available.

impl TypePath for Dir4

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 Dir4

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl UlpsEq for Dir4

Available on crate feature approx only.

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(&self, other: &Self, epsilon: f32, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

impl Copy for Dir4

impl StructuralPartialEq for Dir4