Struct Vector3

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

General purposes 3D vector

Fields

x: f32

X coordinate in 3D space

y: f32

Y coordinate in 3D space

z: f32

Z coordinate in 3D space

Implementations

impl Vector3

pub const ZERO: Self

A vector with all components set to 0.

pub const ONE: Self

A vector with all components set to 1.

pub const UNIT_X: Self

A vector with all components set to 0 except for the x component, which is set to 1.

pub const UNIT_Y: Self

A vector with all components set to 0 except for the y component, which is set to 1.

pub const UNIT_Z: Self

A vector with all components set to 0 except for the z component, which is set to 1.

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

Create a new 3D position with the given coordinates

pub const fn x_axis() -> Self

Returns a vector with all components set to 0 except for the x component, which is set to 1.

pub const fn y_axis() -> Self

Returns a vector with all components set to 0 except for the y component, which is set to 1.

pub const fn z_axis() -> Self

Returns a vector with all components set to 0 except for the z component, which is set to 1.

pub const fn xy(&self) -> Vector2

Returns a 2D vector with the x and y coordinates of the 3D vector

pub const fn xz(&self) -> Vector2

Returns a 2D vector with the x and z coordinates of the 3D vector

pub const fn yz(&self) -> Vector2

Returns a 2D vector with the y and z coordinates of the 3D vector

impl Vector3

pub fn abs(&self) -> Self

Returns a new vector with all components in absolute values (i.e. positive).

pub fn angle_to(&self, to: Self) -> f32

Returns the unsigned minimum angle to the given vector, in radians.

pub fn bounce(&self, n: Self) -> Self

Returns the vector “bounced off” from a plane defined by the given normal n.

Note: bounce performs the operation that most engines and frameworks call reflect().

pub fn ceil(&self) -> Self

Returns a new vector with all components rounded up (towards positive infinity).

pub fn clamp(&self, min: f32, max: f32) -> Self

Returns a new vector with all components clamped between the components of min and max

pub fn clampf(&self, min: f32, max: f32) -> Self

Returns a new vector with all components clamped between min and max

pub const fn cross(&self, with: Self) -> Self

Returns the cross product of this vector and with.

This returns a vector perpendicular to both self and with, which would be the normal vector of the plane defined by the two vectors. As there are two such vectors, in opposite directions, this method returns the vector defined by a right-handed coordinate system. If the two vectors are parallel this returns an empty vector, making it useful for testing if two vectors are parallel.

pub fn direction_to(&self, to: Self) -> Self

Returns the normalized vector pointing from this vector to to. This is equivalent to using (b - a).normalized().

pub fn distance_squared_to(&self, to: Self) -> f32

Returns the squared distance between this vector and to.

This method runs faster than Vector3::distance_to, so prefer it if you need to compare vectors or need the squared distance for some formula.

pub fn distance_to(&self, to: Self) -> f32

Returns the distance between this vector and to.

pub fn dot(&self, with: Self) -> f32

Returns the dot product of this vector and with. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player.

The dot product will be 0 for a right angle (90 degrees), greater than 0 for angles narrower than 90 degrees and lower than 0 for angles wider than 90 degrees.

When using unit (normalized) vectors, the result will always be between -1.0 (180 degree angle) when the vectors are facing opposite directions, and 1.0 (0 degree angle) when the vectors are aligned.

Note: a.dot(b) is equivalent to b.dot(a).

pub fn floor(&self) -> Self

Returns a new vector with all components rounded down (towards negative infinity).

pub const fn inverse(&self) -> Self

Returns the inverse of the vector. This is the same as:

 Vector3 {
     x: 1.0 / self.x,
     y: 1.0 / self.y,
     z: 1.0 / self.z
 }

pub fn is_normalized(&self) -> bool

Returns true if the vector is normalized, i.e. its length is approximately equal to 1.

pub fn length(&self) -> f32

Returns the length (magnitude) of this vector.

pub const fn length_squared(&self) -> f32

Returns the squared length (squared magnitude) of this vector.

This method runs faster than Vector3::length, so prefer it if you need to compare vectors or need the squared distance for some formula.

pub fn lerp(&self, to: Self, weight: f32) -> Self

