Public Types | Public Member Functions | Protected Attributes | List of all members
Ogre::DefaultIntersectionSceneQuery Class Reference

Default implementation of IntersectionSceneQuery. More...

#include <OgreSceneManager.h>

Inheritance diagram for Ogre::DefaultIntersectionSceneQuery:
Inheritance graph
[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

 DefaultIntersectionSceneQuery (SceneManager *creator)
 
 ~DefaultIntersectionSceneQuery ()
 
virtual void clearResults (void)
 Clears the results of the last query execution. More...
 
virtual IntersectionSceneQueryResultexecute (void)
 Executes the query, returning the results back in one list. More...
 
void execute (IntersectionSceneQueryListener *listener)
 See IntersectionSceneQuery. More...
 
virtual IntersectionSceneQueryResultgetLastResults (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 set< WorldFragmentType >::type * getSupportedWorldFragmentTypes (void) const
 Returns the types of world fragments this query supports. More...
 
virtual WorldFragmentType getWorldFragmentType (void) const
 Gets the current world fragment types to be returned from the query. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
bool queryResult (MovableObject *first, MovableObject *second)
 Self-callback in order to deal with execute which returns collection. More...
 
bool queryResult (MovableObject *movable, 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...
 
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...
 

Protected Attributes

IntersectionSceneQueryResultmLastResult
 
SceneManagermParentSceneMgr
 
uint32 mQueryMask
 
uint32 mQueryTypeMask
 
set< WorldFragmentType >::type mSupportedWorldFragments
 
WorldFragmentType mWorldFragmentType
 

Detailed Description

Default implementation of IntersectionSceneQuery.

Definition at line 3553 of file OgreSceneManager.h.

Constructor & Destructor Documentation

Ogre::DefaultIntersectionSceneQuery::DefaultIntersectionSceneQuery ( SceneManager creator)
Ogre::DefaultIntersectionSceneQuery::~DefaultIntersectionSceneQuery ( )

Member Function Documentation

virtual void Ogre::IntersectionSceneQuery::clearResults ( void  )
virtualinherited

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 IntersectionSceneQueryResult& Ogre::IntersectionSceneQuery::execute ( void  )
virtualinherited

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::DefaultIntersectionSceneQuery::execute ( IntersectionSceneQueryListener listener)
virtual
virtual IntersectionSceneQueryResult& Ogre::IntersectionSceneQuery::getLastResults ( void  ) const
virtualinherited

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 uint32 Ogre::SceneQuery::getQueryMask ( void  ) const
virtualinherited

Returns the current mask for this query.

virtual uint32 Ogre::SceneQuery::getQueryTypeMask ( void  ) const
virtualinherited

Returns the current mask for this query.

virtual const set<WorldFragmentType>::type* Ogre::SceneQuery::getSupportedWorldFragmentTypes ( void  ) const
virtualinherited

Returns the types of world fragments this query supports.

Definition at line 175 of file OgreSceneQuery.h.

virtual WorldFragmentType Ogre::SceneQuery::getWorldFragmentType ( void  ) const
virtualinherited

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

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

bool Ogre::IntersectionSceneQuery::queryResult ( MovableObject first,
MovableObject second 
)
virtualinherited

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

Implements Ogre::IntersectionSceneQueryListener.

bool Ogre::IntersectionSceneQuery::queryResult ( MovableObject movable,
SceneQuery::WorldFragment fragment 
)
virtualinherited

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

Implements Ogre::IntersectionSceneQueryListener.

virtual void Ogre::SceneQuery::setQueryMask ( uint32  mask)
virtualinherited

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.
virtual void Ogre::SceneQuery::setQueryTypeMask ( uint32  mask)
virtualinherited

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.
virtual void Ogre::SceneQuery::setWorldFragmentType ( enum WorldFragmentType  wft)
virtualinherited

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

IntersectionSceneQueryResult* Ogre::IntersectionSceneQuery::mLastResult
protectedinherited

Definition at line 516 of file OgreSceneQuery.h.

SceneManager* Ogre::SceneQuery::mParentSceneMgr
protectedinherited

Definition at line 123 of file OgreSceneQuery.h.

uint32 Ogre::SceneQuery::mQueryMask
protectedinherited

Definition at line 124 of file OgreSceneQuery.h.

uint32 Ogre::SceneQuery::mQueryTypeMask
protectedinherited

Definition at line 125 of file OgreSceneQuery.h.

set<WorldFragmentType>::type Ogre::SceneQuery::mSupportedWorldFragments
protectedinherited

Definition at line 126 of file OgreSceneQuery.h.

WorldFragmentType Ogre::SceneQuery::mWorldFragmentType
protectedinherited

Definition at line 127 of file OgreSceneQuery.h.


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

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.