OgrePCZSceneManager.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.
-----------------------------------------------------------------------------
PCZSceneManager.h  -  Portal Connected Zone Scene Manager

-----------------------------------------------------------------------------
begin                : Mon Feb 19 2007
author               : Eric Cha
email                : ericc@xenopi.com
Code Style Update    :
-----------------------------------------------------------------------------
*/

#ifndef PCZ_SCENEMANAGER_H
#define PCZ_SCENEMANAGER_H

#include <OgreSceneManager.h>
#include <OgreSphere.h>

#include "OgrePCZPrerequisites.h"
#include "OgrePCZSceneNode.h"
#include "OgrePCZone.h"
#include "OgrePCZoneFactory.h"
#include "OgrePortal.h"
#include "OgreAntiPortal.h"

namespace Ogre
{

    class PCZone;
    class PCZCamera;
    class PCZIntersectionSceneQuery;
    class PCZRaySceneQuery;
    class PCZSphereSceneQuery;
    class PCZAxisAlignedBoxSceneQuery;
    class PCZPlaneBoundedVolumeListSceneQuery;

    typedef vector<SceneNode*>::type NodeList;
    typedef list<WireBoundingBox*>::type BoxList;

    class _OgrePCZPluginExport PCZSceneManager : public SceneManager
    {
        friend class PCZIntersectionSceneQuery;
        friend class PCZRaySceneQuery;
        friend class PCZSphereSceneQuery;
        friend class PCZAxisAlignedBoxSceneQuery;
        friend class PCZPlaneBoundedVolumeListSceneQuery;

    public:
        PCZSceneManager(const String& name);
        ~PCZSceneManager();

        const String& getTypeName(void) const;

        void init(const String &defaultZoneTypeName,
                  const String &filename = "none");

        Portal* createPortal(const String& name, PortalBase::PORTAL_TYPE type = PortalBase::PORTAL_TYPE_QUAD);

        void destroyPortal(Portal * p);

        void destroyPortal(const String & portalName);

        AntiPortal* createAntiPortal(const String& name, PortalBase::PORTAL_TYPE type = PortalBase::PORTAL_TYPE_QUAD);

        void destroyAntiPortal(AntiPortal * p);

        void destroyAntiPortal(const String& portalName);

        PCZone * createZoneFromFile(const String &zoneTypeName,
                                    const String &zoneName,
                                    PCZSceneNode * parentNode,
                                    const String & filename);

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

        virtual SceneNode* createSceneNodeImpl(void);
        virtual SceneNode* createSceneNodeImpl(const String& name);
        virtual SceneNode * createSceneNode ( void );
        virtual SceneNode * createSceneNode ( const String &name );
        virtual Camera * createCamera( const String &name );

        virtual void destroySceneNode( const String &name );

        virtual void destroySceneNode(SceneNode* sn);

        virtual void clearScene(void);

        void setWorldGeometryRenderQueue(uint8 qid);

        void _renderScene(Camera *cam, Viewport *vp, bool includeOverlays);

        void enableSky(bool);

        void setSkyZone(PCZone * zone);

        virtual void _updateSceneGraph( Camera * cam );

        virtual void _findVisibleObjects ( Camera * cam, 
            VisibleObjectsBoundsInfo* visibleBounds, bool onlyShadowCasters );

        virtual void _alertVisibleObjects( void );

        virtual Light* createLight(const String& name);

        virtual Light* getLight(const String& name) const;

        virtual bool hasLight(const String& name) const;

        virtual void destroyLight(const String& name);

        virtual void destroyAllLights(void);

        void _updatePortalZoneData(void);

        void _dirtyNodeByMovingPortals(void);

        void _updatePCZSceneNodes(void);

        void _calcZonesAffectedByLights(Camera * cam);

        /* Attempt to automatically connect unconnected portals to proper target zones 
         * by looking for matching portals in other zones which are at the same location
         */
        void connectPortalsToTargetZonesByLocation(void);

