mal_math::Ray Class Reference

Represents a geometric ray in 3D space. More...

#include "ray.hpp"

Collaboration diagram for mal_math::Ray:

Public Member Functions
	Ray ()=default
	Default constructor.
	Ray (vec3 const &origin, vec3 const &direction)
	Constructs a Ray with a given origin and direction.
constexpr vec3 const &	origin () const noexcept
	Retrieves the ray's origin (const version).
constexpr vec3 &	origin () noexcept
	Retrieves the ray's origin.
constexpr vec3 const &	direction () const noexcept
	Retrieves the ray's direction (const version).
constexpr vec3 const &	inv_direction () const noexcept
	Retrieves the inverse of the ray's direction.
constexpr ivec3 const &	sign () const noexcept
	Retrieves the sign of the inverse direction for each axis.
void	SetDirection (vec3 const &new_direction)
	Sets a new direction for the ray and updates associated attributes.
vec3	PointAtParameter (float t) const
	Computes a point along the ray based on the given parameter.

Private Member Functions
void	OnDirectionUpdate ()
	Updates attributes derived from the ray's direction.

Private Attributes
vec3	origin_
	The ray's starting point.
vec3	direction_
	The direction in which the ray extends.
vec3	inv_direction_
	The inverse of the ray's direction.
ivec3	sign_
	Sign of the inverse direction for each axis.

Detailed Description

Represents a geometric ray in 3D space.

The Ray class defines a ray originating from a point, extending infinitely in a given direction. It provides methods to query and set the origin and direction of the ray, as well as retrieving information beneficial for certain algorithms like intersection tests, such as the inverse direction and the sign.

Definition at line 23 of file ray.hpp.

Constructor & Destructor Documentation

Ray() [1/2]

mal_math::Ray::Ray ( )

default

Default constructor.

Ray() [2/2]

mal_math::Ray::Ray ( vec3 const & origin, vec3 const & direction )

inline

Constructs a Ray with a given origin and direction.

Parameters

origin	Starting point of the ray.
direction	Direction in which the ray extends.

Definition at line 33 of file ray.hpp.

Here is the call graph for this function:

Member Function Documentation

direction()

vec3 const & mal_math::Ray::direction ( ) const

inlinenodiscardconstexprnoexcept

Retrieves the ray's direction (const version).

Definition at line 42 of file ray.hpp.

Here is the caller graph for this function:

inv_direction()

vec3 const & mal_math::Ray::inv_direction ( ) const

inlinenodiscardconstexprnoexcept

Retrieves the inverse of the ray's direction.

Definition at line 44 of file ray.hpp.

Here is the caller graph for this function:

OnDirectionUpdate()

void mal_math::Ray::OnDirectionUpdate ( )

inlineprivate

Updates attributes derived from the ray's direction.

Definition at line 68 of file ray.hpp.

Here is the caller graph for this function:

origin() [1/2]

vec3 const & mal_math::Ray::origin ( ) const

inlinenodiscardconstexprnoexcept

Retrieves the ray's origin (const version).

Definition at line 38 of file ray.hpp.

Here is the caller graph for this function:

origin() [2/2]

vec3 & mal_math::Ray::origin ( )

inlinenodiscardconstexprnoexcept

Retrieves the ray's origin.

Definition at line 40 of file ray.hpp.

PointAtParameter()

vec3 mal_math::Ray::PointAtParameter ( float t ) const

inlinenodiscard

Computes a point along the ray based on the given parameter.

Parameters

t	The parameter value.

Returns

A point on the ray at the given parameter.

Definition at line 61 of file ray.hpp.

Here is the caller graph for this function:

SetDirection()

void mal_math::Ray::SetDirection ( vec3 const & new_direction )

inline

Sets a new direction for the ray and updates associated attributes.

Parameters

new_direction

The new direction for the ray.

Definition at line 51 of file ray.hpp.

Here is the call graph for this function:

sign()

ivec3 const & mal_math::Ray::sign ( ) const

inlinenodiscardconstexprnoexcept

Retrieves the sign of the inverse direction for each axis.

Definition at line 46 of file ray.hpp.

Here is the caller graph for this function:

Member Data Documentation

direction_

vec3 mal_math::Ray::direction_

private

The direction in which the ray extends.

Definition at line 74 of file ray.hpp.

inv_direction_

vec3 mal_math::Ray::inv_direction_

private

The inverse of the ray's direction.

Definition at line 75 of file ray.hpp.

origin_

vec3 mal_math::Ray::origin_

private

The ray's starting point.

Definition at line 73 of file ray.hpp.

sign_

ivec3 mal_math::Ray::sign_

private

Sign of the inverse direction for each axis.

Definition at line 76 of file ray.hpp.

---

The documentation for this class was generated from the following file:

• include/math/ray.hpp