OGRE  1.8
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::PCZSphereSceneQuery Class Reference

PCZ implementation of SphereSceneQuery. More...

#include <OgrePCZSceneQuery.h>

+ Inheritance diagram for Ogre::PCZSphereSceneQuery:
+ Collaboration diagram for Ogre::PCZSphereSceneQuery:

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

 PCZSphereSceneQuery (SceneManager *creator)
 
 ~PCZSphereSceneQuery ()
 
virtual void clearResults (void)
 Clears the results of the last query execution. More...
 
void execute (SceneQueryListener *listener)
 See SceneQuery. More...
 
virtual SceneQueryResultexecute (void)
 Executes the query, returning the results back in one list. More...
 
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. 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...
 
const SpheregetSphere () const
 Gets the sphere which is being used 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)
 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...
 
void setExcludeNode (SceneNode *excludeNode)
 set node to exclude from query 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 setSphere (const Sphere &sphere)
 Sets the sphere which is to be used for this query. More...
 
void setStartZone (PCZone *startZone)
 set the zone to start the scene 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

SceneNodemExcludeNode
 
SceneQueryResultmLastResult
 
SceneManagermParentSceneMgr
 
uint32 mQueryMask
 
uint32 mQueryTypeMask
 
Sphere mSphere
 
PCZonemStartZone
 
set< WorldFragmentType >::type mSupportedWorldFragments
 
WorldFragmentType mWorldFragmentType
 

Detailed Description

PCZ implementation of SphereSceneQuery.

Definition at line 93 of file OgrePCZSceneQuery.h.

Member Enumeration Documentation

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.

Definition at line 83 of file OgreSceneQuery.h.

Constructor & Destructor Documentation

Ogre::PCZSphereSceneQuery::PCZSphereSceneQuery ( SceneManager creator)
Ogre::PCZSphereSceneQuery::~PCZSphereSceneQuery ( )

Member Function Documentation

virtual void Ogre::RegionSceneQuery::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.
void Ogre::PCZSphereSceneQuery::execute ( SceneQueryListener listener)
virtual

See SceneQuery.

Reimplemented from Ogre::DefaultSphereSceneQuery.

virtual SceneQueryResult& Ogre::RegionSceneQuery::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.
virtual SceneQueryResult& Ogre::RegionSceneQuery::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.

const Sphere& Ogre::SphereSceneQuery::getSphere ( ) const
inherited

Gets the sphere which is being used for this query.

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

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)
inlineinherited

Definition at line 95 of file OgreMemoryAllocatedObject.h.

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

Definition at line 101 of file OgreMemoryAllocatedObject.h.

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

Definition at line 107 of file OgreMemoryAllocatedObject.h.

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

Definition at line 112 of file OgreMemoryAllocatedObject.h.

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

Definition at line 118 of file OgreMemoryAllocatedObject.h.

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

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

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

Definition at line 72 of file OgreMemoryAllocatedObject.h.

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

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

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

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

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

Definition at line 90 of file OgreMemoryAllocatedObject.h.

bool Ogre::RegionSceneQuery::queryResult ( MovableObject first)
virtualinherited

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

Implements Ogre::SceneQueryListener.

bool Ogre::RegionSceneQuery::queryResult ( SceneQuery::WorldFragment fragment)
virtualinherited

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

Implements Ogre::SceneQueryListener.

void Ogre::PCZSphereSceneQuery::setExcludeNode ( SceneNode excludeNode)
inline

set node to exclude from query

Definition at line 105 of file OgrePCZSceneQuery.h.

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.
void Ogre::SphereSceneQuery::setSphere ( const Sphere sphere)
inherited

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

void Ogre::PCZSphereSceneQuery::setStartZone ( PCZone startZone)
inline

set the zone to start the scene query

Definition at line 103 of file OgrePCZSceneQuery.h.

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

SceneNode* Ogre::PCZSphereSceneQuery::mExcludeNode
protected

Definition at line 108 of file OgrePCZSceneQuery.h.

SceneQueryResult* Ogre::RegionSceneQuery::mLastResult
protectedinherited

Definition at line 227 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.

Sphere Ogre::SphereSceneQuery::mSphere
protectedinherited

Definition at line 290 of file OgreSceneQuery.h.

PCZone* Ogre::PCZSphereSceneQuery::mStartZone
protected

Definition at line 107 of file OgrePCZSceneQuery.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: