OgreSceneQuery.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2011 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __SceneQuery_H__
#define __SceneQuery_H__

#include "OgrePrerequisites.h"
#include "OgreAxisAlignedBox.h"
#include "OgreSphere.h"
#include "OgreRay.h"
#include "OgreRenderOperation.h"
#include "OgrePlaneBoundedVolume.h"

namespace Ogre {

    // forward declaration
    class SceneQueryListener;
    class _OgreExport SceneQuery : public SceneMgtAlloc
    {
    public:
        enum WorldFragmentType {
            WFT_NONE,
            WFT_PLANE_BOUNDED_REGION,
            WFT_SINGLE_INTERSECTION,
            WFT_CUSTOM_GEOMETRY,
            WFT_RENDER_OPERATION
        };

        struct WorldFragment {
            WorldFragmentType fragmentType;
            Vector3 singleIntersection;
            list<Plane>::type* planes;
            void* geometry;
            RenderOperation* renderOp;
            
        };
    protected:
        SceneManager* mParentSceneMgr;
        uint32 mQueryMask;
        uint32 mQueryTypeMask;
        set<WorldFragmentType>::type mSupportedWorldFragments;
        WorldFragmentType mWorldFragmentType;
    
    public:
        SceneQuery(SceneManager* mgr);
        virtual ~SceneQuery();

        virtual void setQueryMask(uint32 mask);
        virtual uint32 getQueryMask(void) const;

        virtual void setQueryTypeMask(uint32 mask);
        virtual uint32 getQueryTypeMask(void) const;

        virtual void setWorldFragmentType(enum WorldFragmentType wft);

        virtual WorldFragmentType getWorldFragmentType(void) const;

        virtual const set<WorldFragmentType>::type* getSupportedWorldFragmentTypes(void) const
            {return &mSupportedWorldFragments;}

        
    };

    class _OgreExport SceneQueryListener
    {
    public:
        virtual ~SceneQueryListener() { }
        virtual bool queryResult(MovableObject* object) = 0;
        virtual bool queryResult(SceneQuery::WorldFragment* fragment) = 0;

    };

    typedef list<MovableObject*>::type SceneQueryResultMovableList;
    typedef list<SceneQuery::WorldFragment*>::type SceneQueryResultWorldFragmentList;
    struct _OgreExport SceneQueryResult : public SceneMgtAlloc
    {
        SceneQueryResultMovableList movables;
        SceneQueryResultWorldFragmentList worldFragments;
    };

    class _OgreExport RegionSceneQuery
        : public SceneQuery, public SceneQueryListener
    {
    protected:
        SceneQueryResult* mLastResult;
    public:
        RegionSceneQuery(SceneManager* mgr);
        virtual ~RegionSceneQuery();
        virtual SceneQueryResult& execute(void);

        virtual void execute(SceneQueryListener* listener) = 0;
        
        virtual SceneQueryResult& getLastResults(void) const;
        virtual void clearResults(void);

        bool queryResult(MovableObject* first);
        bool queryResult(SceneQuery::WorldFragment* fragment);
    };

    class _OgreExport AxisAlignedBoxSceneQuery : public RegionSceneQuery
    {
    protected:
        AxisAlignedBox mAABB;
    public:
        AxisAlignedBoxSceneQuery(SceneManager* mgr);
        virtual ~AxisAlignedBoxSceneQuery();

        void setBox(const AxisAlignedBox& box);

        const AxisAlignedBox& getBox(void) const;

    };

    class _OgreExport SphereSceneQuery : public RegionSceneQuery
    {
    protected:
        Sphere mSphere;
    public:
        SphereSceneQuery(SceneManager* mgr);
        virtual ~SphereSceneQuery();
        void setSphere(const Sphere& sphere);

        const Sphere& getSphere() const;

    };

    class _OgreExport PlaneBoundedVolumeListSceneQuery : public RegionSceneQuery
    {
    protected:
        PlaneBoundedVolumeList mVolumes;
    public:
        PlaneBoundedVolumeListSceneQuery(SceneManager* mgr);
        virtual ~PlaneBoundedVolumeListSceneQuery();
        void setVolumes(const PlaneBoundedVolumeList& volumes);

