Struct graphene::Ray

pub struct Ray(_);

A ray emitted from an origin in a given direction.

The contents of the graphene_ray_t structure are private, and should not be modified directly.

Implementations

impl Ray

pub fn closest_point_to_point(&self, p: &Point3D) -> Point3D

Computes the point on the given Ray that is closest to the given point p.

p

a Point3D

Returns

res

return location for the closest point3d

pub fn direction(&self) -> Vec3

Retrieves the direction of the given Ray.

Returns

direction

return location for the direction

pub fn distance_to_plane(&self, p: &Plane) -> f32

Computes the distance of the origin of the given Ray from the given plane.

If the ray does not intersect the plane, this function returns INFINITY.

p

a Plane

Returns

the distance of the origin of the ray from the plane

pub fn distance_to_point(&self, p: &Point3D) -> f32

Computes the distance of the closest approach between the given Ray self and the point p.

The closest approach to a ray from a point is the distance between the point and the projection of the point on the ray itself.

p

a Point3D

Returns

the distance of the point

pub fn origin(&self) -> Point3D

Retrieves the origin of the given Ray.

Returns

origin

return location for the origin

pub fn position_at(&self, t: f32) -> Point3D

Retrieves the coordinates of a point at the distance t along the given Ray.

t

the distance along the ray

Returns

position

return location for the position

pub fn init(&mut self, origin: Option<&Point3D>, direction: Option<&Vec3>)

Initializes the given Ray using the given origin and direction values.

origin

the origin of the ray

direction

the direction vector

Returns

the initialized ray

pub fn init_from_ray(&mut self, src: &Ray)

Initializes the given Ray using the origin and direction values of another Ray.

src

a Ray

Returns

the initialized ray

pub fn init_from_vec3(
    &mut self,
    origin: Option<&Vec3>,
    direction: Option<&Vec3>
)

Initializes the given Ray using the given vectors.

origin

a Vec3

direction

a Vec3

Returns

the initialized ray

pub fn intersect_box(&self, b: &Box) -> (RayIntersectionKind, f32)

Intersects the given Ray self with the given Box b.

b

a Box

Returns

the type of intersection

t_out

the distance of the point on the ray that intersects the box

pub fn intersect_sphere(&self, s: &Sphere) -> (RayIntersectionKind, f32)

Intersects the given Ray self with the given Sphere s.

s

a Sphere

Returns

the type of intersection

t_out

the distance of the point on the ray that intersects the sphere

pub fn intersect_triangle(&self, t: &Triangle) -> (RayIntersectionKind, f32)

Intersects the given Ray self with the given Triangle t.

t

a Triangle

Returns

the type of intersection

t_out

the distance of the point on the ray that intersects the triangle

pub fn intersects_box(&self, b: &Box) -> bool

Checks whether the given Ray self intersects the given Box b.

See also: intersect_box()

b

a Box

Returns

true if the ray intersects the box

pub fn intersects_sphere(&self, s: &Sphere) -> bool

Checks if the given Ray self intersects the given Sphere s.

See also: intersect_sphere()

s

a Sphere

Returns

true if the ray intersects the sphere

pub fn intersects_triangle(&self, t: &Triangle) -> bool

Checks whether the given Ray self intersects the given Triangle b.

See also: intersect_triangle()

t

a Triangle

Returns

true if the ray intersects the triangle

impl Ray

pub fn new(origin: Option<&Point3D>, direction: Option<&Vec3>) -> Ray

pub fn from_ray(src: &Ray) -> Ray

pub fn from_vec3(origin: Option<&Vec3>, direction: Option<&Vec3>) -> Ray

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 Debug for Ray

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

Formats the value using the given formatter.

impl Hash for Ray

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Ray

fn cmp(&self, other: &Ray) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Ray> for Ray

fn eq(&self, other: &Self) -> 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 !=.

impl PartialOrd<Ray> for Ray

fn partial_cmp(&self, other: &Ray) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Ray

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Ray