OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::BspRaySceneQuery Class Reference

BSP specialisation of RaySceneQuery. More...

#include <OgreBspSceneManager.h>

+ Inheritance diagram for Ogre::BspRaySceneQuery:
+ Collaboration diagram for Ogre::BspRaySceneQuery:

Public Types

enum  WorldFragmentType {
  WFT_NONE, WFT_PLANE_BOUNDED_REGION, WFT_SINGLE_INTERSECTION, WFT_CUSTOM_GEOMETRY,
  WFT_RENDER_OPERATION
}
 This type can be used by collaborating applications & SceneManagers to agree on the type of world geometry to be returned from queries. More...
 

Public Member Functions

 BspRaySceneQuery (SceneManager *creator)
 
 ~BspRaySceneQuery ()
 
virtual void clearResults (void)
 Clears the results of the last query execution. More...
 
void execute (RaySceneQueryListener *listener)
 See RaySceneQuery. More...
 
virtual RaySceneQueryResultexecute (void)
 Executes the query, returning the results back in one list. More...
 
bool execute (ObjectData objData, size_t numNodes, RaySceneQueryListener *listener)
 
virtual RaySceneQueryResultgetLastResults (void)
 Gets the results of the last query that was run using this object, provided the query was executed using the collection-returning version of execute. More...
 
virtual ushort getMaxResults (void) const
 Gets the maximum number of results returned from the query (only relevant if results are being sorted) More...
 
virtual uint32 getQueryMask (void) const
 Returns the current mask for this query. More...
 
virtual const RaygetRay (void) const
 Gets the ray which is to be used for this query. More...
 
virtual bool getSortByDistance (void) const
 Gets whether the results are sorted by distance. More...
 
virtual const set
< WorldFragmentType >::type * 
getSupportedWorldFragmentTypes (void) const
 Returns the types of world fragments this query supports. More...
 
virtual WorldFragmentType getWorldFragmentType (void) const
 Gets the current world fragment types to be returned from the query. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
bool queryResult (MovableObject *obj, Real distance)
 Self-callback in order to deal with execute which returns collection. More...
 
bool queryResult (SceneQuery::WorldFragment *fragment, Real distance)
 Self-callback in order to deal with execute which returns collection. More...
 
virtual void setQueryMask (uint32 mask)
 Sets the mask for results of this query. More...
 
virtual void setRay (const Ray &ray)
 Sets the ray which is to be used for this query. More...
 
virtual void setSortByDistance (bool sort, ushort maxresults=0)
 Sets whether the results of this query will be sorted by distance along the ray. More...
 
virtual void setWorldFragmentType (enum WorldFragmentType wft)
 Tells the query what kind of world geometry to return from queries; often the full renderable geometry is not what is needed. More...
 

Public Attributes

uint8 mFirstRq
 
uint8 mLastRq
 

Protected Member Functions

void clearTemporaries (void)
 
bool processLeaf (const BspNode *node, const Ray &tracingRay, RaySceneQueryListener *listener, Real maxDistance=Math::POS_INFINITY, Real traceDistance=0.0f)
 Internal processing of a single leaf. More...
 
bool processNode (const BspNode *node, const Ray &tracingRay, RaySceneQueryListener *listener, Real maxDistance=Math::POS_INFINITY, Real traceDistance=0.0f)
 Internal processing of a single node. More...
 

Protected Attributes

ushort mMaxResults
 
set< MovableObject * >::type mObjsThisQuery
 Set for eliminating duplicates since objects can be in > 1 node. More...
 
SceneManagermParentSceneMgr
 
uint32 mQueryMask
 
Ray mRay
 
RaySceneQueryResult mResult
 
vector
< SceneQuery::WorldFragment * >
::type 
mSingleIntersections
 list of the last single intersection world fragments (derived) More...
 
bool mSortByDistance
 
set< WorldFragmentType >::type mSupportedWorldFragments
 
WorldFragmentType mWorldFragmentType
 

Detailed Description

BSP specialisation of RaySceneQuery.

Definition at line 237 of file OgreBspSceneManager.h.

Member Enumeration Documentation

This type can be used by collaborating applications & SceneManagers to agree on the type of world geometry to be returned from queries.

