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

Tests whether particular plane is hit by a Ray object. More...

#include <RayPlaneHitTest.hpp>

Public Member Functions
	RayPlaneHitTest ()
	Instantiates.
void	compute (const Ray< VectorType > &ray, const VectorType &planeNormal, ScalarType planeOriginOffset)
	Performs a hit test of ray with the plane with planeNormal and planeOriginOffset. 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::RayPlaneHitTest< VectorType, ScalarType >

Tests whether particular plane 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 RayPlaneHitTest.hpp.

Constructor & Destructor Documentation

RayPlaneHitTest()

template<typename VectorType , typename ScalarType >

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

(

)

Instantiates.

Postcondition

hitExists() == false

Definition at line 90 of file RayPlaneHitTest.hpp.

Member Function Documentation

compute()

template<typename VectorType , typename ScalarType >

void LibCarna::base::math::RayPlaneHitTest< VectorType, ScalarType >::compute	(	const Ray< VectorType > &	ray,
		const VectorType &	planeNormal,
		ScalarType	planeOriginOffset
	)

Performs a hit test of ray with the plane with planeNormal and planeOriginOffset. Use hitExists and hitLocation to obtain the test results.

Definition at line 112 of file RayPlaneHitTest.hpp.

hitExists()

template<typename VectorType , typename ScalarType >

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

(

)

const

Tells whether a hit exists.

Definition at line 97 of file RayPlaneHitTest.hpp.

hitLocation()

template<typename VectorType , typename ScalarType >

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

(

)

const

References the location of the hit.

Precondition

hitExists() == true

Definition at line 104 of file RayPlaneHitTest.hpp.

---

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

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