remoteEntityConnector.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file remoteEntityConnector.h
//! \brief Defines the DtRemoteEntityConnector class for managing remote entity properties
//!
//! This connector handles manipulation of remote entities in the simulation,
//! including visibility controls, engine sound effects, and occupant visualization.
 
#pragma once
 
#include "export.h"
 
#include "vrePlayerStationConnector/simEventConnector.h"
#include "vreMessageManager/vreMessage.h"
#include <boost/signals2.hpp>
 
//! \brief Forward declaration of the exercise connection class
class DtExerciseConn;
 
//! \brief Forward declaration of the reflected entity list class
class DtReflectedEntityList;
 
//! \brief Forward declaration of the reflected entity class
class DtReflectedEntity;
 
namespace makVrv
{
//! \brief Forward declaration of the entity element class
class DtEntityElement;
} // namespace makVrv
 
namespace makVre
{
//! \brief Connector for managing remote entity properties in the simulation
//!
//! DtRemoteEntityConnector handles requests to change properties of remote entities,
//! such as visibility state, engine sound effects, and character model visualization.
//! It works with entity elements and visualizers to modify the presentation of entities
//! in the simulation environment.
class VRL_DLL DtRemoteEntityConnector : public DT_PROTOCOL_NAMESPACE::DtSimEventConnector
{
public:
   //! \brief Default constructor
   //!
   //! Initializes the connector with name "RemoteEntity"
   DtRemoteEntityConnector();
 
   //! \brief Virtual destructor
   virtual ~DtRemoteEntityConnector() override;
 
   //! \brief Installs the remote entity 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 entity visibility, occupant visibility, and engine sounds,
   //! and connects to the element created signal to handle entity visualization issues
   virtual void install(
      DtPlayerStationApp* app, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection* connection) override;
 
   //! \brief Performs periodic processing (currently does nothing)
   virtual void tick() override;
 
   //! \brief Shuts down the remote entity connector
   //!
   //! Removes all message handlers and disconnects from the element created signal
   virtual void shutdown() override;
 
protected:
   //! \brief Handles requests to change entity visibility
   //! \param msg Pointer to the entity visibility message
   //! \return Message result indicating how the message was handled
   //!
   //! Processes SetEntityVisiblityMessage by finding the entity element and
   //! modifying its character model agent's visibility
   virtual makVre::DtVreMessageResult handleEntityVisibility(makVre::DtVreMessage* msg);
 
   //! \brief Handles requests to enable/disable entity engine sounds
   //! \param msg Pointer to the entity engine sound message
   //! \return Message result indicating how the message was handled
   //!
   //! Processes SetEntityEngineSoundEnabledMessage by finding the entity element
   //! and modifying its audio visualizer's engine sound state
   virtual makVre::DtVreMessageResult handleEntityEngineSound(makVre::DtVreMessage* msg);
 
   //! \brief Handles requests to hide entity occupants locally
   //! \param msg Pointer to the hide occupants message
   //! \return Message result indicating how the message was handled
   //!
   //! Processes SetHideEntityOccupantsLocallyMessage by finding the entity
   //! and setting its occupants visibility state
   virtual makVre::DtVreMessageResult handleHideEntityOccupantsLocally(makVre::DtVreMessage* msg);
 
   //! \brief Handles entity element creation events
   //! \param element Pointer to the newly created entity element
   //!
   //! Called when a new entity element is created, ensures proper visualization
   //! for elements that are initially not visible
   virtual void handleElementCreated(makVrv::DtEntityElement* element);
 
protected:
   //! \brief Connection to the element created signal
   //!
   //! Used to receive notifications when new entity elements are created
   boost::signals2::scoped_connection myElementCreatedConnection;
};
} // namespace makVre