Struct Vec3 

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

A 3D vector.

Fields

x: Float

X component.

y: Float

Y component.

z: Float

Z component.

Implementations

impl Vec3

pub const ZERO: Self

Zero vector (0, 0, 0).

pub const ONE: Self

One vector (1, 1, 1).

pub const X: Self

Unit X vector (1, 0, 0).

pub const Y: Self

Unit Y vector (0, 1, 0).

pub const Z: Self

Unit Z vector (0, 0, 1).

pub const NEG_X: Self

Negative X vector (-1, 0, 0).

pub const NEG_Y: Self

Negative Y vector (0, -1, 0).

pub const NEG_Z: Self

Negative Z vector (0, 0, -1).

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

Creates a new vector.

pub const fn splat(value: Float) -> Self

Creates a vector with all components set to the same value.

pub const fn from_array(arr: [Float; 3]) -> Self

Creates a vector from an array.

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

Converts the vector to an array.

pub const fn from_vec2(v: Vec2, z: Float) -> Self

Extends to Vec3 from Vec2 with a z component.

pub const fn xy(self) -> Vec2

Truncates to Vec2, discarding the z component.

pub const fn xz(self) -> Vec2

Returns the xz components as Vec2.

pub const fn yz(self) -> Vec2

Returns the yz components as Vec2.

pub fn dot(self, other: Self) -> Float

Computes the dot product.

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

Computes the cross product.

pub fn length_squared(self) -> Float

Computes the squared length.

pub fn length(self) -> Float

Computes the length.

pub fn normalize(self) -> Self

Returns a normalized vector.

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

Returns a normalized vector, or None if length is near zero.

pub fn distance(self, other: Self) -> Float

Computes the distance to another vector.

pub fn distance_squared(self, other: Self) -> Float

Computes the squared distance to another vector.

pub fn lerp(self, other: Self, t: Float) -> Self

Linear interpolation between two vectors.

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

Component-wise minimum.

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

Component-wise maximum.

pub fn abs(self) -> Self

Component-wise absolute value.

pub fn angle_between(self, other: Self) -> Float

Computes the angle in radians between two vectors.

pub fn approx_eq(self, other: Self) -> bool

Checks if this vector is approximately equal to another.

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

Reflects this vector off a surface with the given normal.

pub fn project(self, onto: Self) -> Self

Projects this vector onto another.

pub fn floor(self) -> Self

Returns the component-wise floor.

pub fn ceil(self) -> Self

Returns the component-wise ceil.

Trait Implementations

impl Add for Vec3

type Output = Vec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Vec3

fn add_assign(&mut self, other: 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 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, scalar: Float) -> Self

Performs the / operation.

impl DivAssign<f32> for Vec3

fn div_assign(&mut self, scalar: Float)

Performs the /= operation.

impl From<[f32; 3]> for Vec3

fn from(arr: [Float; 3]) -> Self

Converts to this type from the input type.

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

fn from((x, y, z): (Float, Float, Float)) -> Self

Converts to this type from the input type.

impl From<Vec3> for [Float; 3]

fn from(v: Vec3) -> Self

Converts to this type from the input type.

impl Mul<Vec3> for Mat3

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, v: Vec3) -> Vec3

Performs the * operation.

impl Mul<Vec3> for Quat

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, v: Vec3) -> Vec3

Performs the * operation.

impl Mul<Vec3> for Float

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, vec: Vec3) -> Vec3

Performs the * operation.

impl Mul<f32> for Vec3

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Vec3

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f32> for Vec3

fn mul_assign(&mut self, scalar: Float)

Performs the *= operation.

impl Neg for Vec3

type Output = Vec3

The resulting type after applying the - operator.

fn neg(self) -> Self

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 Sub for Vec3

type Output = Vec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Vec3

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Copy for Vec3

impl StructuralPartialEq for Vec3