VisualBakedScalarField.h

#pragma once
 
#include <ScalarFieldBake.h>
#include <cstddef>
#include <fhsim/simobject/SimObject.h>
#include <memory>
#include <string>
 
namespace environment
{
class EnvironmentProvider;
}
 
#ifdef FH_VISUALIZATION
#   include "visual/BakedFieldTexture.h"
 
#   include <OgreMaterial.h>
#endif
 
namespace environmentmodels
{
 
class VisualBakedScalarField : public SimObject
{
public:
   void FinalSetup(const double T, const double* const X, ISimObjectCreator* Creator) override;
 
   void OdeFcn(const double T, const double* const X, double* const XDot) const override;
 
protected:
   VisualBakedScalarField(std::string SimObjectName, ISimObjectCreator* Creator, int numAxes);
 
   ~VisualBakedScalarField() override;
 
   void ResolveCounts(const double extent[3], std::size_t budget, int counts[3]) const;
 
   void ValidateGridCounts(ISimObjectCreator* Creator, const int counts[3], const std::string& extentParameterName) const;
 
   [[nodiscard]] bool MaskInaccurate() const { return !m_showExtrapolated; }
 
   [[nodiscard]] environment::field::ScalarField& Field() const;
 
#ifdef FH_VISUALIZATION
   util::BakedField BakeOverBox(const util::SamplingBox& box);
 
   void CreateTextures(const util::BakedField& baked);
 
   void SwapTextures(std::unique_ptr<visual::BakedFieldTexture> textures);
 
   Ogre::MaterialPtr CloneMaterial(const Ogre::String& baseMaterialName);
 
   void ApplyMaterialSettings(double valueMin, double valueMax) const;
 
   [[nodiscard]] const Ogre::MaterialPtr& Material() const { return m_material; }
#endif
 
private:
   std::string m_fieldName; 
 
   int  m_numAxes;       
   bool m_hasSpacing;    
   bool m_hasResolution; 
 
   double m_spacing[3];    
   int    m_resolution[3]; 
 
   double m_colorRange[2];   
   double m_visibleRange[2]; 
   double m_alphaRange[2];   
 
   bool m_hasColorRange;       
   bool m_hasVisibleRange;     
   bool m_showExtrapolated;    
   bool m_visualiseAsConstant; 
 
   environment::EnvironmentProvider* m_pEnvironment; 
 
   std::shared_ptr<environment::field::ScalarField> m_field; 
 
   bool m_fieldIsThreadSafe; 
 
#ifdef FH_VISUALIZATION
   std::unique_ptr<visual::BakedFieldTexture> m_texture;  
   Ogre::MaterialPtr                          m_material; 
#endif
};
 
} // namespace environmentmodels