DtIndirectDofManager.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/DtIndirectDofInfo.h>
#include <vrvOsg/DtIndirectManager.h>
#include <vrvOsg/DtIndirectAnimatingDof.h>

#include <vrvUtil/DtVirtualBaseClassCreator.h>

#include <vrvMath/DtMatrix.h>
#include <vrvMath/DtReusableMemoryVector.h>

#include <vrvUtil/DtSignalConnectionManager.h>

#include <osg/Node>
#include <osg/ref_ptr>
#include <osg/observer_ptr>
#include <osgSim/DOFTransform>

#include <unordered_map>
#include <deque>

namespace osg
{
   class Sequence;
   class RenderInfo;
   class FrameStamp;
}

namespace makVrv
{
   struct PerGeomInstance;
   class DtInstanceContainer;
   class DtDe;
   class DtOsgShaderFilesCache;
   class DtIndirectViewParameters;
   class DtGlBuffer;
   class DtIndirectDofProgram;
   class DtIndirectClearBufferProgram;
   class DtGlDeleteObjectManager;

   class DtIndirectDofManager;

   typedef DtVirtualBaseClassCreator<DtIndirectDofManager, DtInstanceContainer&> DtIndirectDofManagerCreator;

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

   class DT_DLL_VRVOSG DtIndirectDofManager : public DtIndirectManager
   {
   public:

      #define CPU_SIDE_COMPILATION 1
      #include <../data/shaders/indirect/DofInfoBuffer.h>
      #undef CPU_SIDE_COMPILATION

      typedef osg::observer_ptr<osg::Node> NodeObserverPtr;
      typedef std::pair<NodeObserverPtr, DtIndirectDofInfo> NodeDofInfoPair;
      typedef std::pair<NodeObserverPtr, int> NodeDofInfoIndexPair;
      typedef std::deque<NodeDofInfoPair> DequeNodeDofInfoPairs;
      typedef std::unordered_map<int, DtIndirectAnimatingDof* > MapInfoIdxToAnimatingDof;

      typedef std::unordered_map<int, int> MapInstanceIdToDofInfo;
      typedef std::map<osg::ref_ptr<osgSim::DOFTransform>, MapInstanceIdToDofInfo > MapNodeToMapInstanceIdToDofInfoIndex;

   public:
      friend DtIndirectDofManagerCreator;

      virtual ~DtIndirectDofManager();
   protected:
      DtIndirectDofManager(DtDe& de, DtInstanceContainer& container);

   private:
      DtIndirectDofManager() = delete;
      DtIndirectDofManager(const DtIndirectDofManager &other) = delete;
      DtIndirectDofManager &operator=(const DtIndirectDofManager &other) = delete;
   
   public:
      virtual void addDofPaths(int perGeomInstanceIndex, int size, const DequeNodeDofInfoPairs& parentDofPaths, const DequeNodeDofInfoPairs& dofPaths, int instanceId
      , float modelScale
      , float modelRadius);

      virtual void removeDofPaths(int instanceId);

      virtual bool setDof(osgSim::DOFTransform* clone, osgSim::DOFTransform* master, int instanceId, int flags);

      virtual bool setDofAnimationFlags(osgSim::DOFTransform* clone, osgSim::DOFTransform* master, int instanceId
         , int animationFlags);
      
      virtual bool setDofTranslation(osgSim::DOFTransform* clone, osgSim::DOFTransform* master, int instanceId
         , const Vector3_64& trans
         , const Vector3_64& transVel);

      virtual bool setDofOrientation(osgSim::DOFTransform* clone, osgSim::DOFTransform* master, int instanceId
         , const Vector3_64& hpr
         , const Vector3_64& hprVel
         , int animationFlags);

      virtual bool setDofOrientation(osgSim::DOFTransform* clone, osgSim::DOFTransform* master, int instanceId
         , const Vector3_64& hprVel, bool forceUpdate, int animationFlags);

      virtual void setDofTransform(IndirectDofInfo& info, const osgSim::DOFTransform* clone);

      virtual void setInstanceXform(const Matrix4_32& xform, int instanceId);

      virtual Matrix4_32 instanceXform(int instanceId) const;
      
      virtual void update(const osg::FrameStamp* frameStamp);

      virtual void setPureSignalBasedDofs(bool val);

      virtual bool pureSignalBasedDofs(void) const;

      virtual void reloadShaders() const;

      virtual void releaseGLObjects(osg::State* state) const;

      virtual void processDofs(const DtIndirectViewParameters& viewParameters, const DtGlBuffer* gpuInputPerGeomInstancesBuffer, const DtGlBuffer* gpuMaterialsBuffer, const osg::Camera* camera);

      virtual const DtGlBuffer* gpuDofTransformBuffer(const osg::Camera* camera) const;

      virtual const DtGlBuffer* gpuDofModelScaleBuffer(const osg::Camera* camera) const;

   protected:

      virtual void addDof(int perGeomInstanceIndex, const NodeDofInfoPair& dofChildPair, int instanceId, int baseParentDofIndex, const int dofInfoId
         , const float modelScale
         , const float modelRadius);

      virtual void updateAnimatingDofs(const osg::FrameStamp* frameStamp);

      virtual void deleteBuffers(void);

      virtual void tearDownBuffers(void) const;

      virtual void updateDofBuffersIfNecessary();

      
      virtual void updateDofs();

      virtual bool findDofInfoIndex(osgSim::DOFTransform* clone, osgSim::DOFTransform* master, int instanceId
         , int& infoIdx);

      virtual DtIndirectAnimatingDof* findOrCreateAnimatingDof(int infoIdx, osgSim::DOFTransform* dof);

      virtual void printInfo();

      virtual void flushCameraSpecificBuffers(void);

      virtual void createCameraSpecificBuffersIfNeeded(const osg::Camera* camera);
   
      virtual void flushCameraSpecificBuffersInMap(std::map<osg::observer_ptr<const osg::Camera>, DtGlBuffer*>& mapToEraseFrom);
   protected:

      bool myPureSignalBasedDofs;

      mutable DtIndirectDofProgram * myMutableDofProgram;

      mutable DtIndirectClearBufferProgram* myMutableBufferClearProgram;

      DtGlBuffer* myGpuDofInfoBuffer;

      typedef std::map<osg::observer_ptr<const osg::Camera>, DtGlBuffer*> CameraToBufferMap;

      CameraToBufferMap myGpuDofTransformBufferMap;

      CameraToBufferMap myGpuDofModelScaleBufferMap;

      mutable bool myMutableDofInfoDirty;

      unsigned int myMaxPerGeomInstanceId;

      MapNodeToMapInstanceIdToDofInfoIndex myMapNodeToMapInstanceIdToDofInfoIndex;

      struct IndirectDofInfoInvalidator
      {
      public:
         void operator()(IndirectDofInfo& info);
      };

      struct IndirectDofInfoRemovalPredicate
      {
      public:
         IndirectDofInfoRemovalPredicate(int instanceIdToRemove);
         bool operator()(const IndirectDofInfo& info) const;
         const int myInstanceIdToRemove;
      };

      typedef DtReusableMemoryVector<IndirectDofInfo, IndirectDofInfoInvalidator, IndirectDofInfoRemovalPredicate> VectorIndirectDofInfos;
      VectorIndirectDofInfos myVectorIndirectDofInfos;

      std::unordered_map<int, int> myInstanceToXformBaseIndex;

      MapInfoIdxToAnimatingDof myAnimatingDofs;

      DtGlDeleteObjectManager& myGlDeleteObjectManager;
   };

}