Struct Vec3 

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

A free 3-D vector with f64 components.

Distinct from crate::Point3: a Vec3 represents a direction + magnitude, while a Point3 represents a location. The two types are deliberately separated so the compiler catches confusion between them.

Fields

x: f64

X component.

y: f64

Y component.

z: f64

Z component.

Implementations

impl Vec3

pub const ZERO: Self

Zero vector.

pub const X: Self

Unit vector along +X.

pub const Y: Self

Unit vector along +Y.

pub const Z: Self

Unit vector along +Z.

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

Construct from components.

pub fn length_sq(self) -> f64

Squared Euclidean length.

pub fn length(self) -> f64

Euclidean length.

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

Dot product.

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

Cross product: self × rhs.

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

Return the normalised version of this vector, or None if near-zero.

pub fn normalize(self) -> Self

Normalise without a safety check (panics on zero in debug builds).

pub fn abs(self) -> Self

Component-wise absolute value.

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

Reflect self about a unit normal n.

pub fn any_perp(self) -> Self

Return a vector perpendicular to self (arbitrary, consistent).

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

Linearly interpolate: (1-t)*self + t*rhs.

Trait Implementations

impl Add for Vec3

type Output = Vec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Vec3> for Point3

Point3 + Vec3 → Point3

type Output = Point3

The resulting type after applying the + operator.

fn add(self, v: Vec3) -> Self

Performs the + operation.

impl AddAssign for Vec3

fn add_assign(&mut self, r: Self)

Performs the += operation.

impl AddAssign<Vec3> for Point3

fn add_assign(&mut self, v: Vec3)

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

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

Formats the value using the given formatter.

impl Div<f64> for Vec3

type Output = Vec3

The resulting type after applying the / operator.

fn div(self, s: f64) -> Self

Performs the / operation.

impl DivAssign<f64> for Vec3

fn div_assign(&mut self, s: f64)

Performs the /= operation.

impl From<UnitVec3> for Vec3

fn from(u: UnitVec3) -> Vec3

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 f64

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for Vec3

type Output = Vec3

The resulting type after applying the * operator.

fn mul(self, s: f64) -> Self

Performs the * operation.

impl MulAssign<f64> for Vec3

fn mul_assign(&mut self, s: f64)

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

impl Sub for Vec3

type Output = Vec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Vec3> for Point3

Point3 - Vec3 → Point3

type Output = Point3

The resulting type after applying the - operator.

fn sub(self, v: Vec3) -> Self

Performs the - operation.

impl SubAssign for Vec3

fn sub_assign(&mut self, r: Self)

Performs the -= operation.