friendlyUnitsConnector.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file friendlyUnitsConnector.h
//! \brief Defines the DtFriendlyUnitsConnector class for tracking friendly units
//!
//! This connector tracks entities and aggregates with the same force ID as the player's
//! entity and provides updates when the set of friendly units changes.
 
#pragma once
 
#include "export.h"
 
#include "vrePlayerStationConnector/simEventConnector.h"
 
//! \brief Forward declaration of the exercise connection class
class DtExerciseConn;
 
//! \brief Forward declaration of the reflected entity class
class DtReflectedEntity;
 
//! \brief Forward declaration of the reflected aggregate class
class DtReflectedAggregate;
 
//! \brief Forward declaration of the reflected entity list class
class DtReflectedEntityList;
 
//! \brief Forward declaration of the reflected aggregate list class
class DtReflectedAggregateList;
 
namespace makVre
{
//! \brief Connector for tracking and reporting friendly units in the simulation
//!
//! DtFriendlyUnitsConnector monitors entities and aggregates that have the same
//! force ID as the player's entity. It maintains an alphabetically sorted list
//! of friendly unit names and sends updates when the list changes.
class VRL_DLL DtFriendlyUnitsConnector : public DT_PROTOCOL_NAMESPACE::DtSimEventConnector
{
public:
   //! \brief Default constructor
   //!
   //! Initializes member variables with default values and sets the connector name to "FriendlyUnitsTime"
   DtFriendlyUnitsConnector();
 
   //! \brief Virtual destructor
   virtual ~DtFriendlyUnitsConnector() override;
 
   //! \brief Installs the friendly units 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 callbacks for entity and aggregate addition/removal and retrieves the
   //! player's entity ID and reflected entity list
   virtual void install(
      DtPlayerStationApp* app, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection* connection) override;
 
   //! \brief Performs periodic checking of friendly units
   //!
   //! Determines the player's force ID if not yet known and updates the
   //! friendly units list if changes have been detected
   virtual void tick() override;
 
   //! \brief Shuts down the friendly units connector
   //!
   //! Removes entity and aggregate callbacks and cleans up resources
   virtual void shutdown() override;
 
   //! \brief Handles changes to the entity list
   //! \param ent Pointer to the entity that was added or removed
   //!
   //! Called when an entity is added to or removed from the reflected entity list
   //! Sets the update flag to trigger a refresh of the friendly units list
   virtual void handleEntityListChanged(DtReflectedEntity* ent);
 
   //! \brief Handles changes to the aggregate list
   //! \param agg Pointer to the aggregate that was added or removed
   //!
   //! Called when an aggregate is added to or removed from the reflected aggregate list
   //! Sets the update flag to trigger a refresh of the friendly units list
   virtual void handleAggregateListChanged(DtReflectedAggregate* agg);
 
protected:
   //! \brief Updates the list of friendly unit names and sends a message
   //!
   //! Collects all entities and aggregates with the same force ID as the player,
   //! sorts them alphabetically, and sends an EntityFriendlyUnitsMessage with the results
   void updateNames();
 
   //! \brief Force ID of the player's entity
   //!
   //! Used to identify which entities and aggregates are friendly
   DtForceType myForceId;
 
   //! \brief Entity ID of the player's entity
   DtEntityIdentifier myEntityId;
 
   //! \brief Pointer to the reflected entity list
   DtReflectedEntityList* myRel;
 
   //! \brief Pointer to the reflected aggregate list
   //!
   //! This is created and owned by the connector, not just referenced
   DtReflectedAggregateList* myRal;
 
   //! \brief Flag indicating whether an update is needed
   //!
   //! Set to true when entities or aggregates are added or removed
   bool myUpdateNeeded;
};
} // namespace makVre