Struct raytracer::Vec3

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

This struct represents a mathematical vector.

Fields

x: f32

y: f32

z: f32

Methods

impl Vec3

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

Vector constructor. Consider using a shorthand vec3!

Examples

let v = Vec3::new(1.0, 2.0, 3.0);

assert_eq!(v.x, 1.0);
assert_eq!(v.y, 2.0);
assert_eq!(v.z, 3.0);

pub fn dot(self, other: Vec3) -> f32

Returns dot product between current and other vector.

Examples

let a = vec3!(1.0, 2.0, 3.0);
let b = vec3!(3.0, 2.0, 1.0);

assert_eq!(a.dot(b), 10.0);

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

Returns cross product between current and other vector.

Examples

let i = vec3!(1.0, 0.0, 0.0);
let j = vec3!(0.0, 1.0, 0.0);
let k = vec3!(0.0, 0.0, 1.0);

assert_eq!(i.cross(j),  k);
assert_eq!(j.cross(i), -k);

pub fn len(self) -> f32

Returns magnitude of this vector.

Examples

let v = vec3!(3.0, 4.0, 0.0);

assert_eq!(v.len(), 5.0);

pub fn len_sqr(self) -> f32

Returns squared magnitude of this vector.

Examples

let v = vec3!(3.0, 4.0, 0.0);

assert_eq!(v.len_sqr(), 25.0);

pub fn normalize(self) -> Vec3

Returns normalized version of this vector.

Important: it does not alter original vector.

Examples

let a = vec3!(10.0, 0.0, 0.0);
let b = a.normalize();

assert_ne!(a, b);

assert_eq!(a, vec3!(10.0, 0.0, 0.0));
assert_eq!(b, vec3!(1.0, 0.0, 0.0));

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

Returns reflected vector.

• normal - Normal of the surface.

Examples

// reflective surface
let normal = vec3!(0.0, 1.0, 0.0);

// Reflection when ray is perpendicular
let incident = vec3!(0.0, -1.0, 0.0);
assert_eq!(incident.reflect(normal), vec3!(0.0, 1.0, 0.0));

// Incident ray coming at 45 degree angle
let incident = vec3!(-1.0, -1.0, 0.0);
assert_eq!(incident.reflect(normal), vec3!(-1.0, 1.0, 0.0));

pub fn refract(self, normal: Vec3, eta: f32) -> Option<Vec3>

Returns refracted vector.

At critical angles (typically nearing 0), refraction is impossible. In such case, this function returns None.

• normal - Normal of the surface.
• eta - η₁ / η₂ of refraction indexes, where η₁ is the material that is being entered by the ray.

Examples

// Glass surface
let n = 1.5; // η₁ / η₂, where η₁ = 1.5 (glass) and η₂ = 1.0 (air)
let normal = vec3!(0.0, 1.0, 0.0);

// Rays perpendicular to the surface aren't affected by refraction
let incident = vec3!(0.0, -1.0, 0.0);
assert_eq!(incident.refract(normal, n), Some(incident));

// Rays coming from an angle are refracted
let incident = vec3!(-0.7, -1.0, 0.0);
assert_eq!(incident.refract(normal, n), Some(vec3!(-0.86019355, -0.5099678, 0.0)));

// At critical angles (nearing 0), rays aren't refracted, only reflected
let incident = vec3!(-1.0, -0.05, 0.0);
assert_eq!(incident.refract(normal, n), None); // from outside of the surface

let incident = vec3!(1.0, 0.05, 0.0);
assert_eq!(incident.refract(normal, n), None); // from inside of the surface

Trait Implementations

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

impl PartialEq<Vec3> 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: &Vec3) -> bool

This method tests for !=.

impl Debug for Vec3

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

Formats the value using the given formatter.

impl Add<Vec3> for Vec3

type Output = Vec3

The resulting type after applying the + operator.

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

Sums vector components.

Examples

let a = vec3!(1.0, 2.0, 5.0);
let b = vec3!(2.0, 4.0, 5.0);

assert_eq!(a + b, vec3!(3.0, 6.0, 10.0));

impl Sub<Vec3> for Vec3

type Output = Vec3

The resulting type after applying the - operator.

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

