updateVisualsConnector.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file updateVisualsConnector.h
//! \brief Defines the DtUpdateVisualsConnector class for handling visual model updates
//!
//! Class DtUpdateVisualsConnector is an event connector that handles
//! VisualsLoaded events. These are events indicating that the visual
//! definition/mapping data associated with a simulation model set (SMS) has
//! been loaded. In response to such events, it recreates the DtVrlinkElement
//! objects (entities, aggregates, and tactical graphics), based on the updated
//! visual model definition data. This happens any time the visual
//! definition/mapping data associated with an SMS changes (i.e., when a different
//! SMS with visual definition/mapping data gets loaded).
 
#pragma once
 
#include "export.h"
 
#include "vrePlayerStationConnector/simEventConnector.h"
 
#include "vreMessageManager/vreMessage.h"
 
namespace makVre
{
//! \brief Connector for handling visual model definition updates
//!
//! DtUpdateVisualsConnector responds to visual model definition changes by
//! recreating and updating DtVrlinkElement objects to reflect the new visual
//! definitions. It handles entities, aggregates, and tactical graphics,
//! ensuring they use the latest visual model definitions from the current
//! simulation model set (SMS).
class VRL_DLL DtUpdateVisualsConnector : public DT_PROTOCOL_NAMESPACE::DtSimEventConnector
{
public:
   //! \brief Default constructor
   //!
   //! Initializes the connector with name "UpdateVisuals"
   DtUpdateVisualsConnector();
 
   //! \brief Virtual destructor
   virtual ~DtUpdateVisualsConnector() override;
 
   //! \brief Installs the visual update connector with the application and connection
   //! \param app Pointer to the player station application
   //! \param connection Pointer to the protocol-specific VR-Link connection
   //!
   //! Registers message handlers for VisualModelDefinitionsLoadedMessage messages
   virtual void install(DtPlayerStationApp* app, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection* connection) override;
 
   //! \brief Performs periodic processing of entity reparenting
   //!
   //! Handles re-parenting of embarked entities that were discovered during SMS reload
   //! by attempting to re-establish parent-child relationships over several ticks
   virtual void tick() override;
 
   //! \brief Shuts down the visual update connector
   //!
   //! Removes message handlers for visual model definition updates
   virtual void shutdown() override;
 
protected:
   //! \brief Map of entities that need to be reparented
   //!
   //! Map of entity global designators to their parent entity global designators
   //! Used to track entities that need to be reparented after SMS reload
   std::map<DtGlobalObjectDesignator, DtGlobalObjectDesignator> myEntitiesToReparent;
 
   //! \brief Counter for reparenting attempts
   //!
   //! Number of ticks remaining to attempt reparenting of entities
   //! When this reaches zero, any remaining entities will have warning messages logged
   int myTicksToReparent;
 
   //! \brief Handles visual model definition loaded messages
   //! \param msg Pointer to the visual model definitions loaded message
   //! \return Message result indicating how the message was handled
   //!
   //! Updates all visual DtVrlinkElements (entities, aggregates, tactical graphics)
   //! with the latest visual model definitions/mappings. For each element, it disables
   //! and re-enables the model sets, updates the element definition, and then
   //! re-visualizes the element using the new definitions.
   virtual makVre::DtVreMessageResult handleVisualModelDefinitionsLoaded(makVre::DtVreMessage* msg);
 
   //! \brief Handles SMS load complete messages
   //! \param msg Pointer to the SMS load complete message
   //! \return Message result indicating how the message was handled
   //!
   //! Sets up the reparenting process after SMS reload by initializing the
   //! myTicksToReparent counter and removing the handler since it's only needed once per reload
   virtual makVre::DtVreMessageResult handleSmsLoadComplete(makVre::DtVreMessage* msg);
};
} // namespace makVre