Struct raytracer::Ray

pub struct Ray {
    pub origin: Vec3,
    pub direction: Vec3,
}

This struct represents a mathematical ray.

Fields

origin: Vec3

Starting point of a ray.

direction: Vec3

Direction of a ray.

In mathematics, ray does not have a length, but this vector isn't guaranteed to be an unit vector. It is useful when distance between origin and point that ray intersects is needed.

Methods

impl Ray

pub fn new(origin: Vec3, direction: Vec3) -> Ray

Ray constructor.

Examples

let r = Ray::new(vec3!(0.0), vec3!(5.0));

assert_eq!(r.origin, vec3!(0.0));
assert_eq!(r.direction, vec3!(5.0));

pub fn at(self, t: f32) -> Vec3

Returns a point between origin and direction.

When t = 0, returns Ray.origin, when t = 1, returns Ray.direction.

Examples

let origin = vec3!(0.0);
let direction = vec3!(10.0);

let r = ray!(origin, direction);

assert_eq!(r.at(0.0), origin);
assert_eq!(r.at(0.75), vec3!(7.5));
assert_eq!(r.at(1.0), direction);

Trait Implementations

impl Clone for Ray

fn clone(&self) -> Ray

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Ray

impl PartialEq<Ray> for Ray

fn eq(&self, other: &Ray) -> bool

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

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

This method tests for !=.

impl Debug for Ray

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

Formats the value using the given formatter.