Struct nannou::glam::DVec3

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

A 3-dimensional vector.

Implementations

impl DVec3

pub const ZERO: DVec3 = _

All zeroes.

pub const ONE: DVec3 = _

All ones.

pub const X: DVec3 = _

[1, 0, 0]: a unit-length vector pointing along the positive X axis.

pub const Y: DVec3 = _

[0, 1, 0]: a unit-length vector pointing along the positive Y axis.

pub const Z: DVec3 = _

[0, 0, 1]: a unit-length vector pointing along the positive Z axis.

pub const AXES: [DVec3; 3] = _

The unit axes.

pub fn new(x: f64, y: f64, z: f64) -> DVec3

Creates a new 3D vector.

pub fn extend(self, w: f64) -> DVec4

Creates a 4D vector from self and the given w value.

pub fn truncate(self) -> DVec2

Creates a Vec2 from the x and y elements of self, discarding z.

Truncation may also be performed by using self.xy() or Vec2::from().

pub fn cross(self, other: DVec3) -> DVec3

Computes the cross product of self and other.

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

[x, y, z]

pub fn splat(v: f64) -> DVec3

Creates a vector with all elements set to v.

pub fn select(mask: BVec3, if_true: DVec3, if_false: DVec3) -> DVec3

Creates a vector from the elements in if_true and if_false, selecting which to use for each element of self.

A true element in the mask uses the corresponding element from if_true, and false uses the element from if_false.

pub fn dot(self, other: DVec3) -> f64

Computes the dot product of self and other.

pub fn min(self, other: DVec3) -> DVec3

Returns a vector containing the mininum values for each element of self and other.

In other words this computes [self.x.max(other.x), self.y.max(other.y), ..].

pub fn max(self, other: DVec3) -> DVec3

Returns a vector containing the maximum values for each element of self and other.

In other words this computes [self.x.max(other.x), self.y.max(other.y), ..].

pub fn clamp(self, min: DVec3, max: DVec3) -> DVec3

Component-wise clamping of values, similar to f32::clamp.

Each element in min must be less-or-equal to the corresponing element in max.

Panics

Will panic if min is greater than max when glam_assert is enabled.

pub fn min_element(self) -> f64

Returns the horizontal minimum of self.

In other words this computes min(x, y, ..).

pub fn max_element(self) -> f64

Returns the horizontal maximum of self.

In other words this computes max(x, y, ..).

pub fn cmpeq(self, other: DVec3) -> BVec3

Returns a vector mask containing the result of a == comparison for each element of self and other.

In other words, this computes [self.x == other.x, self.y == other.y, ..] for all elements.

pub fn cmpne(self, other: DVec3) -> BVec3

Returns a vector mask containing the result of a != comparison for each element of self and other.

In other words this computes [self.x != other.x, self.y != other.y, ..] for all elements.

pub fn cmpge(self, other: DVec3) -> BVec3

Returns a vector mask containing the result of a >= comparison for each element of self and other.

In other words this computes [self.x >= other.x, self.y >= other.y, ..] for all elements.

pub fn cmpgt(self, other: DVec3) -> BVec3

Returns a vector mask containing the result of a > comparison for each element of self and other.

In other words this computes [self.x > other.x, self.y > other.y, ..] for all elements.

pub fn cmple(self, other: DVec3) -> BVec3

Returns a vector mask containing the result of a <= comparison for each element of self and other.

In other words this computes [self.x <= other.x, self.y <= other.y, ..] for all elements.

pub fn cmplt(self, other: DVec3) -> BVec3

Returns a vector mask containing the result of a < comparison for each element of self and other.

In other words this computes [self.x < other.x, self.y < other.y, ..] for all elements.

pub fn from_slice(slice: &[f64]) -> DVec3

Creates a vector from the first N values in slice.

Panics

Panics if slice is less than N elements long.

pub fn write_to_slice(self, slice: &mut [f64])

Writes the elements of self to the first N elements in slice.

Panics

Panics if slice is less than N elements long.

pub fn abs(self) -> DVec3

Returns a vector containing the absolute value of each element of self.

