DtEffectTextureRegistry.h

Go to the documentation of this file.

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


#pragma once

#include <vrvOsg/vrvOsg.h>

#include <vrvOsg/DtEffectTextureType.h>
#include <vrvOsg/DtIndirectEffectTexturesTemplate.h>
#include <vrvOsg/DtIndirectEffectTextureShader.h>

#include <vrvUtil/DtVirtualBaseClass.h>

#include <osg/ExtendedMaterial>

#include <string>
#include <boost/thread/shared_mutex.hpp>

namespace makVrv
{
   class DtDe;

   class DT_DLL_VRVOSG DtEffectTextureRegistry : public DtVirtualBaseClass
   {
   public:
      enum EffectTargetMask
      {
         TARGET_NONE = 0x00,
         TARGET_GEOMETRY = 0x01,
         TARGET_LIGHTS = 0x02,
         TARGET_ALL = 0xFF
      };

   protected:
      struct EffectTextureTypeInfo
      {
         int effectTextureType;
         std::string readableString;
         std::string typeString;
         bool isExtendedMaterialType;
         std::set<osg::ExtendedMaterial::EffectTextureLayer> extendedMaterialLayer;
         std::string effectTexturePostfix;
         EffectTargetMask effectTargetMask;
      };

   protected:
      //protected constructor so it can never be instantiated by accident.
      DtEffectTextureRegistry(DtDe& de);

      //destructor
      ~DtEffectTextureRegistry();
   
   private:
      DtEffectTextureRegistry(const DtEffectTextureRegistry &other);
      DtEffectTextureRegistry &operator=(const DtEffectTextureRegistry &other);

   public:

      int effectTextureTypeFromName(const std::string& texName);

      bool isEffectTexture(const std::string& texName, const std::string& effectTypeCode);

      bool isEffectTexture(const osg::Texture* tex, const std::string& texName, const std::string& effectTypeCode);

      // get the name of the texture without path, extension, 
      // underScore(represent the original extension for meif texture)
      // a/b/c_png.meif => c
      // a.rgb=>a
      std::string getTextureNameLessExtension(const std::string& baseFileName);

      // find the extended name for a texture file.
      std::string getExtendedFileName(const std::string& baseFileName, const std::string& effectTypeCode);

      // get the effect texture type given the extended material type
      int effectTextureTypeFrom(osg::ExtendedMaterial::EffectTextureLayer extendedMaterialLayer);

      // Given the file name of a base texture, populate the output
      // vector with possible file names for corresponding effect textures.
      void getPossibleEffectTextureFileNames(const std::string& baseFileName, std::vector<std::string>& output, const std::string& effectTypeCode);
      
      void registerEffectTextureType(int effectTextureType,
         const std::string& readableString,
         const std::string& typeString,
         const std::string& postfix,
         bool isExtendedMaterialType,
         const std::set<osg::ExtendedMaterial::EffectTextureLayer>& extendedMaterialLayer = std::set<osg::ExtendedMaterial::EffectTextureLayer>());
      
      void registerIndirectShaderEffectTexturetype(int effectTextureType, const DtIndirectEffectTextureShader& indirectEffectTextureShader);

      bool hasIndirectShaderForType(int effectTextureType) const;

      DtIndirectEffectTextureShader indirectEffectTextureShaderForType(int effectTextureType) const;

      std::string toString(int effectTextureType);
      std::string toDtEffectTextureTypeString(int effectTextureType);

      std::string toTextureMapNameString(int effectTextureType) const;

      std::string toTextureCoordNameString(int effectTextureType) const;

      std::string getTextureArrayPattern(const std::string& effectUnitName);

      std::string getTextureArrayReplacement(const std::string& effectUnitName);

      bool isSupportedByExtendedMaterial(int effectTextureType);

      bool effectTextureInstalled(const std::string& baseTextureName, const osg::StateSet* stateSet, const std::string& effectTypeCode);

      std::string getTextureFilePathAndSetNameIfNotSet(const osg::Texture* texture, bool doSetName);

      bool isRemoteTexture(const std::string& texturePath);

      DtIndirectEffectTexturesTemplate effectTexturesTemplate();

      void registerShaderEffectTarget(int effectTextureType, EffectTargetMask effectMask);

      bool supportsTarget(int effectTextureType, EffectTargetMask target) const;

   public:

      static DtEffectTextureRegistry& instance(DtDe& de);

   protected:

      typedef std::map<int, EffectTextureTypeInfo> IntEffectTextureTypeMap;
      IntEffectTextureTypeMap myEffectTextureTypeInfoMap;

      std::map<int, DtIndirectEffectTextureShader> myMapTypeToFXTextureShader;

      std::map<int, EffectTargetMask> myMapTypeToEffectMask;

      DtDe& myDe;

      boost::shared_mutex myEffectTextureInfoTypeMapMutex;

      DtIndirectEffectTexturesTemplate myEffectTexturesTemplate;

      mutable boost::shared_mutex myMutableMapTypeToFxTextureShaderMutex;

   protected:
      static const DtIndirectEffectTextureShader theDummyShader;

   };
}