SceneManagerPortals.hpp

Go to the documentation of this file.

/**************************************************************************************/
/*                                                                                    */
/*  Visualization Library                                                             */
/*  http://visualizationlibrary.org                                                   */
/*                                                                                    */
/*  Copyright (c) 2005-2020, Michele Bosi                                             */
/*  All rights reserved.                                                              */
/*                                                                                    */
/*  Redistribution and use in source and binary forms, with or without modification,  */
/*  are permitted provided that the following conditions are met:                     */
/*                                                                                    */
/*  - Redistributions of source code must retain the above copyright notice, this     */
/*  list of conditions and the following disclaimer.                                  */
/*                                                                                    */
/*  - Redistributions in binary form must reproduce the above copyright notice, this  */
/*  list of conditions and the following disclaimer in the documentation and/or       */
/*  other materials provided with the distribution.                                   */
/*                                                                                    */
/*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND   */
/*  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED     */
/*  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE            */
/*  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR  */
/*  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES    */
/*  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;      */
/*  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON    */
/*  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT           */
/*  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS     */
/*  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                      */
/*                                                                                    */
/**************************************************************************************/

#ifndef PortalSceneManager_INCLUDE_ONCE
#define PortalSceneManager_INCLUDE_ONCE

#include <vlGraphics/Actor.hpp>
#include <vlCore/Vector4.hpp>
#include <vlCore/Vector3.hpp>
#include <vlGraphics/SceneManager.hpp>
#include <vlCore/Log.hpp>
#include <vlGraphics/Frustum.hpp>

namespace vl
{
//-----------------------------------------------------------------------------
  class Sector;
  class SceneManagerPortals;
//-----------------------------------------------------------------------------
  class VLGRAPHICS_EXPORT Portal: public Object
  {
    VL_INSTRUMENT_CLASS(vl::Portal, Object)

    friend class SceneManagerPortals;

  public:
    Portal()
    {
      VL_DEBUG_SET_OBJECT_NAME()
      mIsOpen = true;
      mVisitTick = 0;
    }

    std::vector<fvec3>& geometry() { return mPortalGeometry; }
    const std::vector<fvec3>& geometry() const { return mPortalGeometry; }

    void setTargetSector(Sector* sector) { mTargetSector = sector; }
    Sector* targetSector() { return mTargetSector; }
    const Sector* targetSector() const { return mTargetSector; }

    bool isOpen() const { return mIsOpen; }
    void setIsOpen(bool is_open) { mIsOpen = is_open; }

  protected:
    void setNormal(const fvec3& n) { mNormal = n; }
    const fvec3& normal() const { return mNormal; }

    bool computeNormal();

  protected:
    std::vector<fvec3> mPortalGeometry;
    Sector* mTargetSector;
    fvec3 mNormal;
    unsigned int mVisitTick;
    bool mIsOpen;
  };
//-----------------------------------------------------------------------------
  class VLGRAPHICS_EXPORT Sector: public Object
  {
    VL_INSTRUMENT_CLASS(vl::Sector, Object)

  public:
    class VisibilityCallback: public Object
    {
    public:
        virtual void operator()(const Camera* cam, SceneManagerPortals* psm, Sector* s, Portal* p) = 0;
    };
  public:
    Sector()
    {
      VL_DEBUG_SET_OBJECT_NAME()
      mActors = new ActorCollection;
    }

    ActorCollection* actors() { return mActors.get(); }
    const ActorCollection* actors() const { return mActors.get(); }

    std::vector< ref<Portal> >& portals() { return mPortals; }
    const std::vector< ref<Portal> >& portals() const { return mPortals; }

    std::vector< AABB >& volumes() { return mVolumes; }
    const std::vector< AABB >& volumes() const { return mVolumes; }

    AABB computeBoundingBox();

    std::vector< ref<VisibilityCallback> >& callbacks() { return mCallbacks; }
    const std::vector< ref<VisibilityCallback> >& callbacks() const { return mCallbacks; }
    void executeCallbacks(const Camera*cam,SceneManagerPortals* psm, Portal*p);

  protected:
    std::vector< ref<Portal> > mPortals;
    std::vector< AABB > mVolumes;
    ref< ActorCollection > mActors;
    std::vector< ref<VisibilityCallback> > mCallbacks;
  };
//-----------------------------------------------------------------------------
  class VLGRAPHICS_EXPORT SceneManagerPortals: public SceneManager
  {
    VL_INSTRUMENT_CLASS(vl::SceneManagerPortals, SceneManager)

  public:
    SceneManagerPortals(): mExternalSector(new Sector), mVisitTick(1), mShowPortals(false)
    {
      VL_DEBUG_SET_OBJECT_NAME()
    }

    void extractActors(ActorCollection& list);
    void extractVisibleActors(ActorCollection& list, const Camera* camera);

    std::vector< ref<Sector> >& sectors() { return mSectors; }
    const std::vector< ref<Sector> >& sectors() const { return mSectors; }

    Sector* externalSector() { return mExternalSector.get(); }
    const Sector* externalSector() const { return mExternalSector.get(); }

    void computePortalNormals();

    void initialize();

    bool showPortals() const { return mShowPortals; }
    void setShowPortals(bool show) { mShowPortals = show; }
    void invalidatePortalActors() { mPortalActorMap.clear(); }

    const std::vector<Frustum>& frustumStack() const { return mFrustumStack; }

  protected:
    void renderPortal(Portal* portal);
    void visitSector(Sector* prev, Sector* sector, const vec3& eye, const Camera* camera);
    Sector* computeStartingSector(const Camera* camera);

  protected:
    ref<Sector> mExternalSector;
    std::vector< ref<Sector> > mSectors;
    std::vector< ref<Actor> > mTempActors;
    std::map<Portal*, ref<Actor> > mPortalActorMap;
    std::vector<Frustum> mFrustumStack;
    unsigned mVisitTick;
    bool mShowPortals;
  };
//-----------------------------------------------------------------------------
}

#endif