LibCarna::base::math::RaySphereHitTest< VectorType, ScalarType > Class Template Reference

Tests whether sphere in origin is hit by a Ray object. More...

#include <RaySphereHitTest.hpp>

Public Member Functions
	RaySphereHitTest ()
	Instantiates.
void	compute (const Ray< VectorType > &ray, const ScalarType radius)
	Performs a hit test of ray with a sphere of radius radius. The sphere is assumed to be centered in the origin. Use hitExists and hitLocation to obtain the test results.
bool	hitExists () const
	Tells whether a hit exists.
const VectorType &	hitLocation () const
	References the location of the hit.

Detailed Description

template<typename VectorType, typename ScalarType>
class LibCarna::base::math::RaySphereHitTest< VectorType, ScalarType >

Tests whether sphere in origin is hit by a Ray object.

Parameters

VectorType	defines the vector type to use for computation.
ScalarType	defines the scalar type to use for computation.

Author

Leonid Kostrykin

Definition at line 52 of file RaySphereHitTest.hpp.

Constructor & Destructor Documentation

RaySphereHitTest()

template<typename VectorType , typename ScalarType >

LibCarna::base::math::RaySphereHitTest< VectorType, ScalarType >::RaySphereHitTest

(

)

Instantiates.

Postcondition

hitExists() == false

Definition at line 90 of file RaySphereHitTest.hpp.

Member Function Documentation

compute()

template<typename VectorType , typename ScalarType >

void LibCarna::base::math::RaySphereHitTest< VectorType, ScalarType >::compute	(	const Ray< VectorType > &	ray,
		const ScalarType	radius
	)

Performs a hit test of ray with a sphere of radius radius. The sphere is assumed to be centered in the origin. Use hitExists and hitLocation to obtain the test results.

Definition at line 112 of file RaySphereHitTest.hpp.

hitExists()

template<typename VectorType , typename ScalarType >

bool LibCarna::base::math::RaySphereHitTest< VectorType, ScalarType >::hitExists

(

)

const

Tells whether a hit exists.

Definition at line 97 of file RaySphereHitTest.hpp.

hitLocation()

template<typename VectorType , typename ScalarType >

const VectorType & LibCarna::base::math::RaySphereHitTest< VectorType, ScalarType >::hitLocation

(

)

const

References the location of the hit.

Precondition

hitExists() == true

Definition at line 104 of file RaySphereHitTest.hpp.

---

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

• include/LibCarna/base/math/RaySphereHitTest.hpp