commentConnector.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2024 MAK Technologies
** All rights reserved.
******************************************************************************/
 
#pragma once
 
#include "vrePlayerStationConnector/simEventConnector.h"
#include "vreMessageManager/vreMessage.h"
 
#include <vl/commentInteraction.h>
 
namespace makVre
{
//! Connector that bridges DIS/HLA Comment PDUs or interactions to internal
//! CommentMessage traffic and vice versa.
//!
//! DtCommentConnector registers a VR-Link callback for incoming
//! DtCommentInteraction objects and forwards relevant messages into the
//! VR-Engage message system. It also listens for internal CommentMessage
//! instances originating from the local player and transmits them as
//! Comment interactions on the exercise connection.
class DtCommentConnector : public DT_PROTOCOL_NAMESPACE::DtSimEventConnector
{
public:
   //! Constructs a connector with no associated player entity identifier.
   DtCommentConnector();
 
   //! Virtual destructor to support polymorphic deletion.
   virtual ~DtCommentConnector() override;
 
   //! Installs the connector with the given player station application and
   //! VR-Link connection, determines the local entity identifier, and
   //! registers network and message callbacks.
   virtual void install(DtPlayerStationApp* app,
      makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection* connection) override;
 
   //! Per-frame update hook. The example does not require periodic work but
   //! keeps the standard connector interface.
   virtual void tick() override;
 
   //! Removes network and message callbacks and releases connector resources.
   virtual void shutdown() override;
 
   //! Handles an incoming Comment interaction from the exercise connection
   //! and, when addressed to the local entity, converts it into an internal
   //! CommentMessage queued on the message manager.
   virtual void handleCommentInteraction(DtCommentInteraction* comment);
 
   //! Handles an internal CommentMessage and, when sent by the local entity,
   //! constructs and transmits a corresponding Comment interaction on the
   //! exercise connection.
   virtual DtVreMessageResult handleCommentMessage(DtVreMessage* msg);
 
protected:
   //! DIS/HLA entity identifier for the local player station entity.
   DtEntityIdentifier myEntityId;
};
} // namespace makVre