DtPlayerStationOsgGlStudioCockpitAgent.hpp

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file DtPlayerStationOsgGlStudioCockpitAgent.hpp
//! \brief Agent class for player station OSG GLStudio cockpit integration
//! \ingroup vreGlsEventSignaler
 
#pragma once
 
//! \note This file contains both generated code and manual modifications
//! \note Generated by dcgen tool with manual export macro fixes
//!
//! The following modifications were made to the generated code:
//! - Added include for the mfsRwrVrv.h file to ensure proper export macro availability
#include "vreGlsEventSignaler/mfsRwrVrv.h"
 
#include <vrvGlStudioShared/DtOsgGlStudioCockpitAgent.hpp>
 
namespace makVre 
{
 
//! \brief Forward declaration of the player station OSG GLStudio cockpit class
class DtPlayerStationOsgGlStudioCockpit;
 
//! \brief Agent class for the DtPlayerStationOsgGlStudioCockpit scene object
//!
//! This agent provides an interface to control and communicate with a player station
//! OSG GLStudio cockpit instance. It extends the basic GLStudio cockpit agent
//! functionality to work specifically with player station cockpits, enabling
//! interactive cockpit instrumentation and displays within the simulation environment.
//! 
//! As an agent, it forms part of the scene graph management system and can be
//! used in distributed rendering scenarios.
class DT_DLL_MFSRWRVRV DtPlayerStationOsgGlStudioCockpitAgent : public virtual makVrv::DtOsgGlStudioCockpitAgent
{
public:
   //! \brief Default constructor
   //!
   //! Initializes a new player station OSG GLStudio cockpit agent
   DtPlayerStationOsgGlStudioCockpitAgent();
 
   //! \brief Static helper for creating a new agent instance
   //! \param sceneInterface Reference to the agent manager interface
   //! \param bDistribute Whether the agent should be distributed across the network
   //! \return Pointer to the newly created agent
   //!
   //! Creates a new player station OSG GLStudio cockpit agent and registers it with the scene
   static DtPlayerStationOsgGlStudioCockpitAgent* create(makVrv::DtAgentManagerInterface& sceneInterface, bool bDistribute = true);
 
   //! \brief Virtual destructor
   virtual ~DtPlayerStationOsgGlStudioCockpitAgent() override;
 
   //! \brief Attempts to find the actual cockpit object this agent is controlling
   //! \return Pointer to the controlled cockpit object, or nullptr if not found
   //! \warning Any direct modifications to the object will not work in distributed rendering
   //!
   //! This method locates the underlying cockpit object that this agent represents.
   //! Changes made directly to this object will not be replicated in distributed rendering.
   DtPlayerStationOsgGlStudioCockpit* findObject();
   
   //! \brief Const version of findObject()
   //! \return Const pointer to the controlled cockpit object, or nullptr if not found
   //! \warning Any direct modifications to the object will not work in distributed rendering
   const DtPlayerStationOsgGlStudioCockpit* findObject() const;
 
 
protected:
   //! \brief Pure virtual implementation method for finding the specific cockpit object
   //! \return Pointer to the cockpit object cast to the correct type
   //!
   //! This protected method is implemented by concrete subclasses to perform
   //! the actual finding and casting of the controlled cockpit object
   virtual DtPlayerStationOsgGlStudioCockpit* findObjectAsDtPlayerStationOsgGlStudioCockpit() = 0;
};
 
}