playerStationOsgGlStudioCockpit.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file playerStationOsgGlStudioCockpit.h
//! \brief Defines the player station OSG GLStudio cockpit integration
//! \ingroup vreGlsEventSignaler
#pragma once
 
#include "mfsRwrVrv.h"
 
#include <vreMessageManager/vreMessage.h>
 
#include <vrvGlStudioShared/DtOsgGlStudioCockpit.h>
 
namespace makVrv
{
//! \brief Forward declaration of the channel configuration class
class DtChannelConfiguration;
 
//! \brief Forward declaration of the channel manager class
class DtChannelManager;
 
//! \brief Forward declaration of the OSG channel class
class DtOsgChannel;
 
//! \brief Forward declaration of the camera node class
class DtCameraNode;
 
//! \brief Forward declaration of the virtual reality channel class
class DtVirtualRealityChannel;
} // namespace makVrv
 
namespace disti
{
//! \brief Forward declaration of the GLStudio component base class
class ComponentBase;
} // namespace disti
 
namespace makVre
{
//! \brief Player station implementation of the OSG GLStudio cockpit
//!
//! This specialized cockpit implementation sets the entity's name into each
//! updater, allowing them to look up data based on the associated entity.
//! Additionally, it identifies all properties with the prefix "Out_" and
//! sends PropertyUpdateMessages whenever these values change.
//!
//! The player station cockpit also adds special handling for visibility and
//! performance optimization through update throttling.
//! \ingroup vreGlsEventSignaler
class DT_DLL_MFSRWRVRV DtPlayerStationOsgGlStudioCockpit : public makVrv::DtOsgGlStudioCockpit
{
public:
   //! \brief Constructor
   //! \param de Reference to the display element
   //! \param id Unique identifier for this cockpit instance
   //!
   //! Creates a new player station OSG GLStudio cockpit with the specified ID
   DtPlayerStationOsgGlStudioCockpit(makVrv::DtDe& de, makVrv::DtUniqueID id);
 
   //! \brief Virtual destructor
   virtual ~DtPlayerStationOsgGlStudioCockpit() override;
 
   //! \brief Gets the class name of the model instance owner
   //! \return String containing the class name
   //!
   //! This method is used to control how model instances are created and
   //! to identify the type of cockpit during agent operations
   virtual std::string className() const override;
 
   //! \brief Updates the cockpit state
   //! \return Time in seconds until the next update is needed
   //!
   //! On first update call, sets GLStudio component properties such as MAK_HostId.
   //! Subsequent updates manage component state and property updates.
   virtual double update() override;
 
   //! \brief Performs base class update with throttling support
   //! \return Time in seconds until the next update is needed
   //!
   //! Throttles GLStudio component property updates if the framerate falls
   //! below a specific threshold to maintain performance
   virtual double DtOsgGlStudioCockpit_update();
 
   //! \brief Creates the cockpit from the specified file
   //! \param filename Path to the GLStudio cockpit file
   //! \param rsoName Name of the RSO (Rendered Scene Object)
   //! \param p Perspective type for the cockpit
   //! \param attachedEntityElementId Element ID of the entity to attach to
   //!
   //! Initializes the cockpit instance from the specified GLStudio file and
   //! associates it with the given entity
   virtual void createCockpit(const std::string& filename, const std::string& rsoName, DtPerspective p,
      makVrv::DtUniqueID attachedEntityElementId) override;
 
protected:
   //! \brief Creates the HUD object and supporting nodes
   //! \return Pointer to the created OSG group containing overlay objects
   //!
   //! Overridden to fix renderCockpitOnly instrument panels with SensorFX integration.
   //! This method constructs the actual OpenSceneGraph nodes for displaying the cockpit.
   virtual osg::Group* createOverlayObjects() override;
 
   //! \brief Creates a channel-specific node for HUD integration
   //! \return Pointer to the created channel node
   //!
   //! Creates channel-specific nodes and determines whether the HUD should be
   //! added to the channels. Overridden to maintain a reference to myChannelNode
   //! to prevent deletion during slot_channelModified operations.
   virtual osg::Group* createChannelNode() override;
 
   //! \brief Handles cockpit visibility control messages
   //! \param msg Pointer to the message to handle
   //! \return Message processing result
   //!
   //! Processes SetCockpitVisibility messages to toggle cockpit visibility.
   //! Used to hide the cockpit when the aircraft model is shown and vice-versa.
   virtual DtVreMessageResult handleSetCockpitVisibility(DtVreMessage* msg);
 
   //! \brief Reference-counted pointer to protect the channel node
   //!
   //! Keeps myChannelNode from being deleted during slot_channelModified.
   //! See createChannelNode() for more details.
   osg::ref_ptr<osg::Group> myChannelNodeProtector;
 
   //! \brief Index for tracking attribute update cycles during throttling
   int myAttributeTickIndex;
 
   //! \brief Current framerate for throttling decisions
   float myFrameRate;
 
   //! \brief Flag indicating if this is the first update
   //!
   //! Used to perform special initialization during the first update cycle
   bool myFirstUpdate;
};
} // namespace makVre