vreOsgHudEffectTextureController.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file vreOsgHudEffectTextureController.h
//! \brief Defines the HUD-specific texture effect controller for VR-Engage
//!
//! This file contains the DtVreOsgHudEffectTextureController class which provides
//! specialized texture effect control for Heads-Up Display (HUD) elements in the
//! VR-Engage visualization system. It allows for applying shader-based effects
//! specifically tailored for HUD rendering.
 
#pragma once
 
#include "vrePlayerStation/export.h"
 
#include <vrvOsg/DtOsgEffectTextureController.h>
#include <vrvOsg/DtOsgRenderer.h>
#include <vrvOsg/DtEffectControllerCreatorTemplate.h>
 
namespace makVre
{
//! \brief Controller for HUD-specific texture effects in OSG rendering
//!
//! DtVreOsgHudEffectTextureController manages texture effects specifically
//! designed for Heads-Up Display (HUD) elements in the visualization system.
//! Based on VR-Vantage's exampleEffectTexturePlugin, it provides specialized
//! shader and texture management tailored for optimal HUD rendering, including
//! features like transparency handling and overlay positioning.
class PLAYERSTATION_DLL DtVreOsgHudEffectTextureController : public makVrv::DtOsgEffectTextureController
{
public:
   //! \brief Constructor
   //! \param de Reference to the display engine
   //!
   //! Creates a new HUD-specific effect texture controller for the specified
   //! display engine. This controller is preconfigured with appropriate shaders
   //! and parameters for HUD rendering.
   DtVreOsgHudEffectTextureController(makVrv::DtDe& de);
 
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of HUD effect texture controller resources.
   virtual ~DtVreOsgHudEffectTextureController() override;
 
   //! \brief Installs the HUD effect shaders into a state set
   //! \param baseUnit Base texture unit index
   //! \param effectUnit Effect texture unit index
   //! \param tex Pointer to the effect texture
   //! \param stateSet State set to install the shaders into
   //! \param baseTextureName Name of the base texture sampler
   //! \return True if shaders were installed successfully, false otherwise
   //!
   //! Installs the HUD-specific effect shaders into the provided state set,
   //! configuring the necessary uniforms and texture units for the effect.
   //! This implementation includes special handling for HUD rendering, such as
   //! proper transparency and overlay positioning.
   virtual bool installShaders(int baseUnit, int effectUnit, const osg::Texture* tex, osg::StateSet* stateSet,
      const std::string& baseTextureName) const override;
 
   //! \brief Globally enables or disables HUD effects
   //! \param enabled True to enable HUD effects, false to disable
   //!
   //! Static method that controls whether HUD effects are globally enabled
   //! or disabled. This affects all instances of HUD effect controllers in
   //! the application.
   static void setEnabled(bool enabled);
 
private:
   //! \brief Shared uniform for enabling/disabling HUD effect textures
   //!
   //! Static uniform that controls whether HUD effect textures are enabled globally.
   //! This allows for toggling all HUD effects with a single uniform value.
   static osg::ref_ptr<osg::Uniform> effectEnabledUniform;
};
 
//! \brief Factory creator for HUD effect texture controllers
//!
//! DtVreOsgHudEffectTextureControllerCreator is a factory class that creates
//! HUD-specific effect texture controller instances for registration with the
//! DtEffectControllerFactory. This allows the HUD effect controllers to be
//! created on demand using the factory pattern.
class PLAYERSTATION_DLL DtVreOsgHudEffectTextureControllerCreator : public makVrv::DtEffectControllerCreator
{
public:
   //! \brief Creates a new HUD effect texture controller
   //! \param de Reference to the display engine
   //! \return Pointer to a newly created HUD effect texture controller
   //!
   //! Factory method that creates a new HUD effect texture controller
   //! instance for the specified display engine.
   virtual DtVreOsgHudEffectTextureController* create(makVrv::DtDe& de) override;
};
} // namespace makVre