DtIndirectEntityGeometry.h

Go to the documentation of this file.

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


#pragma once

#include <vrvOsg/vrvOsg.h>
#include <vrvOsg/DtIndirectGeometry.h>

#include <tbb/concurrent_vector.h>

namespace makVrv
{
   class DtIndirectEntityGeometry;

   typedef DtVirtualBaseClassCreator<DtIndirectEntityGeometry, const DtCullShaderConfig&, const bool&> DtIndirectEntityGeometryCreator;

   template <>
   inline const char* creatorTypeName<DtIndirectEntityGeometry>(void) { return "DtIndirectEntityGeometryCreator"; }

   class DT_DLL_VRVOSG DtIndirectEntityGeometry : public DtIndirectGeometry
   {
   public:
      friend DtIndirectEntityGeometryCreator;

      template<class T>
      struct CloneMasterPair
      {
         osg::ref_ptr<T> myClone;
         osg::ref_ptr<T> myMaster;
      };

      template<class T>
      struct MapCloneToDofTransformPairAndFlags
      {
         osg::ref_ptr<T> myClone;
         osg::ref_ptr<T> myMaster;
         int myFlags = 0;
      };

      typedef std::unordered_map<int, Matrix4_32> MapInstanceIdToXform;

      typedef CloneMasterPair<osgSim::MultiSwitch> MultiSwitchPair;
      typedef std::unordered_map< osgSim::MultiSwitch*, MultiSwitchPair> MapCloneToMultiSwitchPair;
      typedef std::unordered_map< int, MapCloneToMultiSwitchPair> MapInstanceToMapCloneToMasterMultiSwitches;

      //Use the pair to hold the refs and the raw pointer to index into the map
      typedef MapCloneToDofTransformPairAndFlags<osgSim::DOFTransform> DofTransformPair;
      typedef std::unordered_map< osgSim::DOFTransform*, DofTransformPair > MapCloneToDofTransformPair;
      typedef std::unordered_map< int, MapCloneToDofTransformPair> MapInstanceToMapCloneToMasterDofs;

      typedef CloneMasterPair<osg::Sequence> SequencePair;
      typedef std::unordered_map< osg::Sequence*, SequencePair > MapCloneToSequencePair;
      typedef std::unordered_map< int, MapCloneToSequencePair> MapInstanceToMapCloneToMasterSequences;

      typedef std::map< const std::string, DtIndirectUvOffsetManager::UvOffset> MapAnnotationToUvOffsetData;
      typedef std::unordered_map< int, MapAnnotationToUvOffsetData> MapInstanceToMapAnnotationToUvOffsetData;

      typedef std::unordered_map< int, std::tuple<float, float, float> > MapInstanceToUvOffset;

      struct InstanceUpdateStruct
      {
         int myInstanceId;
         Matrix4_32 myXForm;
         InstanceUpdateStruct( int id, const Matrix4_32& xFormMat );
         InstanceUpdateStruct( const InstanceUpdateStruct& );

         InstanceUpdateStruct() = delete;
         InstanceUpdateStruct& operator=( const InstanceUpdateStruct& ) = delete;
      };

      using InstanceUpdatesVector = tbb::concurrent_vector<InstanceUpdateStruct>;
   public:
      virtual ~DtIndirectEntityGeometry();

   protected:
      DtIndirectEntityGeometry(DtDe& de, const DtCullShaderConfig& cullShaderConfig, bool terrainPatch);

   private:
      DtIndirectEntityGeometry() = delete;
      DtIndirectEntityGeometry(const DtIndirectEntityGeometry& other) = delete;
      DtIndirectEntityGeometry& operator=(const DtIndirectEntityGeometry& other) = delete;

   public:
      virtual void setInstanceMatrixTransform(int instanceId, const Matrix4_32& xForm);

      virtual void concurrentSetInstanceMatrixTransform( int instanceId, const Matrix4_32& xForm );

      virtual void processUpdates();

      virtual Matrix4_32 instanceMatrixTransform(int instanceId) const;

      virtual void removeInstance(int id);

