DtOsgLightingComponent.h

Go to the documentation of this file.

/****************************************************************************** 
** Copyright (c) 2020 MAK Technologies, Inc. 
** All rights reserved. 
******************************************************************************/ 


#pragma once

#include <vrvOsg/DtOsgStateComponent.h>
#include <vrvOsg/DtOsgTextureApplyAttribute.h>
#include <vrvOsg/DtOsgTextureBufferObjectApplyAttribute.h>
#include <vrvOsg/DtBindingManager.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <osg/Uniform>
#include <osg/Texture2D>

#include <vector>
#include <boost/array.hpp> // TODO: replace with std::array when c++11 is available

#include "vrvGraphicsUtils/DtLight.h"

namespace osg
{
   class Matrixd;
}

namespace makVrv
{
   class DtLight;
   class DtLightData;
   class DtTileSpaceLightGrid;
   class DtGlSimpleTexture;
   class DtGlBuffer;
   class DtGlTextureBufferObject;
   class DeDe;

   class TextureApplyAttribute;
   class TextureBufferObjectApplyAttribute;
   class DtUniformBufferObjectApplyAttribute;
   class DtShaderStorageBufferApplyAttribute;

   class DT_DLL_VRVOSG DtOsgLightingComponent : public DtOsgStateComponent
   {
   public:
      DtOsgLightingComponent(int maxLights, DtDe& de);

      virtual ~DtOsgLightingComponent();
   private:
      DtOsgLightingComponent();

      DtOsgLightingComponent(const DtOsgLightingComponent&);

      DtOsgLightingComponent& operator=(const DtOsgLightingComponent&);
   public:
      virtual void update(const VectorLights& lights, const osg::State& state);

      virtual void setMaxLights(int maxNumLights);

      virtual const Vector2_uint32& tileSize(void) const;
      virtual const Vector2_uint32& gridMaxDims(void) const;

      virtual osg::Uniform* getEnableLightingUniform() const;

      virtual void setAmbientFactor(float ambientFactor);

      virtual void setUseGlobalAmbient(bool useGlobalAmbient);

      virtual void setDiffuseFactor(float diffuseFactor);

      virtual void setUseGlobalDiffuse(bool useGlobalDiffuse);

      virtual void setUseHDR(bool useHDR);

      virtual void setDirty(bool isDirty) { myDirty = isDirty; }

      virtual void setEmissionFactor(float emissionFactor);

      virtual bool dirty() const { return myDirty; }

      virtual void releaseGLObjects(void);

      // DtOsgStateComponent interface
      virtual bool install(osg::StateSet* stateset);

      virtual bool uninstall(osg::StateSet* stateset);

   public:
      static int textureStartOffset(void);

   protected:
      virtual void setLightPointScale(double scale);
      virtual void setDynamicLightScale(double scale);
      virtual void setEmissiveTextureScale(double scale);
      virtual void setSpecularScale(double scale);
      virtual void setShininessScale(double scale);

      virtual osg::ref_ptr<osg::Uniform> createUniform(const std::string& name, osg::Uniform::Type type, int count=1);

      virtual void packLights(const osg::Matrixd& normalMatrix, const VectorLights& lights, const osg::State& state);
      virtual void updateTextureLightDataGrid(void);
      virtual void updateTiledShadingData(const VectorLights& lights, const osg::State& state);

      virtual void updateTileLightIndexList();
      virtual void updateTileLightGridCountOffsets();

      virtual int lightGridSize();
      virtual int maxUboSize();
      
   protected:

      osg::ref_ptr<osg::Uniform> myEnableLightingUniform;
      osg::ref_ptr<osg::Uniform> myLightingOffClampUniform;

      std::vector< osg::ref_ptr<osg::Uniform> > myUniforms;

      // Parameters of lights are stored in this structure
      DtLightData* myLightGrid;

      // TODO: replace with std::array once c++11 is available.
      boost::array<DtGlBuffer*, DtBindingManager::theLightBlockCount> myLightUBO;

      DtTileSpaceLightGrid* myTileSpaceLightGrid;

      DtGlBuffer* myTileLightGridCountOffsetsSSBO;
      DtGlBuffer* myTileLightIndexListSSBO;

      DtGlSimpleTexture* myColorRampTexture;
      osg::ref_ptr<osg::Uniform> myColorRampTextureUniform;

      osg::ref_ptr<TextureApplyAttribute> myTextureApplyAttribute;
      osg::ref_ptr<DtUniformBufferObjectApplyAttribute> myUniformBufferObjectApplyAttribute;
      osg::ref_ptr<DtShaderStorageBufferApplyAttribute> myShaderStorageBufferApplyAttribute;

      osg::ref_ptr<osg::Uniform> myViewportSizeUniform;

      osg::ref_ptr<osg::Uniform> myLightGridTileDimUniform;
      osg::ref_ptr<osg::Uniform> myLightGridMaxDimUniform;

      osg::ref_ptr<osg::Uniform> myAmbientFactorUniform;
      bool myUseGlobalAmbient;
      osg::ref_ptr<osg::Uniform> myUseGlobalAmbientUniform;
      osg::ref_ptr<osg::Uniform> myDiffuseFactorUniform;
      bool myUseGlobalDiffuse;
      osg::ref_ptr<osg::Uniform> myUseGlobalDiffuseUniform;
      bool myUseHDR;
      bool myDirty;
      osg::ref_ptr<osg::Uniform> myEmissionFactorUniform;

      osg::ref_ptr<osg::Uniform> myTransmittanceFactorUniform;
      osg::ref_ptr<osg::Uniform> myModelTransmittanceUniform;

      osg::ref_ptr<osg::Uniform> myLightPointScaleUniform;
      osg::ref_ptr<osg::Uniform> myDynamicLightScaleUniform;
      osg::ref_ptr<osg::Uniform> myEmissiveTextureScaleUniform;
      osg::ref_ptr<osg::Uniform> mySpecularScaleUniform;
      osg::ref_ptr<osg::Uniform> myShininessScaleUniform;

      osg::ref_ptr<osg::Uniform> myUpVectorUniform;
      osg::ref_ptr<osg::Uniform> myBDRFLutUniform;
      osg::ref_ptr<osg::Texture2D> myBDRFLutTexture;
      osg::ref_ptr<osg::Image> myBDRFLutImage;

      osg::ref_ptr<osg::Uniform> myModelTypeDefaultUniform;

      VectorLights myViewSpaceLightsScratchPad;

      int32* myTileLightGridCountOffsets;
      uint32 myTileLightGridCountOffsetsSize;

      bool myIsInstalled;

      DtSignalConnectionManager myConnections;

      static bool bColorRampTextureWasTried;

      GLint myMaxUboSizeInBytes;   // queried from GL
      int   myLightGridSize;       // max size of light grid

      const DtBindingManager& myBindingManager; // reference to the binding manager
   };
}