vreBinocularsZoomOverlay.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreBinocularsZoomOverlay.h
//! \brief Component for binoculars zoom status overlay
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vreCommonComponents/export.h"
#include "vrePlayerStation/playerComponent.h"
#include "vreCommonComponents/vreBinocularsOverlay.h"
 
namespace makVre
{
//! \brief Type identifier for DtBinocularsZoomOverlay component
constexpr const char* DtBinocularsZoomOverlayType = "DtBinocularsZoomOverlay";
 
//! \brief Component that provides a specialized overlay for binoculars at maximum zoom level
//!
//! DtBinocularsZoomOverlay extends the basic binoculars overlay with functionality
//! specific to maximum zoom level indication. The overlay is only visible when the
//! binoculars are at their maximum zoom level, providing a visual indication to the user
//! that they cannot zoom in any further. It inherits core functionality from the
//! DtBinocularsOverlay class.
class VRECOMMONCOMPONENTS_DLL DtBinocularsZoomOverlay : public DtBinocularsOverlay
{
public:
   //! \brief Constructor for DtBinocularsZoomOverlay
   //!
   //! Initializes the component with default settings
   DtBinocularsZoomOverlay();
 
   //! \brief Virtual destructor for DtBinocularsZoomOverlay
   virtual ~DtBinocularsZoomOverlay() override;
 
   //! \brief Initializes the binoculars zoom overlay component
   //! \param player Pointer to the player station this component belongs to
   //! \param config Configuration table containing overlay settings
   //! \return True if initialization succeeded, false otherwise
   //!
   //! Forwards initialization to the base class and performs any specialized setup
   virtual bool initialize(makVre::DtPlayerStation* player, makVre::DtInitTable& config) override;
   //! \brief Performs post-initialization after all components are initialized
   //! \return True if post-initialization succeeded, false otherwise
   //!
   //! Completes initialization by calling the base class post-initialize
   virtual bool postInitialize() override;
   //! \brief Called every frame to update the overlay state
   //! \param dt Delta time since the last frame in seconds
   //!
   //! Updates overlay visibility and other state based on current zoom level
   virtual void tick(double dt) override;
 
   //! \brief Determines if the zoom overlay should be visible
   //! \return True if the overlay should be visible, false otherwise
   //!
   //! Checks if base binoculars overlay is visible and if the current
   //! view magnification is at the maximum allowed value
   virtual bool isOverlayVisible() override;
 
   //! \brief Returns the type identifier for this component
   //! \return The type string for DtBinocularsZoomOverlay
   virtual const char* type() const override;
};
} // namespace makVre