Returns the result of the linear interpolation between this vector and to by amount weight. weight is on the range of 0.0 to 1.0, representing the amount of interpolation.

pub fn limit_length(&self, max_length: f32) -> Self

Returns the vector with a maximum length by limiting its length to length.

pub fn max(&self, with: Vector3) -> Self

Returns the component-wise minimum of self and with, equivalent to:

Vector3 {
   x: self.x.max(with.x),
   y: self.y.max(with.y),
   z: self.z.max(with.z),
}

pub fn maxf(&self, with: f32) -> Self

Returns the component-wise maximum of self and with, equivalent to:

Vector3 {
   x: self.x.max(with),
   y: self.y.max(with),
   z: self.z.max(with),
}

pub fn min(&self, with: Vector3) -> Self

Returns the component-wise minimum of self and with, equivalent to:

Vector3 {
   x: self.x.min(with.x),
   y: self.y.min(with.y),
   z: self.z.min(with.z),
}

pub fn minf(&self, with: f32) -> Self

Returns the component-wise minimum of self and with, equivalent to:

Vector3 {
   x: self.x.min(with),
   y: self.y.min(with),
   z: self.z.min(with),
}

pub fn normalize(&self) -> Self

Normalize the vector (make the length of the vector 1)

pub fn round(&self) -> Self

Returns a new vector with all components rounded to the nearest integer, with halfway cases rounded away from zero.

pub fn rotate(&self, axis: RotateAxis, angle: RotateAmount) -> Self

Rotates the vector around the given axis by the given angle.

Trait Implementations

impl Add<f32> for Vector3

type Output = Vector3

The resulting type after applying the + operator.

fn add(self, scalar: f32) -> Self

Performs the + operation.

impl Add for Vector3

type Output = Vector3

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<f32> for Vector3

fn add_assign(&mut self, scalar: f32)

Performs the += operation.

impl AddAssign for Vector3

fn add_assign(&mut self, other: Self)

Performs the += operation.

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 Div<f32> for Vector3

type Output = Vector3

The resulting type after applying the / operator.

fn div(self, scalar: f32) -> Self

Performs the / operation.

impl Div for Vector3

type Output = Vector3

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f32> for Vector3

fn div_assign(&mut self, scalar: f32)

Performs the /= operation.

impl DivAssign for Vector3

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl From<[f32; 3]> for Vector3

fn from(pos: [f32; 3]) -> Self

Converts to this type from the input type.

impl From<(f32, f32, f32)> for Vector3

fn from(pos: (f32, f32, f32)) -> Self

Converts to this type from the input type.

impl From<Matrix<f32, Const<3>, Const<1>, ArrayStorage<f32, 3, 1>>> for Vector3

fn from(pos: Vec3) -> Self

Converts to this type from the input type.

impl From<Vector3> for [f32; 3]

fn from(pos: Vector3) -> Self

Converts to this type from the input type.

impl From<Vector3> for (f32, f32, f32)

fn from(pos: Vector3) -> Self

Converts to this type from the input type.

impl From<Vector3> for Vec3

fn from(pos: Vector3) -> Self

Converts to this type from the input type.

impl Index<usize> for Vector3

type Output = f32

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Mul<f32> for Vector3

type Output = Vector3

The resulting type after applying the * operator.

fn mul(self, scalar: f32) -> Self

Performs the * operation.

impl Mul for Vector3

type Output = Vector3

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f32> for Vector3

fn mul_assign(&mut self, scalar: f32)

Performs the *= operation.

impl MulAssign for Vector3

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl Neg for Vector3

type Output = Vector3

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - 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 Sub<f32> for Vector3

type Output = Vector3

The resulting type after applying the - operator.

fn sub(self, scalar: f32) -> Self

Performs the - operation.

impl Sub for Vector3

type Output = Vector3

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<f32> for Vector3

fn sub_assign(&mut self, scalar: f32)

Performs the -= operation.

impl SubAssign for Vector3

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Zeroable for Vector3

fn zeroed() -> Self

Calls zeroed.

impl Copy for Vector3

impl Pod for Vector3

impl Send for Vector3

impl StructuralPartialEq for Vector3

impl Sync for Vector3