mixedRealityUpdater.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file mixedRealityUpdater.h
//! \brief Component that provides mixed reality (augmented reality) capabilities
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vreCommonComponents/export.h"
 
#include "vrePlayerStation/playerComponent.h"
#include "vreMessageManager/vreMessage.h"
 
 
#include <osg/ref_ptr>
#include <osg/Program>
#include <osg/MatrixTransform>
 
#include <matrix/vlVector.h>
 
namespace makVrv
{
class DtDe;
class DtVirtualRealityDriver;
class DtTrackedCamera;
class DtObserver;
}; // namespace makVrv
 
namespace makVre
{
namespace MixedRealityUpdaterConfig
{
//! \ingroup RoleConfigParams
//! \defgroup MixedRealityUpdaterRoleParams Mixed Reality Updater Role Parameters
//! \roleInherits{PlayerComponentRoleParams}
//! Configuration Options for mixed reality updater role.
//! @{
 
//! \vreRoleParam{A,float,1.0,mixedRealityUpdater,Parameter A for mixed reality rendering algorithm calibration.}
constexpr const char* A = "A";
 
//! \vreRoleParam{algorithm,int,0,mixedRealityUpdater,Algorithm selection for mixed reality processing and rendering.}
constexpr const char* algorithm = "algorithm";
 
//! \vreRoleParam{B,float,1.0,mixedRealityUpdater,Parameter B for mixed reality rendering algorithm calibration.}
constexpr const char* B = "B";
 
//! \vreRoleParam{C,float,1.0,mixedRealityUpdater,Parameter C for mixed reality rendering algorithm calibration.}
constexpr const char* C = "C";
 
//! \vreRoleParam{cameraProjectionGeometry,string,"$(DATA_DIR)\\Objects\\cockpitMask\\cockpitMask.xml",mixedRealityUpdater,Path to the camera projection geometry file for cockpit masking in mixed reality mode.}
constexpr const char* cameraProjectionGeometry = "cameraProjectionGeometry";
 
//! \vreRoleParam{D,float,1.0,mixedRealityUpdater,Parameter D for mixed reality rendering algorithm calibration.}
constexpr const char* D = "D";
 
//! \vreRoleParam{maskColor,vector,{0.15; 0.70; 0.30},mixedRealityUpdater,RGB color vector for chroma key masking in mixed reality processing.}
constexpr const char* maskColor = "maskColor";
 
//! @}
} // namespace MixedRealityUpdaterConfig
 
//! \brief Type identifier for DtMixedRealityUpdater component
constexpr const char* DtMixedRealityUpdaterType = "DtMixedRealityUpdater";
 
//! \brief Component that implements mixed reality (augmented reality) functionality
//!
//! DtMixedRealityUpdater integrates camera video feeds with the virtual environment
//! to create a mixed reality experience. It manages a masking object that blends
//! real-world camera imagery with virtual content, handles chroma keying for
//! green screen effects, and provides UI controls for adjusting mixed reality parameters.
class VRECOMMONCOMPONENTS_DLL DtMixedRealityUpdater : public DtPlayerComponent
{
public:
   //! \brief Constructor for DtMixedRealityUpdater
   //!
   //! Initializes component state with default values
   DtMixedRealityUpdater();
 
   //! \brief Virtual destructor for DtMixedRealityUpdater
   virtual ~DtMixedRealityUpdater() override;
 
   //! \brief Initializes the mixed reality updater component
   //! \param player Pointer to the player station this component belongs to
   //! \param config Configuration table containing mixed reality settings
   //! \return True if initialization succeeded, false otherwise
   //!
   //! Reads configuration parameters for the mixed reality system, including
   //! masking algorithm settings, color parameters, and camera projection geometry path
   virtual bool initialize(DtPlayerStation* player, DtInitTable& config) override;
 
   //! \brief Performs post-initialization after all components are initialized
   //! \return True if post-initialization succeeded, false otherwise
   //!
   //! Acquires the VR driver, sets up the masking object, and starts the mixed reality system
   virtual bool postInitialize() override;
 
   //! \brief Called every frame to update the mixed reality state
   //! \param dt Delta time since the last frame in seconds
   //!
   //! Handles cockpit control visibility on first update and processes UI interactions
   //! for mixed reality parameter adjustments
   virtual void tick(double dt) override;
 
   //! \brief Shuts down the mixed reality updater component
   //!
   //! Disables mixed reality mode, removes the mask object, disconnects signals,
   //! and restores cockpit control visibility
   virtual void shutdown() override;
 
   //! \brief Returns the component type identifier
   //! \return The component type string
   virtual const char* type() const override;
 
protected:
   //! \brief Updates the mask transform and shader parameters
   //!
   //! Called each frame to update the mask transform based on the observer's position
   //! and orientation, and to update shader parameters for chroma keying
   virtual void updateMask();
 
   //! \brief Handles shader reload requests
   //!
   //! Reloads the mask shader files and updates the state set with the new shader
   virtual void handleReloadShader();
 
   //! \brief Handles menu action messages for mixed reality controls
   //! \param msg The menu action message
   //! \return Message handling result indicating if the message was handled
   //!
   //! Processes menu actions, currently supporting toggling the AR camera menu
   virtual makVre::DtVreMessageResult handleMenuActionMessage(makVre::DtVreMessage* msg);
 
   //! \brief Sets the visibility of cockpit controls
   //! \param visible True to show cockpit controls, false to hide them
   //!
   //! Manipulates the entity's appearance to show or hide virtual cockpit controls,
   //! typically hiding them when in mixed reality mode to see real controls
   virtual void setCockpitControlsVisible(bool visible);
 
   //! \brief Pointer to the observer used for positioning the mask
   makVrv::DtObserver* myObserver;
 
   //! \brief Pointer to the virtual reality driver that provides camera integration
   makVrv::DtVirtualRealityDriver* myVrDriver;
 
   //! \brief Transform node for the masking geometry
   osg::ref_ptr<osg::MatrixTransform> myMaskTransform;
 
   //! \brief Shader program used for blending camera imagery with virtual content
   osg::ref_ptr<osg::Program> myMaskShader;
 
   //! \brief Color used for chroma keying (typically green for green screen)
   DtVector myMaskColor;
 
   //! \brief Selected chroma keying algorithm (0-4 for different methods)
   int myAlgorithm;
 
   //! \brief First algorithm parameter, meaning varies by algorithm type
   float myA;
 
   //! \brief Second algorithm parameter, meaning varies by algorithm type
   float myB;
 
   //! \brief Third algorithm parameter, meaning varies by algorithm type
   float myC;
 
   //! \brief Fourth algorithm parameter, meaning varies by algorithm type
   float myD;
 
   //! \brief Camera X offset in millimeters
   float ix;
 
   //! \brief Camera Y offset in millimeters
   float iy;
 
   //! \brief Camera Z offset in millimeters
   float iz;
 
   //! \brief Camera pitch offset in degrees
   float ip;
 
   //! \brief Flag indicating whether to show the camera adjustment menu
   bool myShowCameraMenu;
 
   //! \brief Path to the camera projection geometry (mask model)
   std::string myMaskPath;
 
   //! \brief Flag indicating if cockpit controls visibility needs to be toggled
   bool myStickNeedsSwitch;
};
} // namespace makVre