pub fn signum(self) -> DVec3

Returns a vector with elements representing the sign of self.

• 1.0 if the number is positive, +0.0 or INFINITY
• -1.0 if the number is negative, -0.0 or NEG_INFINITY
• NAN if the number is NAN

pub fn is_finite(self) -> bool

Returns true if, and only if, all elements are finite. If any element is either NaN, positive or negative infinity, this will return false.

pub fn is_nan(self) -> bool

Returns true if any elements are NaN.

pub fn is_nan_mask(self) -> BVec3

Performs is_nan on each element of self, returning a vector mask of the results.

In other words, this computes [x.is_nan(), y.is_nan(), z.is_nan(), w.is_nan()].

pub fn length(self) -> f64

Computes the length of self.

pub fn length_squared(self) -> f64

Computes the squared length of self.

This is faster than length() as it avoids a square root operation.

pub fn length_recip(self) -> f64

Computes 1.0 / length().

For valid results, self must not be of length zero.

pub fn distance(self, other: DVec3) -> f64

Computes the Euclidean distance between two points in space.

pub fn distance_squared(self, other: DVec3) -> f64

Compute the squared euclidean distance between two points in space.

pub fn normalize(self) -> DVec3

Returns self normalized to length 1.0.

For valid results, self must not be of length zero, nor very close to zero.

See also Self::try_normalize and Self::normalize_or_zero.

Panics

Will panic if self is zero length when glam_assert is enabled.

pub fn try_normalize(self) -> Option<DVec3>

Returns self normalized to length 1.0 if possible, else returns None.

In particular, if the input is zero (or very close to zero), or non-finite, the result of this operation will be None.

See also Self::normalize_or_zero.

pub fn normalize_or_zero(self) -> DVec3

Returns self normalized to length 1.0 if possible, else returns zero.

In particular, if the input is zero (or very close to zero), or non-finite, the result of this operation will be zero.

See also Self::try_normalize.

pub fn is_normalized(self) -> bool

Returns whether self is length 1.0 or not.

Uses a precision threshold of 1e-6.

pub fn project_onto(self, other: DVec3) -> DVec3

Returns the vector projection of self onto other.

other must be of non-zero length.

Panics

Will panic if other is zero length when glam_assert is enabled.

pub fn reject_from(self, other: DVec3) -> DVec3

Returns the vector rejection of self from other.

The vector rejection is the vector perpendicular to the projection of self onto other, in other words the result of self - self.project_onto(other).

other must be of non-zero length.

Panics

Will panic if other has a length of zero when glam_assert is enabled.

pub fn project_onto_normalized(self, other: DVec3) -> DVec3

Returns the vector projection of self onto other.

other must be normalized.

Panics

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

pub fn reject_from_normalized(self, other: DVec3) -> DVec3

Returns the vector rejection of self from other.

The vector rejection is the vector perpendicular to the projection of self onto other, in other words the result of self - self.project_onto(other).

other must be normalized.

Panics

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

pub fn round(self) -> DVec3

Returns a vector containing the nearest integer to a number for each element of self. Round half-way cases away from 0.0.

pub fn floor(self) -> DVec3

Returns a vector containing the largest integer less than or equal to a number for each element of self.

pub fn ceil(self) -> DVec3

Returns a vector containing the smallest integer greater than or equal to a number for each element of self.

pub fn fract(self) -> DVec3

Returns a vector containing the fractional part of the vector, e.g. self - self.floor().

Note that this is fast but not precise for large numbers.

pub fn exp(self) -> DVec3

Returns a vector containing e^self (the exponential function) for each element of self.

pub fn powf(self, n: f64) -> DVec3

Returns a vector containing each element of self raised to the power of n.

pub fn recip(self) -> DVec3

Returns a vector containing the reciprocal 1.0/n of each element of self.

pub fn lerp(self, other: DVec3, s: f64) -> DVec3

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

When s is 0.0, the result will be equal to self. When s is 1.0, the result will be equal to other.

pub fn abs_diff_eq(self, other: DVec3, max_abs_diff: f64) -> bool