Not all these types will be supported by all SceneManagers; once the application has decided which SceneManager specialisation to use, it is expected that it will know which type of world geometry abstraction is available to it.

Enumerator
WFT_NONE 

Return no world geometry hits at all.

WFT_PLANE_BOUNDED_REGION 

Return pointers to convex plane-bounded regions.

WFT_SINGLE_INTERSECTION 

Return a single intersection point (typically RaySceneQuery only)

WFT_CUSTOM_GEOMETRY 

Custom geometry as defined by the SceneManager.

WFT_RENDER_OPERATION 

General RenderOperation structure.

Definition at line 77 of file OgreSceneQuery.h.

Constructor & Destructor Documentation

Ogre::BspRaySceneQuery::BspRaySceneQuery ( SceneManager creator)
Ogre::BspRaySceneQuery::~BspRaySceneQuery ( )

Member Function Documentation

virtual void Ogre::RaySceneQuery::clearResults ( void  )
virtualinherited

Clears the results of the last query execution.

Remarks
You only need to call this if you specifically want to free up the memory used by this object to hold the last query results. This object clears the results itself when executing and when destroying itself.
void Ogre::BspRaySceneQuery::clearTemporaries ( void  )
protected
void Ogre::BspRaySceneQuery::execute ( RaySceneQueryListener listener)
virtual

See RaySceneQuery.

Reimplemented from Ogre::DefaultRaySceneQuery.

virtual RaySceneQueryResult& Ogre::RaySceneQuery::execute ( void  )
virtualinherited

Executes the query, returning the results back in one list.

Remarks
This method executes the scene query as configured, gathers the results into one structure and returns a reference to that structure. These results will also persist in this query object until the next query is executed, or clearResults() is called. An more lightweight version of this method that returns results through a listener is also available.
bool Ogre::DefaultRaySceneQuery::execute ( ObjectData  objData,
size_t  numNodes,
RaySceneQueryListener listener 
)
inherited
virtual RaySceneQueryResult& Ogre::RaySceneQuery::getLastResults ( void  )
virtualinherited

Gets the results of the last query that was run using this object, provided the query was executed using the collection-returning version of execute.

virtual ushort Ogre::RaySceneQuery::getMaxResults ( void  ) const
virtualinherited

Gets the maximum number of results returned from the query (only relevant if results are being sorted)

virtual uint32 Ogre::SceneQuery::getQueryMask ( void  ) const
virtualinherited

Returns the current mask for this query.

virtual const Ray& Ogre::RaySceneQuery::getRay ( void  ) const
virtualinherited

Gets the ray which is to be used for this query.

virtual bool Ogre::RaySceneQuery::getSortByDistance ( void  ) const
virtualinherited

Gets whether the results are sorted by distance.

virtual const set<WorldFragmentType>::type* Ogre::SceneQuery::getSupportedWorldFragmentTypes ( void  ) const
inlinevirtualinherited

Returns the types of world fragments this query supports.

Definition at line 166 of file OgreSceneQuery.h.

virtual WorldFragmentType Ogre::SceneQuery::getWorldFragmentType ( void  ) const
virtualinherited

Gets the current world fragment types to be returned from the query.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

bool Ogre::BspRaySceneQuery::processLeaf ( const BspNode node,
const Ray tracingRay,
RaySceneQueryListener listener,
Real  maxDistance = Math::POS_INFINITY,
Real  traceDistance = 0.0f 
)
protected

Internal processing of a single leaf.

Returns
true if we should continue tracing, false otherwise
bool Ogre::BspRaySceneQuery::processNode ( const BspNode node,
const Ray tracingRay,
RaySceneQueryListener listener,
Real  maxDistance = Math::POS_INFINITY,
Real  traceDistance = 0.0f 
)
protected

Internal processing of a single node.

Returns
true if we should continue tracing, false otherwise
bool Ogre::RaySceneQuery::queryResult ( MovableObject obj,
Real  distance 
)
virtualinherited

Self-callback in order to deal with execute which returns collection.

Implements Ogre::RaySceneQueryListener.

bool Ogre::RaySceneQuery::queryResult ( SceneQuery::WorldFragment fragment,
Real  distance 
)
virtualinherited

