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

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

#include <RayPlaneHitTest.h>

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 Carna::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

Date

22.2.15 - 16.3.15

Definition at line 49 of file RayPlaneHitTest.h.

Constructor & Destructor Documentation

RayPlaneHitTest()

template<typename VectorType , typename ScalarType >

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

(

)

Instantiates.

Postcondition

hitExists() == false

Definition at line 87 of file RayPlaneHitTest.h.

Member Function Documentation

compute()

template<typename VectorType , typename ScalarType >

void Carna::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 109 of file RayPlaneHitTest.h.

hitExists()

template<typename VectorType , typename ScalarType >

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

(

)

const

Tells whether a hit exists.

Definition at line 94 of file RayPlaneHitTest.h.

hitLocation()

template<typename VectorType , typename ScalarType >

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

(

)

const

References the location of the hit.

Precondition

hitExists() == true

Definition at line 101 of file RayPlaneHitTest.h.

---

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

• include/Carna/base/math/RayPlaneHitTest.h