Cafu Engine
RayResultT Class Reference

This class handles the results of tracing a ray through the world. More...

#include "PhysicsWorld.hpp"

Inheritance diagram for RayResultT:

Public Member Functions

 RayResultT (const btCollisionObject *IgnoreObject)
 The constructor. More...
 
TraceUserEntityTGetHitPhysicsComp () const
 If something was hit (hasHit() returns true), this method returns a pointer to the Physics component that the hit collision object belongs to. More...
 
virtual btScalar addSingleResult (btCollisionWorld::LocalRayResult &RayResult, bool NormalIsInWorldSpace)
 

Protected Attributes

const btCollisionObject * m_IgnoreObject
 

Detailed Description

This class handles the results of tracing a ray through the world.

As such, it is called back for intermediate results and thus can "configure" or "parametrize" the trace, and it keeps the final trace result for inspection by the caller as well.

Constructor & Destructor Documentation

RayResultT::RayResultT ( const btCollisionObject *  IgnoreObject)
inline

The constructor.

Parameters
IgnoreObjectA collision object to ignore for this trace. This is usually the object from which the trace emanates.

Member Function Documentation

TraceUserEntityT* RayResultT::GetHitPhysicsComp ( ) const
inline

If something was hit (hasHit() returns true), this method returns a pointer to the Physics component that the hit collision object belongs to.

The returned pointer is NULL if the collision object belongs to the world. If nothing was hit (hasHit() returns false), NULL is always returned.


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