OgreOctreeZone.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-2014 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.
-----------------------------------------------------------------------------
OctreeZone.h  -  Portal Connected Zone (OctreeZone) header file.

OctreeZones are a type of PCZone.  Octree Zones partition their space into
Octants.  For details on Zones in general, see PCZone.h/cpp.
-----------------------------------------------------------------------------
begin                : Mon Apr 16 2007
author               : Eric Cha
email                : ericc@xenopi.com
Code Style Update    :
-----------------------------------------------------------------------------
*/

#ifndef OCTREEZONE_H
#define OCTREEZONE_H

#include "OgreOctreeZonePrerequisites.h"
#include "OgrePCZone.h"
#include "OgrePCZoneFactory.h"
#include "OgreOctreeZoneOctree.h"

namespace Ogre
{
    class OctreeZoneData;

    class _OgreOctreeZonePluginExport OctreeZone : public PCZone
    {
    public:
        OctreeZone( PCZSceneManager *, const String& );
        virtual ~OctreeZone();

        virtual void setEnclosureNode(PCZSceneNode *);

        virtual void _addNode( PCZSceneNode * );

        virtual void removeNode( PCZSceneNode * );

        virtual void _clearNodeLists(short nodeListTypes);

        virtual bool requiresZoneSpecificNodeData(void);

        virtual void createNodeZoneData(PCZSceneNode *);

        virtual void _checkNodeAgainstPortals(PCZSceneNode *, Portal * );

        virtual void _checkLightAgainstPortals(PCZLight *, 
                                               unsigned long, 
                                               PCZFrustum *,
                                               Portal*);

        void updatePortalsZoneData(void);

        void dirtyNodeByMovingPortals(void);

        virtual PCZone * updateNodeHomeZone(PCZSceneNode * pczsn, bool allowBackTouces);

        virtual void findVisibleNodes(PCZCamera *, 
                                      NodeList & visibleNodeList,
                                      RenderQueue * queue,
                                      VisibleObjectsBoundsInfo* visibleBounds, 
                                      bool onlyShadowCasters,
                                      bool displayNodes,
                                      bool showBoundingBoxes);

        virtual void _findNodes(const AxisAlignedBox &t, 
                                PCZSceneNodeList &list,
                                PortalList &visitedPortals,
                                bool includeVisitors,
                                bool recurseThruPortals,
                                PCZSceneNode *exclude);
        virtual void _findNodes(const Sphere &t, 
                                PCZSceneNodeList &list, 
                                PortalList &visitedPortals,
                                bool includeVisitors,
                                bool recurseThruPortals,
                                PCZSceneNode *exclude );
        virtual void _findNodes(const PlaneBoundedVolume &t, 
                                PCZSceneNodeList &list, 
                                PortalList &visitedPortals,
                                bool includeVisitors,
                                bool recurseThruPortals,
                                PCZSceneNode *exclude );
        virtual void _findNodes(const Ray &t, 
                                PCZSceneNodeList &list, 
                                PortalList &visitedPortals,
                                bool includeVisitors,
                                bool recurseThruPortals,
                                PCZSceneNode *exclude );

        virtual bool setOption( const String &, const void * );

        virtual void notifyCameraCreated( Camera* c );

        virtual void notifyWorldGeometryRenderQueue(uint8 qid);

        virtual void notifyBeginRenderScene(void);

        virtual void setZoneGeometry(const String &filename, PCZSceneNode * parentNode);

        virtual void getAABB(AxisAlignedBox &);

        void init(AxisAlignedBox &box, int depth);
        void resize( const AxisAlignedBox &box );
        void updateNodeOctant( OctreeZoneData * zoneData );
        void removeNodeFromOctree( PCZSceneNode * );
        void addNodeToOctree( PCZSceneNode *, Octree *octree, int depth = 0 );


    protected:
        void walkOctree( PCZCamera *, 
                         NodeList &,
                         RenderQueue *, 
                         Octree *, 
                         VisibleObjectsBoundsInfo* visibleBounds, 
                         bool foundvisible, 
                         bool onlyShadowCasters,
                         bool displayNodes,
                         bool showBoundingBoxes);

    protected:
        Octree *mOctree;
        int mMaxDepth;
        AxisAlignedBox mBox;

        bool mLoose;
        
    };

    class _OgreOctreeZonePluginExport OctreeZoneData : public ZoneData
    {
    public:
        OctreeZoneData(PCZSceneNode *, PCZone * );
        ~OctreeZoneData();
        void update(void);

        Octree * getOctant()
        {
            return mOctant;
        };
        void setOctant( Octree *o )
        {
            mOctant = o;
        };
        bool _isIn( AxisAlignedBox &box );

    public:
        Octree *        mOctant;
        AxisAlignedBox  mOctreeWorldAABB;
    };

    class OctreeZoneFactory : public PCZoneFactory
    {
    public:
        OctreeZoneFactory();
        virtual ~OctreeZoneFactory();

        bool supportsPCZoneType(const String& zoneType);
        PCZone* createPCZone(PCZSceneManager * pczsm, const String& zoneName);
    };

}

#endif