Struct Vec3 

pub struct Vec3 {
    pub x: f32,
    pub y: f32,
    pub z: f32,
}

A three-dimensional vector.

Fields

x: f32

X component.

y: f32

Y component.

z: f32

Z component.

Implementations

impl Vec3

pub const ZERO: Self

The zero vector.

pub const ONE: Self

A vector with all components set to one.

pub const X: Self

Unit X.

pub const Y: Self

Unit Y.

pub const Z: Self

Unit Z.

pub const NEG_Z: Self

Negative unit Z.

pub const UP: Self = Self::Y

World-space up.

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

Creates a vector from components.

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

Returns the dot product.

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

Returns the cross product.

pub fn length_squared(self) -> f32

Returns the squared length.

pub fn length(self) -> f32

Returns the length.

pub fn normalize(self) -> Self

Returns a normalized vector, or zero for a near-zero input.

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

Linearly interpolates toward rhs.

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

Returns the distance to rhs.

pub fn reflect(self, normal: Self) -> Self

Reflects this vector around a normal.

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

Returns the angle between vectors in radians.

pub fn mul_elements(self, rhs: Self) -> Self

Multiplies components pairwise.

pub fn div_elements(self, rhs: Self) -> Self

Divides components pairwise. Zero divisors produce zero in that lane.

pub const fn to_array(self) -> [f32; 3]

Returns the vector as an array.

Trait Implementations

impl Add for Vec3

type Output = Vec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Vec3

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Vec3

fn clone(&self) -> Vec3

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Vec3

impl Debug for Vec3

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

Formats the value using the given formatter.

impl Default for Vec3

fn default() -> Vec3

Returns the “default value” for a type.

impl Div<f32> for Vec3

type Output = Vec3

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f32> for Vec3

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl Index<usize> for Vec3

type Output = f32

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Vec3

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

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

impl Mul<Vec3> for Mat3

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec3> for Mat4

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec3> for Quat

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vec3> for f32

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Vec3

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f32> for Vec3

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl Neg for Vec3

type Output = Vec3

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Vec3

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

impl Sub for Vec3

type Output = Vec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Vec3

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.