| OGRE 1.11.1 Object-Oriented Graphics Rendering Engine

Public Types | Public Member Functions | List of all members
Ogre::OctreePlaneBoundedVolumeListSceneQuery Class Reference
Plugins » OctreeSceneManager

Octree implementation of PlaneBoundedVolumeListSceneQuery. More...

`#include <OgreOctreeSceneQuery.h>`

Inheritance diagram for Ogre::OctreePlaneBoundedVolumeListSceneQuery:
[legend]

## 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
| OctreePlaneBoundedVolumeListSceneQuery (SceneManager *creator)
| ~OctreePlaneBoundedVolumeListSceneQuery ()
virtual void | clearResults (void)
| Clears the results of the last query execution. More...
void | execute (SceneQueryListener *listener)
| See SceneQuery. 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...
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...
const PlaneBoundedVolumeList & | getVolumes () const
| Gets the volume which is being used for this query. More...
virtual WorldFragmentType | getWorldFragmentType (void) const
| Gets the current world fragment types to be returned from the query. More...
bool | queryResult (MovableObject *first)
| Self-callback in order to deal with execute which returns collection. More...
bool | queryResult (SceneQuery::WorldFragment *fragment)
| Self-callback in order to deal with execute which returns collection. 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...
void | setVolumes (const PlaneBoundedVolumeList &volumes)
| Sets the volume which is to be used for 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...

## Detailed Description

Octree implementation of PlaneBoundedVolumeListSceneQuery.

## Member Enumeration Documentation

## ◆ WorldFragmentType

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.

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

## Constructor & Destructor Documentation

## ◆ OctreePlaneBoundedVolumeListSceneQuery()

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

## ◆ ~OctreePlaneBoundedVolumeListSceneQuery()

Ogre::OctreePlaneBoundedVolumeListSceneQuery::~OctreePlaneBoundedVolumeListSceneQuery | ( |  | ) |

## Member Function Documentation

## ◆ execute() [1/2]

void Ogre::OctreePlaneBoundedVolumeListSceneQuery::execute | ( | SceneQueryListener * | listener | ) |
| virtual

See SceneQuery.

Reimplemented from Ogre::DefaultPlaneBoundedVolumeListSceneQuery.

## ◆ execute() [2/2]

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.

## ◆ setVolumes()

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

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

## ◆ getVolumes()

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

Gets the volume which is being used for this query.

## ◆ getLastResults()

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.

## ◆ clearResults()

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.

## ◆ queryResult() [1/2]

bool Ogre::RegionSceneQuery::queryResult | ( | MovableObject * | first | ) |
| virtual inherited

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

Implements Ogre::SceneQueryListener.

## ◆ queryResult() [2/2]

bool Ogre::RegionSceneQuery::queryResult | ( | SceneQuery::WorldFragment * | fragment | ) |
| virtual inherited

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

Implements Ogre::SceneQueryListener.

## ◆ setQueryMask()

virtual void Ogre::SceneQuery::setQueryMask | ( | uint32 | 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.

## ◆ getQueryMask()

virtual uint32 Ogre::SceneQuery::getQueryMask | ( | void |  | ) | const
| virtual inherited

Returns the current mask for this query.

## ◆ setQueryTypeMask()

virtual void Ogre::SceneQuery::setQueryTypeMask | ( | uint32 | mask | ) |
| virtual inherited

Sets the type mask for results of this query.

Remarks
  This method allows you to set a 'type mask' to limit the results of this query to certain types of objects. Whilst setQueryMask deals with flags set per instance of object, this method deals with setting a mask on flags set per type of object. Both may exclude an object from query results.

## ◆ getQueryTypeMask()

virtual uint32 Ogre::SceneQuery::getQueryTypeMask | ( | void |  | ) | const
| virtual inherited

Returns the current mask for this query.

## ◆ setWorldFragmentType()

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.

## ◆ getWorldFragmentType()

virtual WorldFragmentType Ogre::SceneQuery::getWorldFragmentType | ( | void |  | ) | const
| virtual inherited

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

## ◆ getSupportedWorldFragmentTypes()

virtual const std::set<WorldFragmentType>* Ogre::SceneQuery::getSupportedWorldFragmentTypes | ( | void |  | ) | const
| inline virtual inherited

Returns the types of world fragments this query supports.

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

- OgreOctreeSceneQuery.h