glstudioSarFilenameUpdater.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file glstudioSarFilenameUpdater.h
//! \brief Defines the GLStudio updater for SAR image filenames
//! \ingroup sarClient
 
 
#pragma once
 
#include "sarClientPlugin.h"
 
#include <vrvGlStudioShared/DtGlStudioObjectAttributeUpdater.h>
 
//! \brief Updates SAR image filename for GLStudio displays
//!
//! This class provides a GLStudio attribute updater that supplies the
//! current Synthetic Aperture Radar (SAR) image filename to GLStudio elements.
//! It allows GLStudio displays to show the latest captured SAR image.
//! \ingroup sarClient
class DT_DLL_sarClient DtGlStudioSarFilenameUpdater : public makVrv::DtGlStudioObjectAttributeUpdater
{
public:
   //! \brief Default constructor
   DtGlStudioSarFilenameUpdater();
 
   //! \brief Virtual destructor
   virtual ~DtGlStudioSarFilenameUpdater() override;
 
   //! \brief Checks if the filename has been updated
   //! \return True if the filename has changed, false otherwise
   virtual bool isDirty() override;
 
   //! \brief Returns the current SAR image filename
   //! \param time Current simulation time (not used)
   //! \return The current SAR image filename
   virtual std::string value(double time) override { return myFilename; }
 
protected:
   //! \brief Current SAR image filename
   //!
   //! Defaults to "../userData/radarFx/capture/default.bmp"
   std::string myFilename;
 
   //! \brief Flag indicating if this is the first tick
   bool myFirstTick;
};
 
//! \brief Creator for registering the SAR filename updater
//!
//! Factory class that creates instances of DtGlStudioSarFilenameUpdater.
//! Used to register the updater with the GLStudio attribute updater system.
//! \ingroup sarClient
class DT_DLL_sarClient DtGlStudioSARFilenameUpdaterCreator : public makVrv::DtGlStudioAttributeUpdaterCreator
{
public:
   //! \brief Default constructor
   DtGlStudioSARFilenameUpdaterCreator();
 
   //! \brief Virtual destructor
   virtual ~DtGlStudioSARFilenameUpdaterCreator() override;
 
   //! \brief Creates a new instance of the SAR filename updater
   //! \return Pointer to a newly created SAR filename updater
   virtual makVrv::DtGlStudioAttributeUpdater* create() const override;
};