Ogre::OctreeRaySceneQuery Class Reference

Octree implementation of RaySceneQuery. More...

#include <OgreOctreeSceneQuery.h>

Inheritance diagram for Ogre::OctreeRaySceneQuery:

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
	OctreeRaySceneQuery (SceneManager *creator)
	~OctreeRaySceneQuery ()
virtual void	clearResults (void)
	Clears the results of the last query execution.
bool	execute (ObjectData objData, size_t numNodes, RaySceneQueryListener *listener)
void	execute (RaySceneQueryListener *listener)
	See RayScenQuery.
virtual RaySceneQueryResult &	execute (void)
	Executes the query, returning the results back in one list.
virtual RaySceneQueryResult &	getLastResults (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.
virtual ushort	getMaxResults (void) const
	Gets the maximum number of results returned from the query (only relevant if results are being sorted)
virtual uint32	getQueryMask (void) const
	Returns the current mask for this query.
virtual const Ray &	getRay (void) const
	Gets the ray which is to be used for this query.
virtual bool	getSortByDistance (void) const
	Gets whether the results are sorted by distance.
virtual const set< WorldFragmentType >::type *	getSupportedWorldFragmentTypes (void) const
	Returns the types of world fragments this query supports.
virtual WorldFragmentType	getWorldFragmentType (void) const
	Gets the current world fragment types to be returned from the query.
void	operator delete (void *ptr)
void	operator delete (void *ptr, const char *, int, const char *)
void	operator delete (void *ptr, void *)
void	operator delete[] (void *ptr)
void	operator delete[] (void *ptr, const char *, int, const char *)
void *	operator new (size_t sz)
void *	operator new (size_t sz, const char *file, int line, const char *func)
	operator new, with debug line info
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz)
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info
bool	queryResult (MovableObject *obj, Real distance)
	Self-callback in order to deal with execute which returns collection.
bool	queryResult (SceneQuery::WorldFragment *fragment, Real distance)
	Self-callback in order to deal with execute which returns collection.
virtual void	setQueryMask (uint32 mask)
	Sets the mask for results of this query.
virtual void	setRay (const Ray &ray)
	Sets the ray which is to be used for this query.
virtual void	setSortByDistance (bool sort, ushort maxresults=0)
	Sets whether the results of this query will be sorted by distance along the ray.
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.

Public Attributes
uint8	mFirstRq
uint8	mLastRq

Detailed Description

Octree implementation of RaySceneQuery.

Member Enumeration Documentation

WorldFragmentType

enum Ogre::SceneQuery::WorldFragmentType

inherited

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.

Constructor & Destructor Documentation

OctreeRaySceneQuery()

Ogre::OctreeRaySceneQuery::OctreeRaySceneQuery

(

SceneManager *

creator

)

~OctreeRaySceneQuery()

Ogre::OctreeRaySceneQuery::~OctreeRaySceneQuery

(

)

Member Function Documentation

clearResults()

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.

execute() [1/3]

bool Ogre::DefaultRaySceneQuery::execute ( ObjectData  objData, size_t  numNodes, RaySceneQueryListener *  listener  )

inherited

execute() [2/3]

void Ogre::OctreeRaySceneQuery::execute ( RaySceneQueryListener *  listener )

virtual

See RayScenQuery.

Reimplemented from Ogre::DefaultRaySceneQuery.

execute() [3/3]

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.

getLastResults()

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.

getMaxResults()

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)

getQueryMask()

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

virtualinherited

Returns the current mask for this query.

getRay()

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

virtualinherited

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

getSortByDistance()

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

virtualinherited

Gets whether the results are sorted by distance.

getSupportedWorldFragmentTypes()

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

inlinevirtualinherited

Returns the types of world fragments this query supports.

getWorldFragmentType()

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

virtualinherited

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

operator delete() [1/3]

template<class Alloc >

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

inlineinherited

operator delete() [2/3]

template<class Alloc >

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

inlineinherited

operator delete() [3/3]

template<class Alloc >

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

inlineinherited

operator delete[]() [1/2]

template<class Alloc >

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

inlineinherited

operator delete[]() [2/2]

template<class Alloc >

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

inlineinherited

operator new() [1/3]

template<class Alloc >

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

inlineinherited

operator new() [2/3]

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

operator new() [3/3]

template<class Alloc >

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

inlineinherited

placement operator new

operator new[]() [1/2]

template<class Alloc >

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

inlineinherited

operator new[]() [2/2]

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

queryResult() [1/2]

bool Ogre::RaySceneQuery::queryResult ( MovableObject *  obj, Real  distance  )

virtualinherited

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

Implements Ogre::RaySceneQueryListener.

queryResult() [2/2]

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

virtualinherited

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

Implements Ogre::RaySceneQueryListener.

setQueryMask()

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 @SceneManager::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.

setRay()

virtual void Ogre::RaySceneQuery::setRay ( const Ray &  ray )

virtualinherited

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

setSortByDistance()

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

sort	If true, results will be sorted.
maxresults	If 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.

setWorldFragmentType()

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

mFirstRq

uint8 Ogre::SceneQuery::mFirstRq

inherited

mLastRq

uint8 Ogre::SceneQuery::mLastRq

inherited

---

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

• OgreOctreeSceneQuery.h