# Ogre::DefaultPlaneBoundedVolumeListSceneQuery Class Reference

Default implementation of PlaneBoundedVolumeListSceneQuery. More...

`#include <OgreSceneManager.h>`

Inheritance diagram for Ogre::DefaultPlaneBoundedVolumeListSceneQuery:

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 Member Functions

| DefaultPlaneBoundedVolumeListSceneQuery (SceneManager *creator)
| ~DefaultPlaneBoundedVolumeListSceneQuery ()
void | execute (SceneQueryListener *listener)
| See SceneQuery.
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 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

Default implementation of PlaneBoundedVolumeListSceneQuery.

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

## Constructor & Destructor Documentation

Ogre::DefaultPlaneBoundedVolumeListSceneQuery::DefaultPlaneBoundedVolumeListSceneQuery | ( | SceneManager * | creator | ) |

Ogre::DefaultPlaneBoundedVolumeListSceneQuery::~DefaultPlaneBoundedVolumeListSceneQuery | ( |  | ) |

## Member Function Documentation

virtual 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.

virtual 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.

void Ogre::DefaultPlaneBoundedVolumeListSceneQuery::execute | ( | SceneQueryListener * | listener | ) | `[virtual]`

| See SceneQuery. Implements Ogre::RegionSceneQuery. Reimplemented in Ogre::OctreePlaneBoundedVolumeListSceneQuery.

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 unsigned long Ogre::SceneQuery::getQueryMask | ( | void |  | ) | const`[virtual, inherited]`

| Returns the current mask for this 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 152 of file OgreSceneQuery.h.

const PlaneBoundedVolumeList& Ogre::PlaneBoundedVolumeListSceneQuery::getVolumes | ( |  | ) | const`[inherited]`

| Gets the volume which is being used for this query.

virtual WorldFragmentType Ogre::SceneQuery::getWorldFragmentType | ( | void |  | ) | const`[virtual, inherited]`

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

bool Ogre::RegionSceneQuery::queryResult | ( | SceneQuery::WorldFragment * | fragment | ) | `[virtual, inherited]`

| Self-callback in order to deal with execute which returns collection. Implements Ogre::SceneQueryListener.

bool Ogre::RegionSceneQuery::queryResult | ( | MovableObject * | first | ) | `[virtual, inherited]`

| Self-callback in order to deal with execute which returns collection. Implements Ogre::SceneQueryListener.

virtual 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.

void Ogre::PlaneBoundedVolumeListSceneQuery::setVolumes | ( | const PlaneBoundedVolumeList & | volumes | ) | `[inherited]`

| Sets the volume which is to be used 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.

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.

## Member Data Documentation

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

| Definition at line 204 of file OgreSceneQuery.h.

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

| Definition at line 113 of file OgreSceneQuery.h.

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

| Definition at line 114 of file OgreSceneQuery.h.

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

| Definition at line 115 of file OgreSceneQuery.h.

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

| Definition at line 284 of file OgreSceneQuery.h.

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

| Definition at line 116 of file OgreSceneQuery.h.

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

- OgreSceneManager.h

Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 12 13:03:13 2006