      virtual void setInstanceMultiSwitch(int id, osgSim::MultiSwitch* clone, osgSim::MultiSwitch* master);

      virtual void instanceMultiSwitches(int instanceIdIndirect, MapCloneToMultiSwitchPair& mapCloneToMasterMultiSwitches) const;

      virtual void setInstanceModelId(int id, int modelId);

      virtual void setInstanceUvOffset(int id, const std::string& annotation, float uOffset, float vOffset);

      virtual void scrollUv(int id, const std::tuple<float, float, float>& uvspeeds);

      virtual void instanceAnnotationsAndUvOffsets(int instanceIdIndirect, std::vector<DtIndirectAnnotationAndUvOffset>& annotations) const;

      virtual void setInstanceColor(int instanceIdIndirect, const Vector4_32& color);
      virtual Vector4_32 instanceColor(int instanceIdIndirect) const;

      virtual void setInstanceVisibility(int instanceIdIndirect, bool visible);
      virtual bool instanceVisibility(int instanceIdIndirect) const;

      virtual void setInstanceLightPointGroupId(int instanceIdIndirect, int lightPointGroupId);
      virtual int instanceLightPointGroupId(int instanceIdIndirect) const;

      virtual void setInstanceLightPointMaxDistance(int instanceIdIndirect, float lightPointMaxDistance);
      virtual float instanceLightPointMaxDistance(int instanceIdIndirect) const;

      virtual void setInstanceDof(int id, osgSim::DOFTransform* clone, osgSim::DOFTransform* master, int animationFlags);

      virtual void setInstanceDofAnimationFlags(int id, osgSim::DOFTransform* clone, osgSim::DOFTransform* master, int animationFlags);
      
      virtual void setInstanceDofTranslation(int id, osgSim::DOFTransform* clone, osgSim::DOFTransform* master
         , const Vector3_64& trans
         , const Vector3_64& transVel);

      virtual void setInstanceDofOrientation(int id, osgSim::DOFTransform* clone, osgSim::DOFTransform* master
         , const Vector3_64& hpr
         , const Vector3_64& hprVel
         , int animationFlags);

      virtual void setInstanceDofOrientation(int id, osgSim::DOFTransform* clone, osgSim::DOFTransform* master
         , const Vector3_64& hprVel
         , bool forceUpdate
         , int animationFlags);

      virtual void instanceDofs(int instanceIdIndirect, MapCloneToDofTransformPair& mapCloneToDofTransformPair) const;

      virtual void setInstanceSequence(int id, osg::Sequence* clone, osg::Sequence* master);

      virtual void instanceSequences(int instanceIdIndirect, MapCloneToSequencePair& mapCloneToMasterSequences) const;


      virtual bool hasInProgressInstanceMove() const;

      virtual void addInProgressInstanceMove();

      virtual void subtractInProgressInstanceMove();

      virtual bool allInstancesAreToBeDeleted() const override;

   protected:
      virtual void setMultiSwitchOnInstanceInInstanceContainer(int instanceContainerId, osgSim::MultiSwitch* clone, osgSim::MultiSwitch* master);

      virtual bool setDofOnInstanceInInstanceContainer(int instanceContainerId, osgSim::DOFTransform* clone, osgSim::DOFTransform* master, int animationFlags);

      virtual void setUvOffsetOnInstanceInInstanceContainer(const int instanceId, const std::string& annotation, float uOffset, float vOffset);

      virtual bool removeInstanceInInstanceContainer(int instanceContainerId);

      virtual void removeInstanceFromIndicesCount(int instanceContainerIndex);

      virtual void updateInstancePositionOrientationAddedActual(const DtIndirectGeometryInstance& instance, int outInstanceIndex) override;

      virtual void updateInstanceSwitchesAddedActual(const DtIndirectGeometryInstance& instance, int outInstanceIndex) override;

      virtual void updateInstanceSequencesAddedActual(const DtIndirectGeometryInstance& instance, int outInstanceIndex) override;

      virtual void updateInstanceUvOffsetsAddedActual(const DtIndirectGeometryInstance& instance, int outInstanceIndex) override;

