vreSensorInfoManager.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreSensorInfoManager.h
//! \ingroup vreSensorInfoManager
//! \brief Sensor information manager for VREngage
//!
//! This file defines the DtVreSensorInfoManager class, which manages information
//! from various sensor types in the VREngage environment, including radar systems.
//! It processes sensor data and provides access to sensor information for simulation
//! entities.
 
#pragma once
 
#include "export.h"
#include <vrfGuiCore/vrfSensorInfoManager.h>
 
namespace makVre
{
//! \brief Sensor information manager for VREngage
//!
//! This class manages information from various sensors in the VREngage environment.
//! It processes radar data and other sensor information, and provides mechanisms
//! for starting and stopping the monitoring of sensor data for specific entities.
class VRESENSORINFOMANAGER_DLL DtVreSensorInfoManager : public makVrf::DtVrfSensorInfoManager
{
public:
   //! \brief Constructor
   //! \param de The document environment providing access to application resources
   //!
   //! Initializes a new sensor information manager with the specified document environment.
   DtVreSensorInfoManager(makVrv::DtDe& de);
 
   //! \brief Destructor
   //!
   //! Cleans up resources used by the sensor information manager.
   virtual ~DtVreSensorInfoManager();
 
protected:
   //! \brief Processes radar data message
   //! \param msg The simulation message containing radar data
   //!
   //! Processes a simulation message containing radar data and updates
   //! the internal radar information state.
   virtual void processRadarData(DtSimMessage* msg);
 
   //! \brief Starts monitoring sensor information for an entity
   //! \param entityId The UUID of the entity to monitor
   //! \return Map of sensor information for the entity
   //!
   //! Starts monitoring sensor information for the specified entity and
   //! returns the current sensor information map. This includes radar,
   //! infrared, and other sensor data associated with the entity.
   virtual DtVrfSensorInfoManager::DtSensorInformationMap startMonitoring(const DtUUID& entityId) override;
 
   //! \brief Stops monitoring sensor information for an entity
   //! \param entityId The UUID of the entity to stop monitoring
   //! \return True if monitoring was successfully stopped, false otherwise
   //!
   //! Stops monitoring sensor information for the specified entity and
   //! cleans up any associated resources.
   virtual bool stopMonitoring(const DtUUID& entityId) override;
};
} // namespace makVre