DtModel.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtUniqueID.h>

#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/signalslib.h>

#include <matrix/vlVector.h>
#include <matrix/vlTaitBryan.h>


namespace makVrv
{
   class DtDe;
   class DtModelInstance;
   class DtModelDefinition;
   struct DtLoaderHandle;
   enum class DtModelSetId;

   // Struct which performances a boolean OR on all slot return values.
   struct SlotReturnOR
   {
      typedef bool result_type;
      template<typename InputIterator>
      bool operator()(InputIterator first, InputIterator last) const
      {
         bool result = false;
         while (first != last)
         {
            result |= *first++;
         }
         return result;
      }
   };

   class DT_DLL_VRVCORE DtModel 
   {
   public:

      DtModel(DtDe& de, DtUniqueID id);

      virtual ~DtModel();

      DtModelInstance* createModelInstance(const std::string& modelDefName, bool realize = true);

      virtual void setModelDefinition(const std::string& str);
      virtual const std::string& modelDefinitionName() { return myModelDefinitionName; }

      //Save the model's loaded notes to a file.
      virtual void saveModelToFile(const std::string& filename);

      virtual const std::string& className() const;

      virtual DtModelInstance* modelInstance();
      virtual const DtModelInstance* modelInstance() const;

      virtual DtUniqueID uniqueId() const;

      unsigned int transformSize() const;

      virtual void setPosition(int vtx, const DtVector& position);

      virtual const DtVector& position(int vtx = 0) const;

      virtual void removePosition(int vtx);

      virtual void setPositionOffset(const DtVector& positionOffset);

      virtual const DtVector& positionOffset() const;

      virtual void setOrientation( int vtx, const DtTaitBryan& orientation );

      virtual void setPositionAndOrientation(int vtx, const DtVector& positionOffset, const DtTaitBryan& orientation);

      virtual const DtTaitBryan& orientation(int vtx = 0) const;

      virtual void setOrientationOffset(const DtTaitBryan& orientationOffset);

      virtual const DtTaitBryan& orientationOffset() const;

      virtual void enableColorBlending( bool b );

      virtual void setBlendColor( float r, float g, float b, float a );

      virtual void getBlendColor( float& r, float& g, float& b, float& a);

      virtual bool colorBlendingEnabled() const;

      virtual void setColor(float r, float g, float b, float a);

      virtual void enableLighting( bool l );

      virtual DtModelSetId modelSet() const;

      const DtVector& boundingBoxExtents() const;

      void getBoundingBoxExtents(double& x, double& y, double& z) const;

      const DtVector& boundingBoxCenter() const;

      virtual void getBoundingBoxCenter(double& x, double& y, double& z) const;

      virtual void getBoundingBoxComponents( DtVector& minimum, DtVector& maximum );

      void setContributesToBound( bool trueOrFalse );

      bool contributesToBound() const;

      int visualizerType() const;

      inline DtDe& de() { return myDe;}

      virtual void setModelInstance(DtModelInstance* modelInstance );

      virtual void promoteBackgroundModelInstance(const DtModelDefinition& defintion);

      virtual void setVisible(bool isVisible);

      virtual bool visible() const;

      DtUniqueID sceneObjectId() const;

      virtual void addedToSceneObjectAsProp( const DtUniqueID& sceneObj );

      virtual void addedToSceneObject( const DtUniqueID& sceneObj, DtModelSetId modelSet,
         int visualizerType );

      virtual void setElementId(DtElementID id);

      virtual void removedFromSceneObject();

      virtual void setIsSupportModel(bool isSupport) = 0;

      virtual void setSolid(bool isSolid);

      virtual bool isProp();

      boost::signalslib::signal<void (DtModel*)> signal_modelToBeDestroyed;
      boost::signalslib::signal<void (DtModel*)> signal_modelChanged;

      boost::signalslib::signal<bool (DtModel*,bool ), SlotReturnOR> signal_visibilityChangeRequested;

      boost::signalslib::signal<void (DtModelInstance*, DtModel*)> signal_modelInstanceCreated;

      boost::signalslib::signal<void (DtModelInstance*, DtModel*)> signal_modelInstanceToBeDestroyed;


      virtual bool supportsMultithreadedLoad() { return false; }

      virtual void backgroundLoad() { ; }

      virtual void foregroundLoad() { ; }

      virtual bool isActivelyBackgroundLoading();

      virtual DtLoaderHandle* getLoadQueueHandle();

      virtual void updateMinLastFrameDistance(float distance);

      virtual void resetLastFrameDistance();

      virtual float minLastFrameDistance() const;

   protected:

      virtual void addToScene( const DtUniqueID& sceneObjectId,
         DtModelSetId modelSet, int visualizerType ) = 0;

      virtual void addToSceneAsProp( const DtUniqueID& sceneObjectId ) {}

      virtual void removeFromScene() = 0;

      virtual void initializeModelInstance();

      void  slot_modelInstanceChanged( DtModelInstance* instance );


   protected:
      virtual void waitAndClearLoadHandle();
      virtual void removedFromLoadQueue();
      virtual void setDoneBackgroundLoading();
      virtual void setActivelyBackgroundLoading();

      friend class DtBackgroundLoader;
      friend class DtBackgroundLoadAsyncTask;
      DtLoaderHandle * myInLoadQueueHandle;

      static bool theInittedState;

   protected:
      struct ObjectTransform
      {
         DtVector position;
         DtTaitBryan orientation;
      };

      typedef std::vector<ObjectTransform> TransformList;

      DtDe& myDe;

      const DtUniqueID myUniqueId;

      // The ID of the element this model is associated with
      DtUniqueID myElementId;

      // The ID of the scene object this model is associated with
      DtUniqueID myParentSceneObjectID;

      bool myColorBlendingEnabled;

      DtModelInstance* myBackgroundModelInstance;
     
      float myMinLastFrameDistance;

   private:
      void deleteModelInstance();

   protected:

      TransformList myTransforms;
      DtModelInstance* myModelInstance;
      DtModelSetId myModelSet;
      int myVisualizerType;
      bool myContributesToBound;
      bool myIsPropFlag;
      float myBlendColor[4];
      bool myVisibleFlag;
      DtVector myPositionOffset;
      DtTaitBryan myOrientationOffset;
      std::string myModelDefinitionName;

      bool myRequireModelInstance = true;
   };

   class DT_DLL_VRVCORE DtModelSignaler : public DtVirtualBaseClass
   {
   public:
      static DtModelSignaler& instance(DtDe&);

      virtual ~DtModelSignaler();

      boost::signalslib::signal<void (DtModelInstance&)> signal_modelCreated;

      boost::signalslib::signal<void (DtModelInstance&)> signal_modelChanged;

      boost::signalslib::signal<void (DtModelInstance&)> signal_modelToBeDestroyed;

   protected:

      DtModelSignaler();

   private: 
      DtModelSignaler(const DtModelSignaler&);
      DtModelSignaler& operator=(const DtModelSignaler&);
   };
}