OGRE
13.6
Object-Oriented Graphics Rendering Engine
|
Abstract class defining a query which returns single results from a region. More...
#include <OgreSceneQuery.h>
Public Member Functions | |
RegionSceneQuery (SceneManager *mgr) | |
Standard constructor, should be called by SceneManager. More... | |
virtual | ~RegionSceneQuery () |
virtual void | clearResults (void) |
Clears the results of the last query execution. More... | |
virtual void | execute (SceneQueryListener *listener)=0 |
Executes the query and returns each match through a listener interface. More... | |
virtual SceneQueryResult & | execute (void) |
Executes the query, returning the results back in one list. More... | |
virtual SceneQueryResult & | getLastResults (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... | |
bool | queryResult (MovableObject *first) override |
Self-callback in order to deal with execute which returns collection. More... | |
bool | queryResult (SceneQuery::WorldFragment *fragment) override |
Self-callback in order to deal with execute which returns collection. 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 const std::set< WorldFragmentType > * | 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... | |
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... | |
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 Member Functions inherited from Ogre::SceneQueryListener | |
virtual | ~SceneQueryListener () |
Additional Inherited Members | |
Public Types inherited from Ogre::SceneQuery | |
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... | |
Abstract class defining a query which returns single results from a region.
This class is simply a generalisation of the subtypes of query that return a set of individual results in a region. See the SceneQuery class for abstract information, and subclasses for the detail of each query type.
Ogre::RegionSceneQuery::RegionSceneQuery | ( | SceneManager * | mgr | ) |
Standard constructor, should be called by SceneManager.
|
virtual |
|
virtual |
Executes the query, returning the results back in one list.
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.
|
pure virtual |
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.
Implemented in Ogre::PCZPlaneBoundedVolumeListSceneQuery, Ogre::PCZSphereSceneQuery, Ogre::PCZAxisAlignedBoxSceneQuery, Ogre::OctreeAxisAlignedBoxSceneQuery, Ogre::OctreePlaneBoundedVolumeListSceneQuery, Ogre::OctreeSphereSceneQuery, Ogre::DefaultAxisAlignedBoxSceneQuery, Ogre::DefaultPlaneBoundedVolumeListSceneQuery, and Ogre::DefaultSphereSceneQuery.
|
virtual |
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 |
Clears the results of the last query execution.
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.
|
overridevirtual |
Self-callback in order to deal with execute which returns collection.
Implements Ogre::SceneQueryListener.
|
overridevirtual |
Self-callback in order to deal with execute which returns collection.
Implements Ogre::SceneQueryListener.