Struct Ray3

pub struct Ray3 { /* private fields */ }

A 3D ray that holds an origin and direction both as 3D vectors

Implementations

impl Ray3

Constructors

pub fn new(origin: Vector3, direction: Vector3) -> Self

Creates a new 3D ray

• origin: The origin of the ray
• direction: The direction the ray is pointing at

Returns: Returns a new 3D ray

Examples

let ray = Ray3::new(Vector3::one(), Vector3::forward());
assert_eq!(Vector3::one(), ray.origin());
assert_eq!(Vector3::forward(), ray.direction());

impl Ray3

Properties

pub fn origin(&self) -> Vector3

Gets the origin of the ray as a 3D vector

Returns: Returns the origin of the ray

Examples

let ray = Ray3::new(Vector3::one(), Vector3::forward());
assert_eq!(Vector3::one(), ray.origin());

pub fn set_origin(&mut self, value: Vector3)

Sets the origin of the ray

• value: The value to set the origin to

Examples

let mut ray = Ray3::new(Vector3::one(), Vector3::forward());
ray.set_origin(Vector3::forward());
assert_eq!(Vector3::forward(), ray.origin());

pub fn direction(&self) -> Vector3

Gets the direction of the ray as a 3D vector

Returns: Returns the direction of the ray

Examples

let ray = Ray3::new(Vector3::one(), Vector3::forward());
assert_eq!(Vector3::forward(), ray.direction());

pub fn set_direction(&mut self, value: Vector3)

Sets the direction of the ray

• value: The value to set the direction to

Examples

let mut ray = Ray3::new(Vector3::one(), Vector3::forward());
 
ray.set_direction(Vector3::one());
assert_eq!(Vector3::one(), ray.direction());

impl Ray3

Public Methods

pub fn get_point(self, distance: f32) -> Vector3

Gets the point on the ray from the given distance

• distance: The distance from the ray to get the point from

Returns: Returns a 3D point from the given distance from the ray

Examples

let ray = Ray3::new(Vector3::one(), Vector3::forward());
let point = ray.get_point(4.3);
assert_eq!(Vector3::new(1.0, 1.0, 5.3), point);

pub fn closest_point(self, point: Vector3) -> Vector3

Gets the closest point on the ray from the given point

• point: The point to get the closest point from

Returns: Returns the closest point from the given point

Examples

let ray = Ray3::new(Vector3::one(), Vector3::forward());
let point = ray.closest_point(Vector3::down());
assert_eq!(Vector3::new(1.0, 1.0, 0.0), point);

pub fn distance(self, point: Vector3) -> f32

Gets the distance between the point and the ray’s line

• point: The point to check the distance from

Returns: Returns the distance between the point and the ray’s line

Examples

let ray = Ray3::new(Vector3::forward(), Vector3::forward());
let distance = ray.distance(Vector3::down());
assert_eq!(1.0, distance);
let ray = Ray3::new(Vector3::one(), Vector3::forward());
let distance = ray.distance(Vector3::down());
assert_eq!(2.236068, distance);

Trait Implementations

impl Clone for Ray3

fn clone(&self) -> Ray3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ray3

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

Formats the value using the given formatter.

impl Div<Ray3> for f32

type Output = Ray3

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Ray3> for i32

type Output = Ray3

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f32> for Ray3

type Output = Ray3

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<i32> for Ray3

type Output = Ray3

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f32> for Ray3

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl DivAssign<i32> for Ray3

fn div_assign(&mut self, rhs: i32)

Performs the /= operation.

impl From<Ray2> for Ray3

fn from(value: Ray2) -> Self

Converts to this type from the input type.

impl From<Ray3> for Ray2

fn from(value: Ray3) -> Self

Converts to this type from the input type.

impl Mul<Ray3> for f32

type Output = Ray3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Ray3> for i32

type Output = Ray3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Ray3

type Output = Ray3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<i32> for Ray3

type Output = Ray3

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f32> for Ray3

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl MulAssign<i32> for Ray3

fn mul_assign(&mut self, rhs: i32)

Performs the *= operation.

impl Neg for Ray3

type Output = Ray3

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Ray3

fn eq(&self, other: &Self) -> 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 Copy for Ray3

impl Eq for Ray3

impl Send for Ray3

impl Sync for Ray3