geom::primitive::ray< T, N > Struct Template Reference

Half of a line proceeding from an initial point. More...

#include <ray.hpp>

Public Types
using	vector_type = math::vector< T, N >
	Vector type. More...

Public Member Functions
constexpr vector_type	extrapolate (T distance) const noexcept
	Extrapolates from the ray origin along the ray direction vector. More...
constexpr vector_type	closest_point (const vector_type &point) const noexcept
	Calculates the closest point on the ray to a point. More...
constexpr T	sqr_distance (const vector_type &point) const noexcept
	Calculates the square distance from the ray to a point. More...
T	distance (const vector_type &point) const noexcept
	Calculates the distance from the ray to a point. More...

Public Attributes
vector_type	origin
	Ray origin position. More...
vector_type	direction
	Ray direction vector. More...

Detailed Description

template<class T, std::size_t N>
struct geom::primitive::ray< T, N >

Half of a line proceeding from an initial point.

Template Parameters

T	Real type.
N	Number of dimensions.

Definition at line 37 of file primitives/ray.hpp.

Member Typedef Documentation

vector_type

template<class T , std::size_t N>

using geom::primitive::ray< T, N >::vector_type = math::vector<T, N>

Vector type.

Definition at line 40 of file primitives/ray.hpp.

Member Function Documentation

closest_point()

template<class T , std::size_t N>

constexpr vector_type geom::primitive::ray< T, N >::closest_point ( const vector_type &  point ) const

inlineconstexprnoexcept

Calculates the closest point on the ray to a point.

Parameters

point

Input point.

Returns

Closest point on the ray to point.

Definition at line 67 of file primitives/ray.hpp.

distance()

template<class T , std::size_t N>

T geom::primitive::ray< T, N >::distance ( const vector_type &  point ) const

inlinenoexcept

Calculates the distance from the ray to a point.

Parameters

point

Input point.

Returns

Distance from the ray to point.

Definition at line 91 of file primitives/ray.hpp.

extrapolate()

template<class T , std::size_t N>

constexpr vector_type geom::primitive::ray< T, N >::extrapolate ( T  distance ) const

inlineconstexprnoexcept

Extrapolates from the ray origin along the ray direction vector.

Parameters

distance

Signed extrapolation distance.

Returns

Extrapolated coordinates.

Definition at line 55 of file primitives/ray.hpp.

sqr_distance()

template<class T , std::size_t N>

constexpr T geom::primitive::ray< T, N >::sqr_distance ( const vector_type &  point ) const

inlineconstexprnoexcept

Calculates the square distance from the ray to a point.

Parameters

point

Input point.

Returns

Square distance from the ray to point.

Definition at line 79 of file primitives/ray.hpp.

Member Data Documentation

direction

template<class T , std::size_t N>

vector_type geom::primitive::ray< T, N >::direction

Ray direction vector.

Definition at line 46 of file primitives/ray.hpp.

origin

template<class T , std::size_t N>

vector_type geom::primitive::ray< T, N >::origin

Ray origin position.

Definition at line 43 of file primitives/ray.hpp.

---

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

• primitives/ray.hpp