OGRE  master
Object-Oriented Graphics Rendering Engine
Ogre::DefaultRaySceneQuery Class Reference

Default implementation of RaySceneQuery. More...

#include <OgreSceneManager.h>

+ Inheritance diagram for Ogre::DefaultRaySceneQuery:

Public Member Functions

 DefaultRaySceneQuery (SceneManager *creator)
 
 ~DefaultRaySceneQuery ()
 
void execute (RaySceneQueryListener *listener) override
 Executes the query and returns each match through a listener interface. More...
 
- Public Member Functions inherited from Ogre::RaySceneQuery
 RaySceneQuery (SceneManager *mgr)
 
virtual ~RaySceneQuery ()
 
void clearResults (void)
 Clears the results of the last query execution. More...
 
virtual RaySceneQueryResultexecute (void)
 Executes the query, returning the results back in one list. More...
 
const RaySceneQueryResultgetLastResults (void) const
 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 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...
 
bool queryResult (MovableObject *obj, Real distance) override
 Self-callback in order to deal with execute which returns collection. More...
 
bool queryResult (SceneQuery::WorldFragment *fragment, Real distance) override
 Self-callback in order to deal with execute which returns collection. 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...
 
- Public Member Functions inherited from Ogre::SceneQuery
 SceneQuery (SceneManager *mgr)
 Standard constructor, should be called by SceneManager. More...
 
virtual ~SceneQuery ()
 
virtual uint32 getQueryMask (void) const
 Returns the current mask for this query. More...
 
virtual uint32 getQueryTypeMask (void) const
 Returns the current mask for this query. More...
 
virtual void setQueryMask (uint32 mask)
 Sets the mask for results of this query. More...
 
virtual void setQueryTypeMask (uint32 mask)
 Sets the type mask for results of this query. More...
 
- Public Member Functions inherited from Ogre::RaySceneQueryListener
virtual ~RaySceneQueryListener ()
 

Additional Inherited Members

- Public Types inherited from Ogre::SceneQuery
typedef Ogre::WorldFragment WorldFragment
 

Detailed Description

Default implementation of RaySceneQuery.

Constructor & Destructor Documentation

◆ DefaultRaySceneQuery()

Ogre::DefaultRaySceneQuery::DefaultRaySceneQuery ( SceneManager creator)

◆ ~DefaultRaySceneQuery()

Ogre::DefaultRaySceneQuery::~DefaultRaySceneQuery ( )

Member Function Documentation

◆ execute()

void Ogre::DefaultRaySceneQuery::execute ( RaySceneQueryListener listener)
overridevirtual

Executes the query and returns each match through a listener interface.

Note that this method does not store the results of the query internally so does not update the 'last result' value. This means that this version of execute is more lightweight and therefore more efficient than the version which returns the results as a collection.

Implements Ogre::RaySceneQuery.

Reimplemented in Ogre::BspRaySceneQuery, Ogre::PCZRaySceneQuery, and Ogre::OctreeRaySceneQuery.


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