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

# Ogre::PlaneBoundedVolumeListSceneQuery Class Reference

Specialises the SceneQuery class for querying within a plane-bounded volume. More...

`#include <OgreSceneQuery.h>`

Inheritance diagram for Ogre::PlaneBoundedVolumeListSceneQuery:

[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

| PlaneBoundedVolumeListSceneQuery (SceneManager *mgr)
virtual | ~PlaneBoundedVolumeListSceneQuery ()
void | setVolumes (const PlaneBoundedVolumeList &volumes)
| Sets the volume which is to be used for this query.
const PlaneBoundedVolumeList & | getVolumes () const
| Gets the volume 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 (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

PlaneBoundedVolumeList | mVolumes
SceneQueryResult * | mLastResult
SceneManager * | mParentSceneMgr
unsigned long | mQueryMask
std::set< WorldFragmentType > | mSupportedWorldFragments
WorldFragmentType | mWorldFragmentType

## Detailed Description

Specialises the SceneQuery class for querying within a plane-bounded volume.

Definition at line 280 of file OgreSceneQuery.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 73 of file OgreSceneQuery.h.

## Constructor & Destructor Documentation

Ogre::PlaneBoundedVolumeListSceneQuery::PlaneBoundedVolumeListSceneQuery | ( | SceneManager * | mgr | ) |

| Definition at line 159 of file OgreSceneQuery.cpp.

Ogre::PlaneBoundedVolumeListSceneQuery::~PlaneBoundedVolumeListSceneQuery | ( |  | ) | `[virtual]`

| Definition at line 164 of file OgreSceneQuery.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().

virtual void Ogre::RegionSceneQuery::execute | ( | SceneQueryListener * | listener | ) | `[pure virtual, inherited]`

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

Remarks:
  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::DefaultSphereSceneQuery, Ogre::DefaultPlaneBoundedVolumeListSceneQuery, Ogre::DefaultAxisAlignedBoxSceneQuery, Ogre::OctreeSphereSceneQuery, Ogre::OctreePlaneBoundedVolumeListSceneQuery, and Ogre::OctreeAxisAlignedBoxSceneQuery.

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.

Referenced by Ogre::SceneManager::findShadowCastersForLight().

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.

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

| Returns the types of world fragments this query supports. Definition at line 152 of file OgreSceneQuery.h.

const PlaneBoundedVolumeList & Ogre::PlaneBoundedVolumeListSceneQuery::getVolumes | ( |  | ) | const

| Gets the volume which is being used for this query. Definition at line 173 of file OgreSceneQuery.cpp. References mVolumes, and Ogre::PlaneBoundedVolumeList.

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.

Referenced by Ogre::OctreePlaneBoundedVolumeListSceneQuery::execute(), Ogre::OctreeSphereSceneQuery::execute(), and Ogre::OctreeAxisAlignedBoxSceneQuery::execute().

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::OctreeSceneManager::createIntersectionQuery(), Ogre::BspSceneManager::createIntersectionQuery(), Ogre::SceneManager::createPlaneBoundedVolumeQuery(), Ogre::OctreeSceneManager::createPlaneBoundedVolumeQuery(), Ogre::TerrainSceneManager::createRayQuery(), Ogre::SceneManager::createRayQuery(), Ogre::OctreeSceneManager::createRayQuery(), and Ogre::SceneManager::createSphereQuery().

void Ogre::PlaneBoundedVolumeListSceneQuery::setVolumes | ( | const PlaneBoundedVolumeList & | volumes | ) |

| Sets the volume which is to be used for this query. Definition at line 168 of file OgreSceneQuery.cpp. References mVolumes, and Ogre::PlaneBoundedVolumeList. Referenced by Ogre::SceneManager::createPlaneBoundedVolumeQuery(), and Ogre::OctreeSceneManager::createPlaneBoundedVolumeQuery().

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 203 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 113 of file OgreSceneQuery.h. Referenced by Ogre::DefaultPlaneBoundedVolumeListSceneQuery::execute(), Ogre::DefaultSphereSceneQuery::execute(), Ogre::DefaultRaySceneQuery::execute(), Ogre::DefaultAxisAlignedBoxSceneQuery::execute(), Ogre::DefaultIntersectionSceneQuery::execute(), Ogre::OctreeIntersectionSceneQuery::execute(), and Ogre::BspIntersectionSceneQuery::execute().

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

Definition at line 114 of file OgreSceneQuery.h.

Referenced by Ogre::DefaultPlaneBoundedVolumeListSceneQuery::execute(), Ogre::DefaultSphereSceneQuery::execute(), Ogre::DefaultRaySceneQuery::execute(), Ogre::DefaultAxisAlignedBoxSceneQuery::execute(), Ogre::DefaultIntersectionSceneQuery::execute(), Ogre::OctreePlaneBoundedVolumeListSceneQuery::execute(), Ogre::OctreeSphereSceneQuery::execute(), Ogre::OctreeRaySceneQuery::execute(), Ogre::OctreeAxisAlignedBoxSceneQuery::execute(), Ogre::OctreeIntersectionSceneQuery::execute(), Ogre::BspIntersectionSceneQuery::execute(), Ogre::SceneQuery::getQueryMask(), and Ogre::SceneQuery::setQueryMask().

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

Definition at line 115 of file OgreSceneQuery.h.

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

PlaneBoundedVolumeList Ogre::PlaneBoundedVolumeListSceneQuery::mVolumes`[protected]`

| Definition at line 283 of file OgreSceneQuery.h. Referenced by Ogre::DefaultPlaneBoundedVolumeListSceneQuery::execute(), Ogre::OctreePlaneBoundedVolumeListSceneQuery::execute(), getVolumes(), and setVolumes().

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

| Definition at line 116 of file OgreSceneQuery.h. Referenced by Ogre::SceneQuery::getWorldFragmentType(), and Ogre::SceneQuery::setWorldFragmentType().

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

- OgreSceneQuery.h
- OgreSceneQuery.cpp

Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:50:40 2004