Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::DefaultSphereSceneQuery Class Reference

Default implementation of SphereSceneQuery. More...

#include <OgreSceneManager.h>

Inheritance diagram for Ogre::DefaultSphereSceneQuery:

Inheritance graph
[legend]
Collaboration diagram for Ogre::DefaultSphereSceneQuery:

Collaboration graph
[legend]
List of all members.

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 Methods

 DefaultSphereSceneQuery (SceneManager *creator)
 ~DefaultSphereSceneQuery ()
void execute (SceneQueryListener *listener)
 See SceneQuery.

void setSphere (const Sphere &sphere)
 Sets the sphere which is to be used for this query.

const SpheregetSphere () const
 Gets the sphere which is being used for this query.

virtual SceneQueryResultexecute (void)
 Executes the query, returning the results back in one list.

virtual SceneQueryResultgetLastResults (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 (unsigned long mask)
 Sets the mask for results of this query.

virtual unsigned long getQueryMask (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
SceneQueryResultmLastResult
SceneManagermParentSceneMgr
unsigned long mQueryMask
std::set< WorldFragmentTypemSupportedWorldFragments
WorldFragmentType mWorldFragmentType

Detailed Description

Default implementation of SphereSceneQuery.

Definition at line 1187 of file OgreSceneManager.h.


Member Enumeration Documentation

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.

Enumeration values:
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 72 of file OgreSceneQuery.h.


Constructor & Destructor Documentation

Ogre::DefaultSphereSceneQuery::DefaultSphereSceneQuery SceneManager   creator
 

Definition at line 2023 of file OgreSceneManager.cpp.

References Ogre::SceneQuery::mSupportedWorldFragments.

Ogre::DefaultSphereSceneQuery::~DefaultSphereSceneQuery  
 

Definition at line 2029 of file OgreSceneManager.cpp.


Member Function Documentation

void Ogre::RegionSceneQuery::clearResults void    [virtual, inherited]
 

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.

Definition at line 84 of file OgreSceneQuery.cpp.

References Ogre::RegionSceneQuery::mLastResult.

Referenced by Ogre::RegionSceneQuery::execute(), and Ogre::RegionSceneQuery::~RegionSceneQuery().

SceneQueryResult & Ogre::RegionSceneQuery::execute void    [virtual, inherited]
 

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.

Definition at line 94 of file OgreSceneQuery.cpp.

References Ogre::RegionSceneQuery::clearResults(), and Ogre::RegionSceneQuery::mLastResult.

void Ogre::DefaultSphereSceneQuery::execute SceneQueryListener   listener [virtual]
 

See SceneQuery.

Implements Ogre::RegionSceneQuery.

Definition at line 2033 of file OgreSceneManager.cpp.

References Ogre::Sphere::intersects(), Ogre::SceneManager::mEntities, Ogre::SceneQuery::mParentSceneMgr, Ogre::SphereSceneQuery::mSphere, Ogre::SceneQueryListener::queryResult(), Ogre::Sphere::setCenter(), and Ogre::Sphere::setRadius().

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.

Definition at line 78 of file OgreSceneQuery.cpp.

References Ogre::RegionSceneQuery::mLastResult.

unsigned long Ogre::SceneQuery::getQueryMask void    const [virtual, inherited]
 

Returns the current mask for this query.

Definition at line 46 of file OgreSceneQuery.cpp.

References Ogre::SceneQuery::mQueryMask.

const Sphere & Ogre::SphereSceneQuery::getSphere   const [inherited]
 

Gets the sphere which is being used for this query.

Definition at line 153 of file OgreSceneQuery.cpp.

References Ogre::SphereSceneQuery::mSphere.

virtual const std::set<WorldFragmentType>* Ogre::SceneQuery::getSupportedWorldFragmentTypes void    const [virtual, inherited]
 

Returns the types of world fragments this query supports.

Definition at line 151 of file OgreSceneQuery.h.

SceneQuery::WorldFragmentType Ogre::SceneQuery::getWorldFragmentType void    const [virtual, inherited]
 

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

Definition at line 63 of file OgreSceneQuery.cpp.

References Ogre::SceneQuery::mWorldFragmentType.

bool Ogre::RegionSceneQuery::queryResult SceneQuery::WorldFragment   fragment [virtual, inherited]
 

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

Implements Ogre::SceneQueryListener.

Definition at line 112 of file OgreSceneQuery.cpp.

References Ogre::RegionSceneQuery::mLastResult, and Ogre::SceneQueryResult::worldFragments.

bool Ogre::RegionSceneQuery::queryResult MovableObject   first [virtual, inherited]
 

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

Implements Ogre::SceneQueryListener.

Definition at line 104 of file OgreSceneQuery.cpp.

References Ogre::RegionSceneQuery::mLastResult, and Ogre::SceneQueryResult::movables.

void Ogre::SceneQuery::setQueryMask unsigned long    mask [virtual, inherited]
 

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.

Definition at line 41 of file OgreSceneQuery.cpp.

References Ogre::SceneQuery::mQueryMask.

Referenced by Ogre::SceneManager::createAABBQuery(), Ogre::SceneManager::createIntersectionQuery(), Ogre::BspSceneManager::createIntersectionQuery(), Ogre::SceneManager::createRayQuery(), and Ogre::SceneManager::createSphereQuery().

void Ogre::SphereSceneQuery::setSphere const Sphere   sphere [inherited]
 

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

Definition at line 148 of file OgreSceneQuery.cpp.

References Ogre::SphereSceneQuery::mSphere.

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.

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.

Definition at line 51 of file OgreSceneQuery.cpp.

References Except, Ogre::SceneQuery::mSupportedWorldFragments, and Ogre::SceneQuery::mWorldFragmentType.


Member Data Documentation

SceneQueryResult* Ogre::RegionSceneQuery::mLastResult [protected, inherited]
 

Definition at line 202 of file OgreSceneQuery.h.

Referenced by Ogre::RegionSceneQuery::clearResults(), Ogre::RegionSceneQuery::execute(), Ogre::RegionSceneQuery::getLastResults(), and Ogre::RegionSceneQuery::queryResult().

SceneManager* Ogre::SceneQuery::mParentSceneMgr [protected, inherited]
 

Definition at line 112 of file OgreSceneQuery.h.

Referenced by execute(), Ogre::DefaultRaySceneQuery::execute(), Ogre::DefaultAxisAlignedBoxSceneQuery::execute(), Ogre::DefaultIntersectionSceneQuery::execute(), and Ogre::BspIntersectionSceneQuery::execute().

unsigned long Ogre::SceneQuery::mQueryMask [protected, inherited]
 

Definition at line 113 of file OgreSceneQuery.h.

Referenced by Ogre::DefaultIntersectionSceneQuery::execute(), Ogre::BspIntersectionSceneQuery::execute(), Ogre::SceneQuery::getQueryMask(), and Ogre::SceneQuery::setQueryMask().

Sphere Ogre::SphereSceneQuery::mSphere [protected, inherited]
 

Definition at line 265 of file OgreSceneQuery.h.

Referenced by execute(), Ogre::SphereSceneQuery::getSphere(), and Ogre::SphereSceneQuery::setSphere().

std::set<WorldFragmentType> Ogre::SceneQuery::mSupportedWorldFragments [protected, inherited]
 

Definition at line 114 of file OgreSceneQuery.h.

Referenced by Ogre::BspIntersectionSceneQuery::BspIntersectionSceneQuery(), Ogre::DefaultAxisAlignedBoxSceneQuery::DefaultAxisAlignedBoxSceneQuery(), Ogre::DefaultIntersectionSceneQuery::DefaultIntersectionSceneQuery(), Ogre::DefaultRaySceneQuery::DefaultRaySceneQuery(), DefaultSphereSceneQuery(), and Ogre::SceneQuery::setWorldFragmentType().

WorldFragmentType Ogre::SceneQuery::mWorldFragmentType [protected, inherited]
 

Definition at line 115 of file OgreSceneQuery.h.

Referenced by Ogre::SceneQuery::getWorldFragmentType(), and Ogre::SceneQuery::setWorldFragmentType().


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

Copyright © 2002-2003 by The OGRE Team
Last modified Wed Jan 21 00:16:10 2004