Returns true if the absolute difference of all elements between self and other is less than or equal to max_abs_diff.

This can be used to compare if two vectors contain similar elements. It works best when comparing with a known value. The max_abs_diff that should be used used depends on the values being compared against.

For more see comparing floating point numbers.

pub fn clamp_length(self, min: f64, max: f64) -> DVec3

Returns a vector with a length no less than min and no more than max

Panics

Will panic if min is greater than max when glam_assert is enabled.

pub fn clamp_length_max(self, max: f64) -> DVec3

Returns a vector with a length no more than max

pub fn clamp_length_min(self, min: f64) -> DVec3

Returns a vector with a length no less than min

pub fn angle_between(self, other: DVec3) -> f64

Returns the angle (in radians) between two vectors.

The input vectors do not need to be unit length however they must be non-zero.

pub fn any_orthogonal_vector(&self) -> DVec3

Returns somes 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) -> DVec3

Returns any unit-length vector that is orthogonal to the given one. The input vector must be finite and non-zero.

Panics

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

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

Given a unit-length 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_f32(&self) -> Vec3

Casts all elements of self to f32.

pub fn as_i32(&self) -> IVec3

Casts all elements of self to i32.

pub fn as_u32(&self) -> UVec3

Casts all elements of self to u32.

Trait Implementations

impl Add<f64> for DVec3

type Output = DVec3

The resulting type after applying the + operator.

fn add(self, other: f64) -> DVec3

Performs the + operation.

impl Add for DVec3

type Output = DVec3

The resulting type after applying the + operator.

fn add(self, other: DVec3) -> DVec3

Performs the + operation.

impl AddAssign<f64> for DVec3

fn add_assign(&mut self, other: f64)

Performs the += operation.

impl AddAssign for DVec3

fn add_assign(&mut self, other: DVec3)

Performs the += operation.

impl AsMut<[f64; 3]> for DVec3

fn as_mut(&mut self) -> &mut [f64; 3]

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

impl AsRef<[f64; 3]> for DVec3

fn as_ref(&self) -> &[f64; 3]

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

impl Average for DVec3

fn average<I>(vertices: I) -> Option<DVec3>

where I: IntoIterator<Item = DVec3>,

Produce the average of the given sequence of vertices.

impl Clone for DVec3

fn clone(&self) -> DVec3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DVec3

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

Formats the value using the given formatter.

impl Default for DVec3

fn default() -> DVec3

Returns the “default value” for a type.

impl Deref for DVec3

type Target = XYZ<f64>

The resulting type after dereferencing.

fn deref(&self) -> &<DVec3 as Deref>::Target

Dereferences the value.

impl DerefMut for DVec3

fn deref_mut(&mut self) -> &mut <DVec3 as Deref>::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for DVec3

fn deserialize<D>( deserializer: D ) -> Result<DVec3, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DVec3

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

Formats the value using the given formatter.

impl Distribution<DVec3> for Standard

fn sample<R>(&self, rng: &mut R) -> DVec3

where R: Rng + ?Sized,

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 Div<f64> for DVec3

type Output = DVec3

The resulting type after applying the / operator.

fn div(self, other: f64) -> DVec3

Performs the / operation.

impl Div for DVec3

type Output = DVec3

The resulting type after applying the / operator.

fn div(self, other: DVec3) -> DVec3

Performs the / operation.

impl DivAssign<f64> for DVec3

fn div_assign(&mut self, other: f64)

Performs the /= operation.

impl DivAssign for DVec3

fn div_assign(&mut self, other: DVec3)

Performs the /= operation.

impl From<[f64; 3]> for DVec3

fn from(a: [f64; 3]) -> DVec3

Converts to this type from the input type.

impl From<(DVec2, f64)> for DVec3

fn from(_: (DVec2, f64)) -> DVec3

Converts to this type from the input type.

impl From<(f64, f64, f64)> for DVec3

fn from(t: (f64, f64, f64)) -> DVec3

Converts to this type from the input type.

impl From<DVec3> for [f64; 3]

fn from(v: DVec3) -> [f64; 3]

Converts to this type from the input type.

