Struct Vector3

#[repr(C)]
pub struct Vector3 {
    pub x: f32,
    pub y: f32,
    pub z: f32,
}

An owning representation of a 3-component Euclidean vector.

Like Vec3, the Vector3 object represents a Euclidean vector in 3D. Unlike the Vec3, this is an owning representation that stores the actual content of the vector.

Fields

x: f32

The X-component of the vector.

y: f32

The Y-component of the vector.

z: f32

The Z-component of the vector.

Implementations

impl Vector3

pub fn from_points(from: &Point3, to: &Point3) -> Self

Create a new vector from two points

Parameters

• from - The point to begin drawing the vector from
• to - The point to end drawing the vector at`

impl Vector3

pub const ZERO: Vector3 = _

A constant for a Null vector, which has magnitude 0 and exists at the origin.

pub const UNIT_X: Vector3 = _

A constant for a unit vector in the positive X-direction.

pub const UNIT_Y: Vector3 = _

A constant for a unit vector in the positive Y-direction.

pub const UNIT_Z: Vector3 = _

A constant for a unit vector in the positive Z-direction.

pub const NEG_UNIT_X: Vector3 = _

A constant for a unit vector in the negative X-direction.

pub const NEG_UNIT_Y: Vector3 = _

A constant for a unit vector in the negative Y-direction.

pub const NEG_UNIT_Z: Vector3 = _

A constant for a unit vector in the negative Z-direction.

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

Constructs this vector from an x, y, and z coordinate.

Parameters

• x - the x-component
• y - the y-component
• z - the z-component

pub const fn uniform(v: f32) -> Self

Constructs this vector with a uniform value v.

Parameters

• v - the value to uniformly apply

pub const fn from_array(array: &[f32; 3]) -> Self

Constructs this vector from a 3-component f32 array.

Parameters

• array - an array containing 3 f32 values.

pub const fn from_slice(slice: &[f32]) -> Result<Self, VecError>

Constructs this vector from a slice of floats.

This will return VecError if slice.len() is not equal to 2.

Parameters

• slice - the slice to read from

pub const unsafe fn from_slice_unchecked(slice: &[f32]) -> Self

Constructs this vector from a slice of floats.

Parameters

• slice - the slice to read from

Safety

slice.len() must be greater or equal to 2, otherwise this will access an out-of-bounds entry and panic.

pub const fn from_vec3(other: &Vec3) -> Self

Constructs this vector from a Vec3

Parameters

• other - the other vector

pub fn from_vec3i(other: &Vec3i) -> Self

Constructs this vector from a Vec3i

Parameters

• other - the other vector

pub fn from_vec3u(other: &Vec3u) -> Self

Constructs this vector from a Vec3u

Parameters

• other - the other vector

pub const unsafe fn from_ptr(ptr: *const f32) -> Self

Constructs this vector from a pointer to floating point values.

Parameters

• ptr - the pointer to the start of a contiguous sequence of floats

Safety

This function requires that ptr be non-null and point to the start of a contiguous sequence of 3 f32 values.

pub const fn as_vec3(&self) -> &Vec3

Returns this vector as a Vec3.

pub fn as_mut_vec3(&mut self) -> &mut Vec3

Returns this vector as a mutable Vec3.

pub const fn as_slice(&self) -> &[f32]

Returns this vector as a slice of f32.

pub fn as_mut_slice(&mut self) -> &mut [f32]

Returns this vector as a mutable slice of f32.

Methods from Deref<Target = Vec3>

pub fn as_slice(&self) -> &[f32]

Returns this Vec3 as a slice of f32.

pub fn as_mut_slice(&mut self) -> &mut [f32]

Returns this Vec3 as a mutable slice of f32.

pub fn as_ptr(&self) -> *const f32

Returns this vector as a ptr of f32.

pub fn as_mut_ptr(&mut self) -> *mut f32

Returns this vector as a mutable ptr of f32.

pub fn iter(&self) -> impl Iterator<Item = &f32>

Returns an iterator over the vector.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut f32>

Returns a mutable iterator over the vector.

pub fn x(&self) -> f32

Returns the X-coordinate of this 3-component vector.

pub fn y(&self) -> f32

Returns the Y-coordinate of this 3-component vector.

pub fn z(&self) -> f32

Returns the Z-coordinate of this 3-component vector.

pub fn xy(&self) -> &Vec2

Returns the xy coordinates of this vector as a Vec3.

pub fn yz(&self) -> &Vec2

Returns the yz coordinates of this vector as a Vec3.

pub fn x_mut(&mut self) -> &mut f32

Returns a mutable reference to the X-coordinate of this 3-component vector.

pub fn y_mut(&mut self) -> &mut f32

Returns a mutable reference to the Y-coordinate of this 3-component vector.

pub fn z_mut(&mut self) -> &mut f32

Returns a mutable reference to the Z-coordinate of this 3-component vector.

pub fn xy_mut(&mut self) -> &mut Vec2

Returns a mutable reference to the xy coordinates of this vector.

pub fn yz_mut(&mut self) -> &mut Vec2

Returns a mutable reference to the yz coordinates of this vector.

pub fn set_x(&mut self, x: f32)

Sets the x-component

Parameters

• x - the X-component

pub fn set_y(&mut self, y: f32)

Sets the y-component

Parameters

• y - the Y-component

pub fn set_z(&mut self, z: f32)

Sets the z-component

Parameters

• z - the Z-component

pub fn set_xy(&mut self, xy: &Vec2)

Sets the X and Y components of this vector

Parameters

• xy - the X and Y components o

pub fn set_yz(&mut self, xy: &Vec2)

Sets the Y and Z components of this vector

Parameters

• yz - the Y and Z components of the Vec3

pub fn set(&mut self, other: &Vec3)

Sets all the components of this vector the values from other.

Parameters

• other - the other Vec3 to set.

pub fn square_magnitude(&self) -> f32

Computes the square magnitude of this two-component vector.

pub fn magnitude(&self) -> f32

Computes the magnitude of this vector.

Where possible, consider using Vec3::square_magnitude as this will avoid the need to compute the square-root.

pub fn is_normalized(&self) -> bool

Queries whether this vector is normalized (e.g. has a magnitude of 1).

pub fn normalize(&mut self)

Normalizes this vector.

pub fn normalized(&self) -> Vector3

Returns normalized vector.

pub fn rotate_x<A: Angle>(&mut self, angle: A)

Rotates this vector around the X axis by angle A.

Parameters

• angle - the angle to rotate

pub fn rotate_y<A: Angle>(&mut self, angle: A)

Rotates this vector around the Y axis by angle A.

Parameters

• angle - the angle to rotate

pub fn rotate_z<A: Angle>(&mut self, angle: A)

Rotates this vector around the Y axis by angle A.

Parameters

• angle - the angle to rotate

pub fn is_finite(&self) -> bool

Returns whether all components of this Vec are finite.

Example

Basic use:

let finite = Vector3::UNIT_X;
let not_finite = Vector3::new(f32::INFINITY, 3.0, 0.0);

assert!(finite.is_finite());
assert!(!not_finite.is_finite());

pub fn is_infinite(&self) -> bool

Returns whether any component of this vec are infinite.

This is the inverse operation of is_finite.

Example

Basic use:

let finite = Vector3::UNIT_X;
let not_finite = Vector3::new(f32::INFINITY, 3.0, 0.0);

assert!(!finite.is_infinite());
assert!(not_finite.is_infinite());

pub fn is_nan(&self) -> bool

Returns whether any component of this vec are nan.

pub fn abs(&self) -> Vector3

Computes the absolute value of self

pub fn min(&self, rhs: &Vec3) -> Vector3

Computes the minimum of each vector.

Parameters

• lhs - the left vector
• rhs - the right vector

pub fn max(&self, rhs: &Vec3) -> Vector3

Computes the maximum of each vector.

Parameters

• lhs - the left vector
• rhs - the right vector

Trait Implementations

impl Add<&Vec3> for &Vector3

type Output = Vector3

The resulting type after applying the + operator.

fn add(self, rhs: &Vec3) -> Self::Output

Performs the + operation.

impl Add<&Vec3> for Vector3

type Output = Vector3

The resulting type after applying the + operator.

fn add(self, rhs: &Vec3) -> Self::Output

Performs the + operation.

impl Add<&Vector3> for &Vec3

type Output = Vector3

The resulting type after applying the + operator.

fn add(self, rhs: &Vector3) -> Self::Output

Performs the + operation.

impl Add<&Vector3> for Vector3

type Output = Vector3

The resulting type after applying the + operator.

fn add(self, rhs: &Vector3) -> Self::Output

Performs the + operation.

impl Add<Vector3> for &Vec3

type Output = Vector3

The resulting type after applying the + operator.

fn add(self, rhs: Vector3) -> Self::Output

Performs the + operation.

impl Add<Vector3> for &Vector3

type Output = Vector3

The resulting type after applying the + operator.

fn add(self, rhs: Vector3) -> Self::Output

Performs the + operation.

impl Add for &Vector3

type Output = Vector3

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl Add for Vector3

type Output = Vector3

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign<&Vec3> for Vector3

fn add_assign(&mut self, rhs: &Vec3)

Performs the += operation.

impl AddAssign<&Vector3> for Vector3

fn add_assign(&mut self, rhs: &Self)

Performs the += operation.

impl AddAssign for Vector3

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl AsMut<Vec3> for Vector3

fn as_mut(&mut self) -> &mut Vec3

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

impl AsRef<Vec3> for Vector3

fn as_ref(&self) -> &Vec3

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

impl Borrow<Vec3> for Vector3

fn borrow(&self) -> &Vec3

Immutably borrows from an owned value.

impl BorrowMut<Vec3> for Vector3

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

Mutably borrows from an owned value.

impl Clone for Vector3

fn clone(&self) -> Vector3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vector3

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

Formats the value using the given formatter.

impl Default for Vector3

fn default() -> Vector3

Returns the “default value” for a type.

impl Deref for Vector3

type Target = Vec3

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Vector3

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for Vector3

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

Formats the value using the given formatter.

impl Div<f32> for &Vector3

type Output = Vector3

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f32> for Vector3

type Output = Vector3

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f32> for Vector3

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl From<&Vec3> for Vector3

fn from(value: &Vec3) -> Self

Converts to this type from the input type.

impl From<&Vec3i> for Vector3

fn from(value: &Vec3i) -> Self

Converts to this type from the input type.

impl From<&Vec3u> for Vector3

fn from(value: &Vec3u) -> Self

Converts to this type from the input type.

impl From<Point3> for Vector3

fn from(p: Point3) -> Self

Converts to this type from the input type.

impl From<Vector3> for Point3

fn from(v: Vector3) -> Self

Converts to this type from the input type.

impl Mul<&Vector3> for f32

type Output = Vector3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vector3> for f32

type Output = Vector3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for &Vector3

type Output = Vector3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Vector3

type Output = Vector3

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f32> for Vector3

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl PartialEq for Vector3

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

fn partial_cmp(&self, other: &Vector3) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Rem<f32> for &Vector3

type Output = Vector3

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem<f32> for Vector3

type Output = Vector3

The resulting type after applying the % operator.

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

Performs the % operation.

impl RemAssign<f32> for Vector3

fn rem_assign(&mut self, rhs: f32)

Performs the %= operation.

impl Sub<&Vec3> for &Vector3

type Output = Vector3

The resulting type after applying the - operator.

fn sub(self, rhs: &Vec3) -> Self::Output

Performs the - operation.

impl Sub<&Vec3> for Vector3

type Output = Vector3

The resulting type after applying the - operator.

fn sub(self, rhs: &Vec3) -> Self::Output

Performs the - operation.

impl Sub<&Vector3> for &Vec3

type Output = Vector3

The resulting type after applying the - operator.

fn sub(self, rhs: &Vector3) -> Self::Output

Performs the - operation.

impl Sub<&Vector3> for Vector3

type Output = Vector3

The resulting type after applying the - operator.

fn sub(self, rhs: &Vector3) -> Self::Output

Performs the - operation.

impl Sub<Vector3> for &Vec3

type Output = Vector3

The resulting type after applying the - operator.

fn sub(self, rhs: Vector3) -> Self::Output

Performs the - operation.

impl Sub<Vector3> for &Vector3

type Output = Vector3

The resulting type after applying the - operator.

fn sub(self, rhs: Vector3) -> Self::Output

Performs the - operation.

impl Sub for &Vector3

type Output = Vector3

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl Sub for Vector3

type Output = Vector3

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign<&Vec3> for Vector3

fn sub_assign(&mut self, rhs: &Vec3)

Performs the -= operation.

impl SubAssign<&Vector3> for Vector3

fn sub_assign(&mut self, rhs: &Self)

Performs the -= operation.

impl SubAssign for Vector3

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Vector3

impl StructuralPartialEq for Vector3