#include <OgreSceneQuery.h>
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 | |
| SphereSceneQuery (SceneManager *mgr) | |
| virtual | ~SphereSceneQuery () |
| void | setSphere (const Sphere &sphere) |
| Sets the sphere which is to be used for this query. | |
| const Sphere & | getSphere () const |
| Gets the sphere which is being used for this query. | |
| virtual SceneQueryResult & | execute (void) |
| Executes the query, returning the results back in one list. | |
| virtual void | execute (SceneQueryListener *listener)=0 |
| Executes the query and returns each match through a listener interface. | |
| 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. | |
| virtual void | clearResults (void) |
| Clears the results of the last query execution. | |
| bool | queryResult (MovableObject *first) |
| Self-callback in order to deal with execute which returns collection. | |
| bool | queryResult (SceneQuery::WorldFragment *fragment) |
| 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 uint32 | getQueryMask (void) const |
| Returns the current mask for this query. | |
| virtual void | setQueryTypeMask (uint32 mask) |
| Sets the type mask for results of this query. | |
| virtual uint32 | getQueryTypeMask (void) const |
| Returns the current mask for this query. | |
| 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. | |
| virtual WorldFragmentType | getWorldFragmentType (void) const |
| Gets the current world fragment types to be returned from the query. | |
| virtual const std::set < WorldFragmentType > * | getSupportedWorldFragmentTypes (void) const |
| Returns the types of world fragments this query supports. | |
Protected Attributes | |
| Sphere | mSphere |
| SceneQueryResult * | mLastResult |
| SceneManager * | mParentSceneMgr |
| uint32 | mQueryMask |
| uint32 | mQueryTypeMask |
| std::set < WorldFragmentType > | mSupportedWorldFragments |
| WorldFragmentType | mWorldFragmentType |
Definition at line 281 of file OgreSceneQuery.h.
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.
| 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.
| Ogre::SphereSceneQuery::SphereSceneQuery | ( | SceneManager * | mgr | ) |
| virtual Ogre::SphereSceneQuery::~SphereSceneQuery | ( | ) | [virtual] |
| void Ogre::SphereSceneQuery::setSphere | ( | const Sphere & | sphere | ) |
Sets the sphere which is to be used for this query.
| const Sphere& Ogre::SphereSceneQuery::getSphere | ( | ) | const |
Gets the sphere which is being used for this query.
| virtual SceneQueryResult& Ogre::RegionSceneQuery::execute | ( | void | ) | [virtual, inherited] |
Executes the query, returning the results back in one list.
| virtual void Ogre::RegionSceneQuery::execute | ( | SceneQueryListener * | listener | ) | [pure virtual, inherited] |
Executes the query and returns each match through a listener interface.
Implemented in Ogre::DefaultSphereSceneQuery, Ogre::DefaultPlaneBoundedVolumeListSceneQuery, and Ogre::DefaultAxisAlignedBoxSceneQuery.
| virtual SceneQueryResult& Ogre::RegionSceneQuery::getLastResults | ( | void | ) | const [virtual, inherited] |
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 void Ogre::RegionSceneQuery::clearResults | ( | void | ) | [virtual, inherited] |
Clears the results of the last query execution.
| bool Ogre::RegionSceneQuery::queryResult | ( | MovableObject * | first | ) | [virtual, inherited] |
Self-callback in order to deal with execute which returns collection.
Implements Ogre::SceneQueryListener.
| bool Ogre::RegionSceneQuery::queryResult | ( | SceneQuery::WorldFragment * | fragment | ) | [virtual, inherited] |
Self-callback in order to deal with execute which returns collection.
Implements Ogre::SceneQueryListener.
| virtual void Ogre::SceneQuery::setQueryMask | ( | uint32 | mask | ) | [virtual, inherited] |
Sets the mask for results of this query.
| virtual uint32 Ogre::SceneQuery::getQueryMask | ( | void | ) | const [virtual, inherited] |
Returns the current mask for this query.
| virtual void Ogre::SceneQuery::setQueryTypeMask | ( | uint32 | mask | ) | [virtual, inherited] |
Sets the type mask for results of this query.
| virtual uint32 Ogre::SceneQuery::getQueryTypeMask | ( | void | ) | const [virtual, inherited] |
Returns the current mask for this query.
| virtual void Ogre::SceneQuery::setWorldFragmentType | ( | enum WorldFragmentType | wft | ) | [virtual, inherited] |
Tells the query what kind of world geometry to return from queries; often the full renderable geometry is not what is needed.
| virtual WorldFragmentType Ogre::SceneQuery::getWorldFragmentType | ( | void | ) | const [virtual, inherited] |
Gets the current world fragment types to be returned from the query.
| virtual const std::set<WorldFragmentType>* Ogre::SceneQuery::getSupportedWorldFragmentTypes | ( | void | ) | const [virtual, inherited] |
Returns the types of world fragments this query supports.
Definition at line 169 of file OgreSceneQuery.h.
Sphere Ogre::SphereSceneQuery::mSphere [protected] |
Definition at line 284 of file OgreSceneQuery.h.
SceneQueryResult* Ogre::RegionSceneQuery::mLastResult [protected, inherited] |
Definition at line 221 of file OgreSceneQuery.h.
SceneManager* Ogre::SceneQuery::mParentSceneMgr [protected, inherited] |
Definition at line 117 of file OgreSceneQuery.h.
uint32 Ogre::SceneQuery::mQueryMask [protected, inherited] |
Definition at line 118 of file OgreSceneQuery.h.
uint32 Ogre::SceneQuery::mQueryTypeMask [protected, inherited] |
Definition at line 119 of file OgreSceneQuery.h.
std::set<WorldFragmentType> Ogre::SceneQuery::mSupportedWorldFragments [protected, inherited] |
Definition at line 120 of file OgreSceneQuery.h.
WorldFragmentType Ogre::SceneQuery::mWorldFragmentType [protected, inherited] |
Definition at line 121 of file OgreSceneQuery.h.
Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Mon Jun 16 12:53:28 2008