vreRtdTraitTerrainQuery.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreRtdTraitTerrainQuery.h
//! \ingroup vreVrfRtd
//! \brief Terrain query trait for VREngage RTD components
//!
//! This file defines the DtVreRtdTraitTerrainQuery class, which provides common
//! functionality for terrain query operations in the VREngage RTD system.
//! It allows components to query terrain elevation and features in a unified way.
 
#pragma once
 
#include <vreVrfRtd/vreRtdBackendLibCommon.h>
 
namespace vreRtd
{
//! \brief Terrain query trait for VREngage RTD components
//!
//! This class provides common functionality for terrain query operations
//! in the VREngage RTD system. It allows components to query terrain elevation
//! and features with configurable behavior, such as enabling or disabling
//! terrain checks. This trait is used by various RTD components that need
//! to interact with the terrain.
class RTD_VRF_BACKEND_PLUGIN_EXPORT DtVreRtdTraitTerrainQuery
{
public:
   //! \brief Constructor
   //!
   //! Initializes a new terrain query trait with terrain checking enabled
   //! by default.
   DtVreRtdTraitTerrainQuery()
      : myCheckTerrain(true)
   {
   }
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the terrain query trait.
   virtual ~DtVreRtdTraitTerrainQuery() {}
 
   //! \brief Sets whether terrain should be checked
   //! \param status True to enable terrain checking, false to disable
   //!
   //! Enables or disables terrain checking for this trait. When disabled,
   //! terrain queries may return default values or simplified results
   //! instead of performing actual terrain intersection tests.
   void setCheckTerrain(bool status);
 
protected:
   //! \brief Pointer to the physical world to query against
   //!
   //! The physical world represents the terrain database and other physical
   //! entities that can be queried for intersections.
   DtPhysicalWorld* myPhysicalWorld;
 
   //! \brief Flag indicating whether terrain checking is enabled
   //!
   //! When true, terrain queries will check against the actual terrain database.
   //! When false, they may return simplified results or default values.
   bool myCheckTerrain;
};
} // namespace vreRtd