sarUtilities.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (c) 2025 MAK Technologies
 * All rights reserved.
 *****************************************************************************/
 
//! \file sarUtilities.h
//! \brief Provides utility functions for SAR functionality
//! \ingroup sarClient
 
#pragma once
 
#include "vrePilotSarClient/sarClientPlugin.h"
 
#include <vreRadarFxShared/rfxSarMessage.h>
 
namespace makRadarFx
{
//! \brief Forward declaration of the SAR request class
class DtSarRequest;
} // namespace makRadarFx
 
namespace makVrv
{
//! \brief Forward declaration of the channel class
class DtChannel;
 
//! \brief Forward declaration of the observer class
class DtObserver;
 
class DtDe;
} // namespace makVrv
 
//! \name Display Element Access Functions
//! @{
 
//! \brief Sets the display element pointer used by the plugin
//! \param aDe Pointer to the display element
//!
//! Stores the display element pointer for use by other plugin components
void DT_DLL_sarClient setDe(makVrv::DtDe* aDe);
 
//! \brief Gets the display element pointer used by the plugin
//! \return Pointer to the current display element
//!
//! Retrieves the stored display element pointer
makVrv::DtDe* de();
 
//! @}
 
//! \name RadarFx Interaction Functions
//! @{
 
//! \brief Initializes the RadarFx connector system
//! \param de Pointer to the display element
//! \return True if initialization was successful, false otherwise
//!
//! Initializes the RadarFx connector component, installs the DtRadarFxConnectorTicker
//! to get it updated every frame, and registers message handlers for SAR messages.
//! This function must be called before any other RFX-related functions.
bool DT_DLL_sarClient initializeRadarFx(makVrv::DtDe* de);
 
//! \brief Resets the connection to the RadarFx server
//!
//! Disconnects from the current RadarFx server connection and attempts to reconnect
void DT_DLL_sarClient resetRfxServerConnection();
 
//! \brief Sends a SAR request to the RadarFx server
//!
//! Constructs a request based on current settings and sends it to the server
void DT_DLL_sarClient sendSarRequest();
 
//! \brief Prints the SAR request details to the console
//! \param request Reference to the SAR request to print
//!
//! Outputs detailed information about the SAR request for debugging purposes
void DT_DLL_sarClient printSarRequest(makRadarFx::DtSarRequest& request);
 
//! \brief Gets the filename for the current SAR capture
//! \return String containing the SAR capture filename
//!
//! Generates or retrieves the filename where the current SAR image is saved
std::string DT_DLL_sarClient captureFilename();
 
//! @}
 
//! \name Coordinate and Observer Helper Functions
//! @{
 
//! \brief Converts a local coordinate into geodetic coordinates in degrees
//! \param local Local coordinate vector to convert
//! \return Geodetic coordinate vector (latitude, longitude, altitude) in degrees
//!
//! Transforms a local coordinate from the simulation into a geodetic coordinate
//! with latitude and longitude in degrees and altitude in meters
DtVector DT_DLL_sarClient localToGeodeticInDegrees(const DtVector& local);
 
//! \brief Finds the first channel for a given observer
//! \param observer Pointer to the observer to find a channel for
//! \return Pointer to the first channel found, or nullptr if none exists
//!
//! Searches for and returns the first render channel associated with the given observer
makVrv::DtChannel* firstChannelForObserver(makVrv::DtObserver* observer);
 
//! @}