Struct crystal_ball::math::Vec3

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

A 3-dimensional vector.

Fields

x: f64

y: f64

z: f64

Implementations

impl Vec3

pub const X: Vec3 = _

pub const Y: Vec3 = _

pub const Z: Vec3 = _

pub const ZERO: Vec3 = _

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

Create a new Vec3.

pub fn splat(value: f64) -> Self

Create a new Vec3 with all elements set to value.

pub fn random(rng: &mut TlsWyRand, min: f64, max: f64) -> Self

Generate a Vec3 where each component is a uniform random number between min and max.

pub fn random_unit_vector(rng: &mut TlsWyRand) -> Self

Generate a random Vec3 on the surface of the unit sphere with uniform (i.e. isotropic) distribution.

pub fn random_in_unit_sphere(rng: &mut TlsWyRand) -> Self

Generate a random Vec3 inside the unit sphere with uniform distribution.

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

Reflect the self with respect to the given normal.

pub fn refract( self, normal: Vec3, n1: f64, n2: f64, rng: &mut TlsWyRand ) -> Self

Refract the self with respect to the given normal using n1 and n2 as the indices of refraction.

pub fn to_point3(&self) -> Point3

Convert the Vec2 to a Point2.

pub fn magnitude(&self) -> f64

Calculate the vector’s magnitude (length).

pub fn magnitude_squared(&self) -> f64

Calculate the square of the vector’s magnitude (length).

pub fn abs(&self) -> f64

Return the absolute value (synonym magnitude).

pub fn normalize(&self) -> Self

Return the unit vector parallel to self.

Panics

Panics if self cannot be normalized.

pub fn dot(vec_a: Vec3, vec_b: Vec3) -> f64

Calculate the dot product between two Vec3s.

pub fn cross(vec_a: Vec3, vec_b: Vec3) -> Self

Calculate the cross product between two Vec3s.

pub fn extend(&self, w: f64) -> Vec4

Create a new Vec4 using the x, y and z values of self and the given w value.

pub fn xyz(&self) -> Vec2

Create a new Vec2 discarding the z value.

Trait Implementations

impl Add<Vec3> for Point3

type Output = Point3

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Vec3

type Output = Vec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Vec3> for Point3

fn add_assign(&mut self, rhs: Vec3)

Performs the += operation.

impl AddAssign for Vec3

fn add_assign(&mut self, rhs: Vec3)

Performs the += operation.

impl Clone for Vec3

fn clone(&self) -> Vec3

Returns a copy 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<f64> for Vec3

type Output = Vec3

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f64> for Vec3

fn div_assign(&mut self, rhs: f64)

Performs the /= operation.

impl From<[f64; 3]> for Vec3

fn from(s: [f64; 3]) -> Self

Converts to this type from the input type.

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

fn from(t: (f64, f64, f64)) -> Self

Converts to this type from the input type.

impl From<Color> for Vec3

fn from(c: Color) -> Self

Converts to this type from the input type.

impl From<Point3> for Vec3

fn from(p: Point3) -> Self

Converts to this type from the input type.

impl From<Vec3> for Color

fn from(v: Vec3) -> Self

Converts to this type from the input type.

impl From<Vec3> for Point3

fn from(v: Vec3) -> Self

Converts to this type from the input type.

impl Index<usize> for Vec3

type Output = f64

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 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 f64

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for Vec3

type Output = Vec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f64> for Vec3

fn mul_assign(&mut self, rhs: f64)

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub<Vec3> for Point3

type Output = Point3

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Vec3

type Output = Vec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Vec3> for Point3

fn sub_assign(&mut self, rhs: Vec3)

Performs the -= operation.

impl SubAssign for Vec3

fn sub_assign(&mut self, rhs: Vec3)

Performs the -= operation.

impl TryFrom<&[f64]> for Vec3

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(s: &[f64]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<f64>> for Vec3

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(v: Vec<f64>) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Vec3

impl StructuralPartialEq for Vec3