OGRE  1.12.4
Object-Oriented Graphics Rendering Engine
Ogre::PCZRaySceneQuery Class Reference

PCZ implementation of RaySceneQuery. More...

#include <OgrePCZSceneQuery.h>

+ Inheritance diagram for Ogre::PCZRaySceneQuery:

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

 PCZRaySceneQuery (SceneManager *creator)
 
 ~PCZRaySceneQuery ()
 
virtual void clearResults (void)
 Clears the results of the last query execution. More...
 
void execute (RaySceneQueryListener *listener)
 See RayScenQuery. More...
 
virtual RaySceneQueryResultexecute (void)
 Executes the query, returning the results back in one list. More...
 
virtual RaySceneQueryResultgetLastResults (void)
 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 ushort getMaxResults (void) const
 Gets the maximum number of results returned from the query (only relevant if results are being sorted) 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 RaygetRay (void) const
 Gets the ray which is to be used for this query. More...
 
virtual bool getSortByDistance (void) const
 Gets whether the results are sorted by distance. More...
 
virtual const std::set< WorldFragmentType > * 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...
 
bool queryResult (MovableObject *obj, Real distance)
 Self-callback in order to deal with execute which returns collection. More...
 
bool queryResult (SceneQuery::WorldFragment *fragment, Real distance)
 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...
 
virtual void setRay (const Ray &ray)
 Sets the ray which is to be used for this query. More...
 
virtual void setSortByDistance (bool sort, ushort maxresults=0)
 Sets whether the results of this query will be sorted by distance along the ray. 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...
 

Detailed Description

PCZ implementation of RaySceneQuery.

Member Enumeration Documentation

◆ WorldFragmentType

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

◆ PCZRaySceneQuery()

Ogre::PCZRaySceneQuery::PCZRaySceneQuery ( SceneManager creator)

◆ ~PCZRaySceneQuery()

Ogre::PCZRaySceneQuery::~PCZRaySceneQuery ( )

Member Function Documentation

◆ execute() [1/2]

void Ogre::PCZRaySceneQuery::execute ( RaySceneQueryListener listener)
virtual

See RayScenQuery.

Reimplemented from Ogre::DefaultRaySceneQuery.

◆ setStartZone()

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

set the zone to start the scene query

◆ setExcludeNode()

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

set node to exclude from query

◆ execute() [2/2]

virtual RaySceneQueryResult& Ogre::RaySceneQuery::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.

◆ setRay()

virtual void Ogre::RaySceneQuery::setRay ( const Ray ray)
virtualinherited

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

◆ getRay()

virtual const Ray& Ogre::RaySceneQuery::getRay ( void  ) const
virtualinherited

Gets the ray which is to be used for this query.

◆ setSortByDistance()

virtual void Ogre::RaySceneQuery::setSortByDistance ( bool  sort,
ushort  maxresults = 0 
)
virtualinherited

Sets whether the results of this query will be sorted by distance along the ray.

Remarks
Often you want to know what was the first object a ray intersected with, and this method allows you to ask the query to sort the results so that the nearest results are listed first.
Note that because the query returns results based on bounding volumes, the ray may not actually intersect the detail of the objects returned from the query, just their bounding volumes. For this reason the caller is advised to use more detailed intersection tests on the results if a more accurate result is required; OGRE uses bounds checking in order to give the most speedy results since not all applications need extreme accuracy.
Parameters
sortIf true, results will be sorted.
maxresultsIf sorting is enabled, this value can be used to constrain the maximum number of results that are returned. Please note (as above) that the use of bounding volumes mean that accuracy is not guaranteed; if in doubt, allow more results and filter them in more detail. 0 means unlimited results.

◆ getSortByDistance()

virtual bool Ogre::RaySceneQuery::getSortByDistance ( void  ) const
virtualinherited

Gets whether the results are sorted by distance.

◆ getMaxResults()

virtual ushort Ogre::RaySceneQuery::getMaxResults ( void  ) const
virtualinherited

Gets the maximum number of results returned from the query (only relevant if results are being sorted)

◆ getLastResults()

virtual RaySceneQueryResult& Ogre::RaySceneQuery::getLastResults ( void  )
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.

◆ clearResults()

virtual void Ogre::RaySceneQuery::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.

◆ queryResult() [1/2]

bool Ogre::RaySceneQuery::queryResult ( MovableObject obj,
Real  distance 
)
virtualinherited

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

Implements Ogre::RaySceneQueryListener.

◆ queryResult() [2/2]

bool Ogre::RaySceneQuery::queryResult ( SceneQuery::WorldFragment fragment,
Real  distance 
)
virtualinherited

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

Implements Ogre::RaySceneQueryListener.

◆ setQueryMask()

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.

◆ getQueryMask()

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

Returns the current mask for this query.

◆ setQueryTypeMask()

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.

◆ getQueryTypeMask()

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

Returns the current mask for this query.

◆ setWorldFragmentType()

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.

◆ getWorldFragmentType()

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

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

◆ getSupportedWorldFragmentTypes()

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

Returns the types of world fragments this query supports.


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