Effect.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 Effect_INCLUDE_ONCE
#define Effect_INCLUDE_ONCE

#include <vlGraphics/Renderable.hpp>
#include <vlGraphics/LODEvaluator.hpp>
#include <vlGraphics/Shader.hpp>
#include <vlCore/Collection.hpp>
#include <vector>

namespace vl
{
  class Actor;
  //------------------------------------------------------------------------------
  // ShaderPasses
  //------------------------------------------------------------------------------
  class ShaderPasses: public Collection<Shader>
  {
    VL_INSTRUMENT_CLASS(vl::ShaderPasses, Collection<Shader>)

  public:
    ShaderPasses(Shader* pass1=NULL, Shader* pass2=NULL, Shader* pass3=NULL, Shader* pass4=NULL )
    {
      VL_DEBUG_SET_OBJECT_NAME()
      if (pass1)
        push_back(pass1);
      if (pass2)
        push_back(pass2);
      if (pass3)
        push_back(pass3);
      if (pass4)
        push_back(pass4);
    }
  };
  //------------------------------------------------------------------------------
  // Effect
  //------------------------------------------------------------------------------
  class VLGRAPHICS_EXPORT Effect: public Object
  {
    VL_INSTRUMENT_CLASS(vl::Effect, Object)

    // use deepCopy() and shallowCopy() instead
    Effect(const Effect&): Object() {}
    Effect& operator=(const Effect&) { return *this; }

  public:
    Effect()
    {
      VL_DEBUG_SET_OBJECT_NAME()
      mEnableMask = 0xFFFFFFFF;
      mRenderRank = 0;
      mActiveLod  = 0;
      mLODShaders[0] = new ShaderPasses(new Shader);
    }

    ref<Effect> shallowCopy(EShaderCopyMode shader_copy) const
    {
      ref<Effect> fx = new Effect;
      fx->shallowCopyFrom(*this, shader_copy);
      return fx;
    }

    Effect& shallowCopyFrom(const Effect& other, EShaderCopyMode shader_copy)
    {
      for(int i=0; i<VL_MAX_EFFECT_LOD; ++i)
        mLODShaders[i] = other.mLODShaders[i];

      if (shader_copy == SCM_OwnShaders)
      {
        // create local shallow copies of all the Shaders
        for(int lod=0; lod<VL_MAX_EFFECT_LOD; ++lod)
          for(size_t pass=0; mLODShaders[lod] && pass<mLODShaders[lod]->size(); ++pass)
            (*mLODShaders[lod])[pass] = (*mLODShaders[lod])[pass]->shallowCopy();
      }

      mLODEvaluator = other.mLODEvaluator;

      mActiveLod = other.mActiveLod;
      mRenderRank = other.mRenderRank;
      mEnableMask = other.mEnableMask;

      return *this;
    }

    ref<Effect> deepCopy() const
    {
      ref<Effect> fx = new Effect;
      fx->deepCopyFrom(*this);
      return fx;
    }

    Effect& deepCopyFrom(const Effect& other)
    {
      shallowCopyFrom(other, SCM_ShareShaders);

      // create local clones of all the Shaders
      for(int lod=0; lod<VL_MAX_EFFECT_LOD; ++lod)
        for(size_t pass=0; mLODShaders[lod] && pass<mLODShaders[lod]->size(); ++pass)
          (*mLODShaders[lod])[pass] = (*mLODShaders[lod])[pass]->deepCopy();

      return *this;
    }

    void setRenderRank(int rank) { mRenderRank = rank; }

    int renderRank() const { return mRenderRank; }

    const ref<ShaderPasses>& lod(int lod_level) const { return mLODShaders[lod_level]; }

    ref<ShaderPasses>& lod(int lod_level) { return mLODShaders[lod_level]; }

    Shader* shader(int lodi=0, int pass=0) { return lod(lodi)->at(pass); }

    const Shader* shader(int lodi=0, int pass=0) const { return lod(lodi)->at(pass); }

    void setLOD(int lodi, Shader* shader1, Shader* shader2=NULL, Shader* shader3=NULL, Shader* shader4=NULL)
    {
      VL_CHECK(lodi<VL_MAX_EFFECT_LOD)
      lod(lodi) = new ShaderPasses(shader1,shader2,shader3,shader4);
    }

    void setLODEvaluator(LODEvaluator* lod_evaluator) { mLODEvaluator = lod_evaluator; }

    LODEvaluator* lodEvaluator() { return mLODEvaluator.get(); }

    const LODEvaluator* lodEvaluator() const { return mLODEvaluator.get(); }

    void setEnableMask(unsigned int mask) { mEnableMask = mask; }

    unsigned int enableMask() const { return mEnableMask; }

    int evaluateLOD(Actor* actor, Camera* camera);

    void setActiveLod(int lod)
    {
      VL_CHECK( lod < VL_MAX_EFFECT_LOD )
      VL_CHECK( lod >= 0 )
      mActiveLod = lod;
    }

    int activeLod() const { return mActiveLod; }

  protected:
    ref<ShaderPasses> mLODShaders[VL_MAX_EFFECT_LOD];
    ref<LODEvaluator> mLODEvaluator;
    int mActiveLod;
    int mRenderRank;
    unsigned int mEnableMask;
  };
  //------------------------------------------------------------------------------
}

#endif