impl From<DVec3> for DVec2

fn from(v: DVec3) -> DVec2

Creates a Vec2 from the x and y elements of self, discarding z.

impl From<DVec3> for XYZ<f64>

fn from(t: DVec3) -> XYZ<f64>

Converts to this type from the input type.

impl From<DVec4> for DVec3

fn from(v: DVec4) -> DVec3

Creates a 3D vector from the x, y and z elements of self, discarding w.

impl From<XYZ<f64>> for DVec3

fn from(t: XYZ<f64>) -> DVec3

Converts to this type from the input type.

impl Index<usize> for DVec3

type Output = f64

The returned type after indexing.

fn index(&self, index: usize) -> &<DVec3 as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for DVec3

fn index_mut(&mut self, index: usize) -> &mut <DVec3 as Index<usize>>::Output

Performs the mutable indexing (container[index]) operation.

impl Mul<DVec3> for DMat3

type Output = DVec3

The resulting type after applying the * operator.

fn mul(self, other: DVec3) -> <DMat3 as Mul<DVec3>>::Output

Performs the * operation.

impl Mul<DVec3> for DQuat

fn mul(self, other: DVec3) -> <DQuat as Mul<DVec3>>::Output

Multiplies a quaternion and a 3D vector, returning the rotated vector.

Panics

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

type Output = DVec3

The resulting type after applying the * operator.

impl Mul<f64> for DVec3

type Output = DVec3

The resulting type after applying the * operator.

fn mul(self, other: f64) -> DVec3

Performs the * operation.

impl Mul for DVec3

type Output = DVec3

The resulting type after applying the * operator.

fn mul(self, other: DVec3) -> DVec3

Performs the * operation.

impl MulAssign<f64> for DVec3

fn mul_assign(&mut self, other: f64)

Performs the *= operation.

impl MulAssign for DVec3

fn mul_assign(&mut self, other: DVec3)

Performs the *= operation.

impl Neg for DVec3

type Output = DVec3

The resulting type after applying the - operator.

fn neg(self) -> DVec3

Performs the unary - operation.

impl PartialEq for DVec3

fn eq(&self, other: &DVec3) -> 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<'a> Product<&'a DVec3> for DVec3

fn product<I>(iter: I) -> DVec3

where I: Iterator<Item = &'a DVec3>,

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl Serialize for DVec3

fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<f64> for DVec3

type Output = DVec3

The resulting type after applying the - operator.

fn sub(self, other: f64) -> DVec3

Performs the - operation.

impl Sub for DVec3

type Output = DVec3

The resulting type after applying the - operator.

fn sub(self, other: DVec3) -> DVec3

Performs the - operation.

impl SubAssign<f64> for DVec3

fn sub_assign(&mut self, other: f64)

Performs the -= operation.

impl SubAssign for DVec3

fn sub_assign(&mut self, other: DVec3)

Performs the -= operation.

impl<'a> Sum<&'a DVec3> for DVec3

fn sum<I>(iter: I) -> DVec3

where I: Iterator<Item = &'a DVec3>,

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Vec3Swizzles for DVec3

type Vec2 = DVec2

type Vec4 = DVec4

fn xxxx(self) -> DVec4

fn xxxy(self) -> DVec4

fn xxxz(self) -> DVec4

fn xxyx(self) -> DVec4

fn xxyy(self) -> DVec4

fn xxyz(self) -> DVec4

fn xxzx(self) -> DVec4

fn xxzy(self) -> DVec4

fn xxzz(self) -> DVec4

fn xyxx(self) -> DVec4

fn xyxy(self) -> DVec4

fn xyxz(self) -> DVec4

fn xyyx(self) -> DVec4

fn xyyy(self) -> DVec4

fn xyyz(self) -> DVec4

fn xyzx(self) -> DVec4

fn xyzy(self) -> DVec4

fn xyzz(self) -> DVec4

fn xzxx(self) -> DVec4

fn xzxy(self) -> DVec4

fn xzxz(self) -> DVec4

fn xzyx(self) -> DVec4

fn xzyy(self) -> DVec4