      virtual void updateInstanceColorAddedActual(const DtIndirectGeometryInstance& instance, int outInstanceIndex) override;

      virtual void updateInstanceLightPointGroupIdActual(const DtIndirectGeometryInstance& instance, int outInstanceIndex) override;
      
      virtual void updateInstanceVisibilityLightPointMaxDistanceActual(const DtIndirectGeometryInstance& instance, int outInstanceIndex) override;

      virtual bool updateInstanceDeletionBeforeAddedActual(const DtIndirectGeometryInstance& instance) override;

      virtual void updateInstancesDofsAddedActual(const DtIndirectGeometryInstance& instance, int outInstanceIndex) override;

      virtual void updateInstanceModelIdAddedActual(const DtIndirectGeometryInstance& instance, int outInstanceIndex) override;

      virtual void setInstanceModelIdInInstanceContainer(int instanceId, int modelId);

   protected:
      //typedef std::unordered_map<int, Matrix4_32> MapInstanceIdToXform;
      MapInstanceIdToXform myMapInstanceIdToXform;

      //Left the typedefs here commented out so they are easier to follow. They need to be at the
      // top so they can be used as arguments in the functions.

      //typedef CloneMasterPair<osgSim::MultiSwitch> MultiSwitchPair;
      //typedef std::map< osgSim::MultiSwitch*, MultiSwitchPair> MapCloneToMultiSwitchPair;
      //typedef std::map< int, MapCloneToMultiSwitchPair> MapInstanceToMapCloneToMasterMultiSwitches;
      MapInstanceToMapCloneToMasterMultiSwitches myMapInstanceToMapCloneToMasterMultiSwitches;

      //Use the pair to hold the refs and the raw pointer to index into the map
      //typedef CloneMasterPair<osgSim::DOFTransform> DofTransformPair;
      //typedef std::unordered_map< osgSim::DOFTransform*, DofTransformPair > MapCloneToDofTransformPair;
      //typedef std::unordered_map< int, MapCloneToDofTransformPair> MapInstanceToMapCloneToMasterDofs;
      MapInstanceToMapCloneToMasterDofs myMapInstanceToMapCloneToMasterDofs;

      //Use the pair to hold the refs and the raw pointer to index into the map
      //typedef CloneMasterPair<osg::Sequence> SequencePair;
      //typedef std::unordered_map< osg::Sequence*, SequencePair > MapCloneToSequencePair;
      //typedef std::unordered_map< int, MapCloneToSequencePair> MapInstanceToMapCloneToMasterSequences;
      MapInstanceToMapCloneToMasterSequences myMapInstanceToMapCloneToMasterSequences;

      //typedef std::unordered_map< const std::string, DtIndirectUvOffsetManager::UvOffset> MapAnnotationToUvOffsetData;
      //typedef std::unordered_map< int, MapAnnotationToUvOffsetData> MapInstanceToMapAnnotationToUvOffsetData;
      MapInstanceToMapAnnotationToUvOffsetData myMapInstanceToMapAnnotationToUvOffsetData;

      //typedef std::unordered_map< int, DtIndirectUvOffsetManager::UvOffset> MapInstanceToUvOffset;
      MapInstanceToUvOffset myMapInstanceToUvOffset;

      std::unordered_map< int, int > myMapInstanceInIndirectToModelId;

      std::unordered_map<int, Vector4_32> myMapInstanceToColor;

      std::unordered_map<int, bool> myMapInstanceToVisibility;

      std::unordered_map<int, int> myMapInstanceToLightPointGroupId;
      
      std::unordered_map<int, float> myMapInstanceToLightPointMaxDistance;

      typedef std::unordered_set<int> SetInstancesToDelete;
      SetInstancesToDelete mySetInstancesIndirectIdsToDelete;

      InstanceUpdatesVector myInstanceUpdates;

      std::atomic<int> myNumInProgressInstanceMoves;

      // Supporting texture variants is relatively new. If there are bugs,
      // this can be changed to false, to debug whether texture variants support is the cause.
      const bool mySupportInstanceModelChanges = true;
   };
}