        const PlaneBoundedVolumeList& getVolumes() const;

    };


    /*
    class _OgreExport PyramidSceneQuery : public RegionSceneQuery
    {
    public:
        PyramidSceneQuery(SceneManager* mgr);
        virtual ~PyramidSceneQuery();
    };
    */

    class _OgreExport RaySceneQueryListener 
    {
    public:
        virtual ~RaySceneQueryListener() { }
        virtual bool queryResult(MovableObject* obj, Real distance) = 0;

        virtual bool queryResult(SceneQuery::WorldFragment* fragment, Real distance) = 0;

    };
      
    struct _OgreExport RaySceneQueryResultEntry
    {
        Real distance;
        MovableObject* movable;
        SceneQuery::WorldFragment* worldFragment;
        bool operator < (const RaySceneQueryResultEntry& rhs) const
        {
            return this->distance < rhs.distance;
        }

    };
    typedef vector<RaySceneQueryResultEntry>::type RaySceneQueryResult;

    class _OgreExport RaySceneQuery : public SceneQuery, public RaySceneQueryListener
    {
    protected:
        Ray mRay;
        bool mSortByDistance;
        ushort mMaxResults;
        RaySceneQueryResult mResult;

    public:
        RaySceneQuery(SceneManager* mgr);
        virtual ~RaySceneQuery();
        virtual void setRay(const Ray& ray);
        virtual const Ray& getRay(void) const;
        virtual void setSortByDistance(bool sort, ushort maxresults = 0);
        virtual bool getSortByDistance(void) const;
        virtual ushort getMaxResults(void) const;
        virtual RaySceneQueryResult& execute(void);

        virtual void execute(RaySceneQueryListener* listener) = 0;

        virtual RaySceneQueryResult& getLastResults(void);
        virtual void clearResults(void);

        bool queryResult(MovableObject* obj, Real distance);
        bool queryResult(SceneQuery::WorldFragment* fragment, Real distance);




    };

    class _OgreExport IntersectionSceneQueryListener 
    {
    public:
        virtual ~IntersectionSceneQueryListener() { }
        virtual bool queryResult(MovableObject* first, MovableObject* second) = 0;

        virtual bool queryResult(MovableObject* movable, SceneQuery::WorldFragment* fragment) = 0;

        /* NB there are no results for world fragments intersecting other world fragments;
           it is assumed that world geometry is either static or at least that self-intersections
           are irrelevant or dealt with elsewhere (such as the custom scene manager) */
        
    
    };
        
    typedef std::pair<MovableObject*, MovableObject*> SceneQueryMovableObjectPair;
    typedef std::pair<MovableObject*, SceneQuery::WorldFragment*> SceneQueryMovableObjectWorldFragmentPair;
    typedef list<SceneQueryMovableObjectPair>::type SceneQueryMovableIntersectionList;
    typedef list<SceneQueryMovableObjectWorldFragmentPair>::type SceneQueryMovableWorldFragmentIntersectionList;
    struct _OgreExport IntersectionSceneQueryResult : public SceneMgtAlloc
    {
        SceneQueryMovableIntersectionList movables2movables;
        SceneQueryMovableWorldFragmentIntersectionList movables2world;
        
        

    };

    class _OgreExport IntersectionSceneQuery
        : public SceneQuery, public IntersectionSceneQueryListener 
    {
    protected:
        IntersectionSceneQueryResult* mLastResult;
    public:
        IntersectionSceneQuery(SceneManager* mgr);
        virtual ~IntersectionSceneQuery();

        virtual IntersectionSceneQueryResult& execute(void);

        virtual void execute(IntersectionSceneQueryListener* listener) = 0;

        virtual IntersectionSceneQueryResult& getLastResults(void) const;
        virtual void clearResults(void);

        bool queryResult(MovableObject* first, MovableObject* second);
        bool queryResult(MovableObject* movable, SceneQuery::WorldFragment* fragment);
    };
    
}
    


#endif