surfaceToVxMaterialMapper.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2024 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file    surfaceToVxMaterialMapper.h
//! \brief   Provides mapping functionality between VR-Forces terrain surface types and Vortex physics materials
//! \ingroup vreVrfVortex
 
#pragma once
 
#include "vreVrfVortex/export.h"
 
#include <geometry/surface.h>
 
namespace Vx
{
class VxMaterial;
class VxMaterialTable;
} // namespace Vx
 
namespace makVre
{
//! \brief Structure that holds information about a Vortex surface material mapping
//!
//! Stores the Vortex material associated with a terrain surface type as well as
//! various flags that control how the surface is handled in the physics simulation.
struct VREVRFVORTEX_DLL VortexSurfaceInfo
{
   //! \brief Default constructor
   //!
   //! Initializes a surface info with no material and all flags set to false.
   VortexSurfaceInfo()
      : material(nullptr)
      , isFiltered(false)
      , shouldUseRoughnessMap(false)
      , isUsingDefault(false)
   {
   }
 
   Vx::VxMaterial* material;       //!< Pointer to the Vortex material
   bool isFiltered;                //!< Flag indicating if this surface should be filtered out in triangle generation
   bool shouldUseRoughnessMap;     //!< Flag indicating if roughness mapping should be used for this surface
   bool isUsingDefault;            //!< Flag indicating if this surface is using the default material
   std::string surfaceTypeString;  //!< String representation of the surface type
   std::string surfaceTypeMapping; //!< The material mapping string from configuration
};
 
//! \brief Class for mapping VR-Forces terrain surface types to Vortex physics materials
//!
//! This class provides the functionality to translate between VR-Forces terrain surface types
//! (soil, water, cultural features, etc.) and Vortex physics materials. It maintains lookup
//! tables for different surface type categories and provides methods to retrieve the appropriate
//! Vortex material for a given surface.
class VREVRFVORTEX_DLL DtSurfaceToVxMaterialMapper
{
public:
   //! \brief Default constructor
   //!
   //! Initializes an empty material mapper with no default material.
   DtSurfaceToVxMaterialMapper();
 
   //! \brief Destructor
   //!
   //! Cleans up all allocated surface info objects in the mapping tables.
   virtual ~DtSurfaceToVxMaterialMapper();
 
   //! \brief Initialize the material mapper with a Vortex material table
   //!
   //! Sets up the mapping between VR-Forces surface types and Vortex materials
   //! based on configuration settings in vortexConfig.lua. This includes setting
   //! up the default material, material mapping tables, and filter lists.
   //!
   //! \param val Pointer to the Vortex material table containing available materials
   virtual void init(const Vx::VxMaterialTable* val);
 
   //! \brief Get the Vortex material for a specific terrain surface
   //!
   //! Determines the appropriate Vortex material based on the surface type.
   //! For water surfaces, it uses the body of water type mapping.
   //! For cultural features, it uses the cultural feature type mapping.
   //! For ground or flimsy surfaces, it uses the soil type mapping.
   //! Otherwise, it uses the roughness soil type mapping.
   //!
   //! \param surf The terrain surface to get the material for
   //! \return Pointer to the corresponding Vortex material
   Vx::VxMaterial* getVortexMaterial(const DtSurface& surf);
 
   //! \brief Get the default Vortex material
   //!
   //! Returns the default material that is used when a specific mapping
   //! is not found or when explicitly configured to use the default.
   //!
   //! \return Pointer to the default Vortex material
   Vx::VxMaterial* getDefaultVortexMaterial();
 
   //! \brief Check if a surface should be filtered out
   //!
   //! Determines if a given surface should be excluded from triangle generation
   //! based on configuration settings.
   //!
   //! \param surf The terrain surface to check
   //! \return True if the surface should be filtered out, false otherwise
   bool isFiltered(const DtSurface& surf);
 
   //! \brief Get the surface info for a specific terrain surface
   //!
   //! Retrieves the VortexSurfaceInfo object containing material and flags
   //! for the given terrain surface. The appropriate info is selected based on
   //! the surface type (water, cultural feature, ground, or roughness).
   //!
   //! \param surf The terrain surface to get the info for
   //! \return Pointer to the corresponding VortexSurfaceInfo
   VortexSurfaceInfo* getSurfaceInfo(const DtSurface& surf) const;
 
protected:
   Vx::VxMaterial* myDefaultMaterial; //!< The default Vortex material to use when no specific mapping is found
 
   std::vector<VortexSurfaceInfo*> mySoilTypeToMaterialMap; //!< Mapping from soil types to Vortex materials
   std::vector<VortexSurfaceInfo*>
      myBodyOfWaterTypeToMaterialMap;                       //!< Mapping from body of water types to Vortex materials
   std::vector<VortexSurfaceInfo*>
      myCulturalFeatureTypeToMaterialMap;                   //!< Mapping from cultural feature types to Vortex materials
   std::vector<VortexSurfaceInfo*>
      myRoughnessSoilTypeToMaterialMap;                     //!< Mapping from roughness soil types to Vortex materials
};
} // namespace makVre