Claudette
 All Classes Namespaces Files Functions Enumerations Enumerator Friends Macros
Public Types | Public Member Functions | List of all members
Claudette::RayCollisionTest Class Reference

Collision test with a ray. More...

#include <ray_collision_test.h>

Inheritance diagram for Claudette::RayCollisionTest:
Claudette::BaseCollisionTest

Public Types

enum  Search { SearchClosestTriangle, SearchFirstTriangle }
 Search option for the colliding triangle. More...
 

Public Member Functions

 RayCollisionTest ()
 
 ~RayCollisionTest ()
 
const float * rayOrigin () const
 
void setRayOrigin (float x, float y, float z)
 
const float * rayDirection () const
 
void setRayDirection (float x, float y, float z)
 
float raySegmentMin () const
 
float raySegmentMax () const
 
void setRaySegmentBounds (float min=0.f, float max=3.4e+38f)
 
Search raySearch () const
 
void setRaySearch (Search srh)
 
- Public Member Functions inherited from Claudette::BaseCollisionTest
 BaseCollisionTest ()
 
 ~BaseCollisionTest ()
 
bool collides () const
 Collision result, returns true if a collision was detected. More...
 
const float * modelTriangle () const
 The triangle that collided (belongs to this model) More...
 
int triangleId () const
 The index of the triangle that collided (belongs to this model) More...
 
const float * point () const
 The detected collision point (array of 3 items containing x,y,z coords) More...
 

Additional Inherited Members

- Protected Member Functions inherited from Claudette::BaseCollisionTest
float * mutablePoint ()
 

Detailed Description

Collision test with a ray.

Definition at line 9 of file ray_collision_test.h.

Member Enumeration Documentation

Search option for the colliding triangle.

Enumerator
SearchClosestTriangle 

Search closest triangle on the ray (will slow the test considerably)

SearchFirstTriangle 

Search stop on the first triangle found that collides with the ray (may not be the closest)

Definition at line 13 of file ray_collision_test.h.

Constructor & Destructor Documentation

Claudette::RayCollisionTest::RayCollisionTest ( )
Claudette::RayCollisionTest::~RayCollisionTest ( )

Member Function Documentation

const float* Claudette::RayCollisionTest::rayDirection ( ) const
const float* Claudette::RayCollisionTest::rayOrigin ( ) const
Search Claudette::RayCollisionTest::raySearch ( ) const
float Claudette::RayCollisionTest::raySegmentMax ( ) const
float Claudette::RayCollisionTest::raySegmentMin ( ) const
void Claudette::RayCollisionTest::setRayDirection ( float  x,
float  y,
float  z 
)
void Claudette::RayCollisionTest::setRayOrigin ( float  x,
float  y,
float  z 
)
void Claudette::RayCollisionTest::setRaySearch ( Search  srh)
void Claudette::RayCollisionTest::setRaySegmentBounds ( float  min = 0.f,
float  max = 3.4e+38f 
)

The default ray is a standard infinite ray. However, using segmin and segmax a line segment along the ray can be defined


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