vortexPagedTerrainExtension.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2024 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file    vortexPagedTerrainExtension.h
//! \brief   Extension for integrating paged terrain into the Vortex physics engine
//! \ingroup vreVrfVortex
 
#pragma once
 
#include <vreVrfVortex/export.h>
 
#include <VxSim/IDynamics.h>
#include <VxSim/IExtension.h>
#include <VxSim/IApplicationListener.h>
 
class DtTerrainImplementation;
 
namespace Vx
{
class VxUniverse;
}
 
namespace VxSim
{
class VxPluginExtension;
}
 
namespace VxTerrain
{
class VxPagedTerrainProducer;
class VxSpatialForecaster;
class VxPagedTerrainInterface;
} // namespace VxTerrain
 
//! \brief Extension that integrates VR-Forces terrain with the Vortex physics engine
//!
//! This extension manages the paged terrain system in Vortex, creating and destroying
//! the terrain producer and interface as needed during application mode changes.
//! It handles efficient terrain collision geometry generation for physics simulation.
class VREVRFVORTEX_DLL DtVortexPagedTerrainExtension : public VxSim::IDynamics,
                                                       public VxSim::IExtension,
                                                       public VxSim::IApplicationListener
{
public:
   //! \brief Constructor
   //!
   //! Creates a new terrain extension with the given proxy.
   //!
   //! \param iProxy The extension proxy to associate with
   DtVortexPagedTerrainExtension(VxSim::VxExtension* iProxy);
 
   //! \brief Destructor
   //!
   //! Cleans up terrain producer and related resources.
   virtual ~DtVortexPagedTerrainExtension() override;
 
   //! \brief Handles application mode changes
   //!
   //! Called at the beginning of the update loop before the new mode is actually set.
   //! Used for creating and deleting the terrain producer:
   //! - Creates when previous == editing && next == simulating
   //! - Deletes when previous == simulating && next == editing
   //! - Does nothing otherwise
   //!
   //! \param previous Previous application mode
   //! \param next Next application mode
   virtual void onApplicationModeChange(VxSim::eApplicationMode previous, VxSim::eApplicationMode next) override;
 
protected:
   //! \brief Creates the terrain producer and adds it to the universe
   //!
   //! The terrain producer's responsibility is to feed the Vortex collision detection
   //! with parts and collision geometries that represent the terrain. It performs
   //! queries on a terrain database via the paged terrain interface in regions where
   //! terrain collision representations are required by the physics simulation.
   //!
   //! Also creates the paged terrain interface (DtVortexPagedTerrain) which answers these
   //! queries and creates the requested collision geometries from the terrain database.
   //!
   //! \param universe The Vortex universe to add the producer to
   void createTerrainProducer(Vx::VxUniverse* universe);
 
   //! \brief Deletes the terrain producer and related resources
   //!
   //! Removes the terrain producer and interface from the universe and cleans up resources.
   //!
   //! \param universe The Vortex universe containing the producer
   void deleteTerrainProducer(Vx::VxUniverse* universe);
 
protected:
   VxTerrain::VxPagedTerrainProducer* myTerrainProducer; //!< Terrain producer for generating collision geometries
   VxTerrain::VxPagedTerrainInterface* myTerrainSource;  //!< Interface for accessing terrain data
   VxTerrain::VxSpatialForecaster* myForecaster;         //!< Forecaster for predicting needed terrain areas
};