DtModelInstance.h

Go to the documentation of this file.

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


#pragma once

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

#include <vrvMath/DtVector4.h>

#include <string>
#include <vector>

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

#include <vrvUtil/signalslib.h>

namespace makVrv
{
   class DtModelDefinition;
   class DtDe;

   class DT_DLL_VRVCORE DtModelInstance
   {
   public:

      DtModelInstance(DtDe& de);

      virtual ~DtModelInstance();

      virtual bool realize(const DtModelDefinition& definition);

      virtual bool cloneInstance(const DtModelDefinition& definition);

      const std::string& realizedDefinitionName() const;

      virtual bool saveModelToFile(const std::string& filename) const;

      const DtVector& boundingBoxExtents() const;

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

      const DtVector& boundingBoxCenter() const;

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

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

      
      const DtVector& allGeometryboundingBoxExtents() const;
      void getAllGeometryBoundingBoxExtents(double& x, double& y, double& z) const;
      const DtVector& allGeometryboundingBoxCenter() const;
      void getAllGeometryBoundingBoxCenter(double& x, double& y, double& z) const;
      void getAllGeometryBoundingBoxComponents(DtVector& minimum, DtVector& maximum);
      
      virtual void setContributesToBound( bool trueOrFalse );

      bool contributesToBound() const;

      virtual void setVisible(bool isVisible) = 0;

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

      virtual void enableColorBlending( bool b );

      //Utility function for reading a float from a definition.
      static float readFloat(const std::string& paramName, const DtModelDefinition& definition);

      //Utility function for reading a 3 value Vector from a definition.
      static DtVector readVector(const std::string& paramName, const DtModelDefinition& definition);
      
      //Utility function for reading a 4 floating point value Vector from a definition.
      static DtVector4<float> readVector4(const std::string& paramName, const DtModelDefinition& definition);

      boost::signalslib::signal<void (DtModelInstance*)> signal_modelInstanceChanged;

   protected:

      DtDe& myDe;
      std::string myRealizedModelDefinitionName;
      DtVector myBoundingBoxCenter;
      DtVector myBoundingBoxExtents;
      DtVector myBoundingBoxMinimum;
      DtVector myBoundingBoxMaximum;

      //We need the full size of the geometry with all switches active to get a max bounds for instancing.
      DtVector myAllGeometryBoundingBoxCenter;
      DtVector myAllGeometryBoundingBoxExtents;
      DtVector myAllGeometryBoundingBoxMinimum;
      DtVector myAllGeometryBoundingBoxMaximum;

      bool myContributesToBound;

      //Note about myColorBlendingEnabled: If this particular model has instancing enabled then this flag is set to false
      // and color blending is handled by the instance manager.
      bool myColorBlendingEnabled;
      float myBlendRed;
      float myBlendBlue;
      float myBlendGreen;
      float myBlendAlpha;

   };

   class DT_DLL_VRVCORE DtModelInstanceCreator : public DtVirtualBaseClass
   {
   public:

      virtual ~DtModelInstanceCreator();

      virtual DtModelInstance* create(DtDe& de) = 0;

   protected:

      DtModelInstanceCreator();
   };

}