Self-callback in order to deal with execute which returns collection.

Implements Ogre::RaySceneQueryListener.

virtual void Ogre::SceneQuery::setQueryMask ( uint32  mask)
virtualinherited

Sets the mask for results of this query.

Remarks
This method allows you to set a 'mask' to limit the results of this query to certain types of result. The actual meaning of this value is up to the application; basically MovableObject instances will only be returned from this query if a bitwise AND operation between this mask value and the MovableObject::getQueryFlags value is non-zero. The application will have to decide what each of the bits means. The default initial query mask of a SceneQuery is SceneManager::QUERY_ENTITY_DEFAULT_MASK
Note
By default, Ogre uses ::QUERY_ENTITY_DEFAULT_MASK and Co. to set each type of MovableObject's default query mask. This behavior can be overriden though, just set the masks you don't need to 0 before creating those objects.
virtual void Ogre::RaySceneQuery::setRay ( const Ray ray)
virtualinherited

Sets the ray which is to be used for this query.

virtual void Ogre::RaySceneQuery::setSortByDistance ( bool  sort,
ushort  maxresults = 0 
)
virtualinherited

Sets whether the results of this query will be sorted by distance along the ray.

Remarks
Often you want to know what was the first object a ray intersected with, and this method allows you to ask the query to sort the results so that the nearest results are listed first.
Note that because the query returns results based on bounding volumes, the ray may not actually intersect the detail of the objects returned from the query, just their bounding volumes. For this reason the caller is advised to use more detailed intersection tests on the results if a more accurate result is required; OGRE uses bounds checking in order to give the most speedy results since not all applications need extreme accuracy.
Parameters
sortIf true, results will be sorted.
maxresultsIf sorting is enabled, this value can be used to constrain the maximum number of results that are returned. Please note (as above) that the use of bounding volumes mean that accuracy is not guaranteed; if in doubt, allow more results and filter them in more detail. 0 means unlimited results.
virtual void Ogre::SceneQuery::setWorldFragmentType ( enum WorldFragmentType  wft)
virtualinherited

Tells the query what kind of world geometry to return from queries; often the full renderable geometry is not what is needed.

Remarks
The application receiving the world geometry is expected to know what to do with it; inevitably this means that the application must have knowledge of at least some of the structures used by the custom SceneManager.
The default setting is WFT_NONE.

Member Data Documentation

uint8 Ogre::SceneQuery::mFirstRq
inherited

Definition at line 123 of file OgreSceneQuery.h.

uint8 Ogre::SceneQuery::mLastRq
inherited

Definition at line 124 of file OgreSceneQuery.h.

ushort Ogre::RaySceneQuery::mMaxResults
protectedinherited

Definition at line 372 of file OgreSceneQuery.h.

set<MovableObject*>::type Ogre::BspRaySceneQuery::mObjsThisQuery
protected

Set for eliminating duplicates since objects can be in > 1 node.

Definition at line 247 of file OgreBspSceneManager.h.

SceneManager* Ogre::SceneQuery::mParentSceneMgr
protectedinherited

Definition at line 117 of file OgreSceneQuery.h.

uint32 Ogre::SceneQuery::mQueryMask
protectedinherited

Definition at line 118 of file OgreSceneQuery.h.

Ray Ogre::RaySceneQuery::mRay
protectedinherited

Definition at line 370 of file OgreSceneQuery.h.

RaySceneQueryResult Ogre::RaySceneQuery::mResult
protectedinherited

Definition at line 373 of file OgreSceneQuery.h.

vector<SceneQuery::WorldFragment*>::type Ogre::BspRaySceneQuery::mSingleIntersections
protected

list of the last single intersection world fragments (derived)

Definition at line 249 of file OgreBspSceneManager.h.

bool Ogre::RaySceneQuery::mSortByDistance
protectedinherited

Definition at line 371 of file OgreSceneQuery.h.

set<WorldFragmentType>::type Ogre::SceneQuery::mSupportedWorldFragments
protectedinherited

Definition at line 119 of file OgreSceneQuery.h.

WorldFragmentType Ogre::SceneQuery::mWorldFragmentType
protectedinherited

Definition at line 120 of file OgreSceneQuery.h.


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