fn xzyz(self) -> DVec4

fn xzzx(self) -> DVec4

fn xzzy(self) -> DVec4

fn xzzz(self) -> DVec4

fn yxxx(self) -> DVec4

fn yxxy(self) -> DVec4

fn yxxz(self) -> DVec4

fn yxyx(self) -> DVec4

fn yxyy(self) -> DVec4

fn yxyz(self) -> DVec4

fn yxzx(self) -> DVec4

fn yxzy(self) -> DVec4

fn yxzz(self) -> DVec4

fn yyxx(self) -> DVec4

fn yyxy(self) -> DVec4

fn yyxz(self) -> DVec4

fn yyyx(self) -> DVec4

fn yyyy(self) -> DVec4

fn yyyz(self) -> DVec4

fn yyzx(self) -> DVec4

fn yyzy(self) -> DVec4

fn yyzz(self) -> DVec4

fn yzxx(self) -> DVec4

fn yzxy(self) -> DVec4

fn yzxz(self) -> DVec4

fn yzyx(self) -> DVec4

fn yzyy(self) -> DVec4

fn yzyz(self) -> DVec4

fn yzzx(self) -> DVec4

fn yzzy(self) -> DVec4

fn yzzz(self) -> DVec4

fn zxxx(self) -> DVec4

fn zxxy(self) -> DVec4

fn zxxz(self) -> DVec4

fn zxyx(self) -> DVec4

fn zxyy(self) -> DVec4

fn zxyz(self) -> DVec4

fn zxzx(self) -> DVec4

fn zxzy(self) -> DVec4

fn zxzz(self) -> DVec4

fn zyxx(self) -> DVec4

fn zyxy(self) -> DVec4

fn zyxz(self) -> DVec4

fn zyyx(self) -> DVec4

fn zyyy(self) -> DVec4

fn zyyz(self) -> DVec4

fn zyzx(self) -> DVec4

fn zyzy(self) -> DVec4

fn zyzz(self) -> DVec4

fn zzxx(self) -> DVec4

fn zzxy(self) -> DVec4

fn zzxz(self) -> DVec4

fn zzyx(self) -> DVec4

fn zzyy(self) -> DVec4

fn zzyz(self) -> DVec4

fn zzzx(self) -> DVec4

fn zzzy(self) -> DVec4

fn zzzz(self) -> DVec4

fn xxx(self) -> DVec3

fn xxy(self) -> DVec3

fn xxz(self) -> DVec3

fn xyx(self) -> DVec3

fn xyy(self) -> DVec3

fn xzx(self) -> DVec3

fn xzy(self) -> DVec3

fn xzz(self) -> DVec3

fn yxx(self) -> DVec3

fn yxy(self) -> DVec3

fn yxz(self) -> DVec3

fn yyx(self) -> DVec3

fn yyy(self) -> DVec3

fn yyz(self) -> DVec3

fn yzx(self) -> DVec3

fn yzy(self) -> DVec3

fn yzz(self) -> DVec3

fn zxx(self) -> DVec3

fn zxy(self) -> DVec3

fn zxz(self) -> DVec3

fn zyx(self) -> DVec3

fn zyy(self) -> DVec3

fn zyz(self) -> DVec3

fn zzx(self) -> DVec3

fn zzy(self) -> DVec3

fn zzz(self) -> DVec3

fn xx(self) -> DVec2

fn xy(self) -> DVec2

fn xz(self) -> DVec2

fn yx(self) -> DVec2

fn yy(self) -> DVec2

fn yz(self) -> DVec2

fn zx(self) -> DVec2

fn zy(self) -> DVec2

fn zz(self) -> DVec2

fn xyz(self) -> Self

impl Vertex for DVec3

type Scalar = f64

The values used to describe the vertex position.

impl Vertex2d for DVec3

fn point2(self) -> [<DVec3 as Vertex>::Scalar; 2]

The x, y location of the vertex.

impl Vertex3d for DVec3

fn point3(self) -> [<DVec3 as Vertex>::Scalar; 3]

The x, y, z location of the vertex.

impl Copy for DVec3