Struct mini_math::Vector3

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

A vector in 3D space.

Fields

x: f32

y: f32

z: f32

Implementations

impl Vector3

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

Construct new a vector from individual coordinates

pub const fn from_scalar(s: f32) -> Self

Construct new a vector where each coordinate is the same

pub const fn zero() -> Self

The additive identity

pub const fn one() -> Self

The multiplicative identity

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

Compute the dot product between this vector and another

pub fn lerp(&self, rhs: Self, factor: f32) -> Self

Linear interpolation between this vector and another

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

impl Vector3

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

Compute the cross product between this vector and another.

pub fn magnitude_squared(&self) -> f32

The length of this vector squared. Note that this avoids an expensive square root.

pub fn magnitude(&self) -> f32

The length of this vector. Note that this involves an expensive square root.

pub fn normalized(&self) -> Self

Normalize this vector to unit length. Note that this involves an expensive square root.

Trait Implementations

impl Add<Vector3> for Vector3

type Output = Vector3

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Vector3> for Point

type Output = Point

The resulting type after applying the + operator.

fn add(self, rhs: Vector3) -> Point

Performs the + operation.

impl Add<f32> for Vector3

type Output = Vector3

The resulting type after applying the + operator.

fn add(self, t: f32) -> Self::Output

Performs the + operation.

impl AddAssign<Vector3> for Vector3

fn add_assign(&mut self, rhs: Vector3)

Performs the += operation.

impl AddAssign<Vector3> for Point

fn add_assign(&mut self, rhs: Vector3)

Performs the += operation.

impl AddAssign<f32> for Vector3

fn add_assign(&mut self, t: f32)

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

type Output = Vector3

The resulting type after applying the / operator.

fn div(self, t: Vector3) -> Self::Output

Performs the / operation.

impl Div<f32> for Vector3

type Output = Vector3

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f32> for Vector3

fn div_assign(&mut self, t: f32)

Performs the /= operation.

impl From<Point> for Vector3

fn from(p: Point) -> Self

Convert a point into a vector

impl From<Vector3> for Point

fn from(v: Vector3) -> Self

Convert a vector into a point

impl From<Vector3> for Vector4

fn from(v: Vector3) -> Self

Convert a point into a vector

impl From<Vector4> for Vector3

fn from(v: Vector4) -> Self

Convert a point into a vector

impl Index<usize> for Vector3

type Output = f32

The returned type after indexing.

fn index(&self, i: usize) -> &f32

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Vector3

fn index_mut(&mut self, i: usize) -> &mut f32

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

impl Mul<Matrix4> for Vector3

type Output = Vector3

The resulting type after applying the * operator.

fn mul(self, rhs: Matrix4) -> Vector3

Performs the * operation.

impl Mul<Vector3> for Matrix4

type Output = Vector3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vector3> for f32

type Output = Vector3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Vector3

type Output = Vector3

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f32> for Vector3

fn mul_assign(&mut self, t: f32)

Performs the *= operation.

impl NearlyEqual for &Vector3

fn nearly_equals(self, rhs: Self) -> bool

impl Neg for Vector3

type Output = Vector3

The resulting type after applying the - operator.

fn neg(self) -> Vector3

Performs the unary - operation.

impl PartialEq<Vector3> for Vector3

fn eq(&self, other: &Vector3) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Vector3) -> bool

This method tests for !=.

impl Sub<Vector3> for Vector3

type Output = Vector3

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Vector3> for Point

type Output = Point

The resulting type after applying the - operator.

fn sub(self, rhs: Vector3) -> Point

Performs the - operation.

impl Sub<f32> for Vector3

type Output = Vector3

The resulting type after applying the - operator.

fn sub(self, t: f32) -> Self::Output

Performs the - operation.

impl SubAssign<Vector3> for Vector3

fn sub_assign(&mut self, rhs: Vector3)

Performs the -= operation.

impl SubAssign<Vector3> for Point

fn sub_assign(&mut self, rhs: Vector3)

Performs the -= operation.

impl SubAssign<f32> for Vector3

fn sub_assign(&mut self, t: f32)

Performs the -= operation.

impl Copy for Vector3

impl StructuralPartialEq for Vector3