mal_math::Intersection Struct Reference

Represents the data of a ray's intersection with an object. More...

#include "intersection.hpp"

Collaboration diagram for mal_math::Intersection:

Public Member Functions
constexpr	Intersection ()=default
constexpr	Intersection (Intersection const &)=default
constexpr Intersection &	operator= (Intersection const &)=default
constexpr	Intersection (Intersection &&)=default
constexpr Intersection &	operator= (Intersection &&)=default
constexpr void	reset ()
	Resets the intersection data.
bool	exists () const
	Determines if the intersection exists based on the value of t.

Static Public Member Functions
static constexpr Intersection	infinite ()
	Creates and returns an intersection with t set to infinity.

Public Attributes
float	t
	The intersection parameter.
vec3	point
	The 3D point of intersection.
vec3	normal
	The 3D normal at the point of intersection.

Detailed Description

Represents the data of a ray's intersection with an object.

The Intersection structure encapsulates details of an intersection point, such as the intersection parameter t, the intersection point itself, and the normal at the intersection.

Definition at line 52 of file intersection.hpp.

Constructor & Destructor Documentation

Intersection() [1/3]

mal_math::Intersection::Intersection ( )

constexprdefault

Intersection() [2/3]

mal_math::Intersection::Intersection ( Intersection const & )

constexprdefault

Intersection() [3/3]

mal_math::Intersection::Intersection ( Intersection && )

constexprdefault

Member Function Documentation

exists()

bool mal_math::Intersection::exists ( ) const

inline

Determines if the intersection exists based on the value of t.

Returns

true If t is finite, indicating an intersection exists.

false Otherwise.

Definition at line 77 of file intersection.hpp.

infinite()

static constexpr Intersection mal_math::Intersection::infinite ( )

inlinestaticconstexpr

Creates and returns an intersection with t set to infinity.

Returns

Intersection An intersection object representing no intersection.

Definition at line 84 of file intersection.hpp.

Here is the call graph for this function:

operator=() [1/2]

Intersection & mal_math::Intersection::operator= ( Intersection && )

constexprdefault

operator=() [2/2]

Intersection & mal_math::Intersection::operator= ( Intersection const & )

constexprdefault

reset()

void mal_math::Intersection::reset ( )

inlineconstexpr

Resets the intersection data.

The intersection parameter t is set to infinity.

Definition at line 69 of file intersection.hpp.

Here is the caller graph for this function:

Member Data Documentation

normal

vec3 mal_math::Intersection::normal

The 3D normal at the point of intersection.

Definition at line 56 of file intersection.hpp.

point

vec3 mal_math::Intersection::point

The 3D point of intersection.

Definition at line 55 of file intersection.hpp.

t

float mal_math::Intersection::t

The intersection parameter.

Definition at line 54 of file intersection.hpp.

---

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

• include/math/intersection.hpp