        void _updatePCZSceneNode( PCZSceneNode * );

        void removeSceneNode( SceneNode * );

        void addPCZSceneNode(PCZSceneNode * sn, PCZone * zone);

        PCZone * createZone(const String& zoneType, const String& instanceName);

        void destroyZone(PCZone* zone, bool destroySceneNodes);

        void _updateHomeZone( PCZSceneNode *, bool );

        PCZone * findZoneForPoint(Vector3 & point);

        void createZoneSpecificNodeData(PCZSceneNode *);

        void createZoneSpecificNodeData(PCZone *);

        void setNodeHomeZone(SceneNode *, PCZone *);

        void findNodesIn( const AxisAlignedBox &box, 
                          PCZSceneNodeList &list, 
                          PCZone * startZone,
                          PCZSceneNode *exclude = 0 );

        void findNodesIn( const Sphere &sphere, 
                          PCZSceneNodeList &list, 
                          PCZone * startZone,
                          PCZSceneNode *start = 0 );

        void findNodesIn( const PlaneBoundedVolume &volume, 
                          PCZSceneNodeList &list, 
                          PCZone * startZone,
                          PCZSceneNode *start=0 );

        void findNodesIn( const Ray &ray, 
                          PCZSceneNodeList &list, 
                          PCZone * startZone,
                          PCZSceneNode *start=0 );

        PCZone * getDefaultZone(void)
        {
            return mDefaultZone;
        }
        
        PCZone * getZoneByName(const String & zoneName);
        
        void setShowPortals( bool b )
        {
            mShowPortals = b;
        };

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

        bool getOptionValues( const String & key, StringVector &refValueList );
        bool getOptionKeys( StringVector &refKeys );

        AxisAlignedBoxSceneQuery* createAABBQuery(const AxisAlignedBox& box, uint32 mask = 0xFFFFFFFF);
        SphereSceneQuery* createSphereQuery(const Sphere& sphere, uint32 mask = 0xFFFFFFFF);
        PlaneBoundedVolumeListSceneQuery* createPlaneBoundedVolumeQuery(const PlaneBoundedVolumeList& volumes, uint32 mask = 0xFFFFFFFF);
        RaySceneQuery* createRayQuery(const Ray& ray, uint32 mask = 0xFFFFFFFF);
        IntersectionSceneQuery* createIntersectionQuery(uint32 mask = 0xFFFFFFFF);
        
        typedef MapIterator<ZoneMap> ZoneIterator;
        ZoneIterator getZoneIterator(void) {return ZoneIterator(mZones.begin(), mZones.end());}

        void _clearAllZonesPortalUpdateFlag(void);

        virtual void prepareShadowTextures(Camera* cam, Viewport* vp, const LightList* lightList = 0);

    protected:
        String mDefaultZoneTypeName;

        String mDefaultZoneFileName;

        NodeList mVisible;

        Camera* mLastActiveCamera;

        PCZone *mDefaultZone;

        ZoneMap mZones;

        PortalList mPortals;

        AntiPortalList mAntiPortals;

        bool mShowPortals;

        unsigned long mFrameCount;

        PCZoneFactoryManager * mZoneFactoryManager;

        PCZone* mActiveCameraZone;

        virtual void findLightsAffectingFrustum(const Camera* camera);
        virtual void ensureShadowTexturesCreated();
        virtual void destroyShadowTextures(void);
        virtual void fireShadowTexturesPreCaster(Light* light, Camera* camera, size_t iteration);
    };

    class PCZSceneManagerFactory : public SceneManagerFactory
    {
    protected:
        void initMetaData(void) const;
    public:
        PCZSceneManagerFactory() {}
        ~PCZSceneManagerFactory() {}
        static const String FACTORY_TYPE_NAME;
        SceneManager* createInstance(const String& instanceName);
        void destroyInstance(SceneManager* instance);
    };



}

#endif