Struct Vec3 

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

A three-dimensional vector with double-precision components.

Fields

x: f64

The x component.

y: f64

The y component.

z: f64

The z component.

Implementations

impl Vec3

pub const ZERO: Self

The zero vector.

pub const X: Self

The positive x-axis unit vector.

pub const Y: Self

The positive y-axis unit vector.

pub const Z: Self

The positive z-axis unit vector.

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

Creates a vector from Cartesian components.

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

Returns the dot product with rhs.

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

Returns the right-handed cross product with rhs.

pub fn length_squared(self) -> f64

Returns the squared Euclidean length.

pub fn length(self) -> f64

Returns the Euclidean length.

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

Returns a unit vector in the same direction, or None if the vector is zero, too small to normalize reliably, or non-finite.

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

Returns the Euclidean distance to rhs.

pub fn is_finite(self) -> bool

Returns whether all components are finite.

pub fn component(self, index: usize) -> f64

Returns the component at index 0, 1, or 2.

Panics

Panics when index is greater than 2.

pub fn canonicalized(self) -> Self

Chooses a deterministic sign by making the largest-magnitude component non-negative.

pub fn orthonormal_basis(self) -> Option<(Self, Self)>

Builds two unit vectors perpendicular to this vector and each other.

Returns None when this vector cannot be normalized.

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

fn add_assign(&mut self, r: 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<'de> Deserialize<'de> for Vec3

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 Mul<f64> for Vec3

type Output = Vec3

The resulting type after applying the * operator.

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

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Vec3

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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

fn sub_assign(&mut self, r: Self)

Performs the -= operation.