Subtracts vector components.

Examples

let a = vec3!(1.0, 2.0, 3.0);
let b = vec3!(0.5);

assert_eq!(a - b, vec3!(0.5, 1.5, 2.5));

impl Mul<Vec3> for Vec3

type Output = Vec3

The resulting type after applying the * operator.

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

Multiplies vector components. This is NOT a dot product.

Examples

let a = vec3!(1.0, 2.0, 3.0);
let b = vec3!(2.0);

assert_eq!(a * b, vec3!(2.0, 4.0, 6.0));

impl Mul<f32> for Vec3

type Output = Vec3

The resulting type after applying the * operator.

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

Multiplies each vector component by scalar.

Examples

let v = vec3!(1.0, 2.0, 3.0);
let s = 3.0;

assert_eq!(v * s, vec3!(3.0, 6.0, 9.0))

impl Mul<Vec3> for f32

type Output = Vec3

The resulting type after applying the * operator.

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

Multiplies each vector component by scalar.

Examples

let v = vec3!(1.0, 2.0, 3.0);
let s = 3.0;

assert_eq!(s * v, vec3!(3.0, 6.0, 9.0))

impl Div<Vec3> for Vec3

type Output = Vec3

The resulting type after applying the / operator.

fn div(self, other: Vec3) -> Self::Output

Divides vector components.

Examples

let a = vec3!(4.0, 2.0, 10.0);
let b = vec3!(2.0);

assert_eq!(a / b, vec3!(2.0, 1.0, 5.0));

impl Div<f32> for Vec3

type Output = Vec3

The resulting type after applying the / operator.

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

Divides each vector component by scalar.

Examples

let a = vec3!(4.0, 2.0, 10.0);
let s = 2.0;

assert_eq!(a / s, vec3!(2.0, 1.0, 5.0));

impl Neg for Vec3

type Output = Vec3

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Negates each vector component.

Examples

let a = vec3!(1.0, 2.5, 7.0);
let b = -a;

assert_eq!(b.x, -a.x);
assert_eq!(b.y, -a.y);
assert_eq!(b.z, -a.z);

impl AddAssign<Vec3> for Vec3

fn add_assign(&mut self, other: Vec3)

Sums vector components and assigns the result to the vector on the left.

Examples

let mut a = vec3!(5.0);
let b = vec3!(1.0, 2.0, 3.0);
a += b;

assert_eq!(a, vec3!(6.0, 7.0, 8.0));

impl SubAssign<Vec3> for Vec3

fn sub_assign(&mut self, other: Vec3)

Subtracts vector components and assigns the result to the vector on the left.

Examples

let mut a = vec3!(5.0);
let b = vec3!(1.0, 2.0, 3.0);
a -= b;

assert_eq!(a, vec3!(4.0, 3.0, 2.0));

impl MulAssign<Vec3> for Vec3

fn mul_assign(&mut self, other: Vec3)

Multiplies vector components and assigns the result to the vector on the left.

Examples

let mut a = vec3!(1.0, 2.0, 3.0);
let b = vec3!(2.0);
a *= b;

assert_eq!(a, vec3!(2.0, 4.0, 6.0));

impl MulAssign<f32> for Vec3

fn mul_assign(&mut self, other: f32)

Multiplies each vector component by scalar and assigns the result to the vector.

Examples

let mut a = vec3!(1.0, 2.0, 3.0);
let s = 2.0;
a *= s;

assert_eq!(a, vec3!(2.0, 4.0, 6.0));

impl DivAssign<Vec3> for Vec3

fn div_assign(&mut self, other: Vec3)

Divides vector components and assigns the result to the vector on the left.

Examples

let mut a = vec3!(2.0, 4.0, 6.0);
let b = vec3!(2.0);
a /= b;

assert_eq!(a, vec3!(1.0, 2.0, 3.0));

impl DivAssign<f32> for Vec3

fn div_assign(&mut self, other: f32)

Divides each vector component by scalar and assigns the result to the vector.

Examples

let mut a = vec3!(2.0, 4.0, 6.0);
let s = 2.0;
a /= s;

assert_eq!(a, vec3!(1.0, 2.0, 3.0));