zoomControl.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
//! \file zoomControl.h
//! \brief Component that provides magnification control to the player's view
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vreCommonComponents/export.h"
#include "vrePlayerStation/entityControlLogic.h"
 
#include "vreUtil/initializer.h"
 
namespace makVre
{
class DtVreMessage;
 
class DtWeaponResourceLogic;
 
namespace ZoomControlConfig
{
//! \ingroup RoleConfigParams
//! \defgroup ZoomControlRoleParams Zoom Control Role Parameters
//! \roleInherits{EntityControlLogicRoleParams}
//! Configuration Options for zoom control role.
//! @{
 
//! \vreRoleParamRequired{zoomLevels,table,zoomControl,"{1,2,4,8,16,32}",Array of magnification levels available for zooming.}
constexpr const char* zoomLevels = "zoomLevels";
 
//! @}
} // namespace ZoomControlConfig
 
//! \brief Type identifier for DtZoomControl component
constexpr const char* DtZoomControlType = "DtZoomControl";
 
//! \brief Component that provides zoom control functionality for player views
//!
//! DtZoomControl manages view magnification through a set of configurable zoom levels.
//! It provides input handlers for zooming in and out, updates state attributes to
//! reflect current zoom levels, and adjusts aim input scaling proportionally to the zoom
//! level to maintain consistent aiming sensitivity at different magnifications.
class VRECOMMONCOMPONENTS_DLL DtZoomControl : public DtEntityControlLogic
{
public:
   //! \brief Constructor for DtZoomControl
   //!
   //! Initializes the zoom control component and checks out the VR-Engage ground feature license
   DtZoomControl();
 
   //! \brief Virtual destructor for DtZoomControl
   virtual ~DtZoomControl() override;
 
   //! \brief Initializes the zoom control component
   //! \param player Pointer to the player station this component belongs to
   //! \param config Configuration table containing zoom settings
   //! \return True if initialization succeeded, false otherwise
   //!
   //! Sets up zoom levels from configuration or uses default levels if not specified,
   //! initializes state attributes, and configures input handlers for zoom controls
   virtual bool initialize(DtPlayerStation* player, DtInitTable& config) override;
   //! \brief Shuts down the zoom control component
   //!
   //! Cleans up input logic and performs base class shutdown operations
   virtual void shutdown() override;
 
   //! \brief Returns the type identifier for this component
   //! \return The type string for DtZoomControl
   virtual const char* type() const override;
 
   //! \brief Input handler for zooming in
   //! \param val Input value (non-zero to trigger zoom)
   //!
   //! Increases the zoom index to the next higher magnification level and updates
   //! state attributes with the new zoom value and adjusted aim sensitivity
   virtual void zoomIn(double val);
 
   //! \brief Input handler for zooming out
   //! \param val Input value (non-zero to trigger zoom)
   //!
   //! Decreases the zoom index to the next lower magnification level and updates
   //! state attributes with the new zoom value and adjusted aim sensitivity
   virtual void zoomOut(double val);
 
   //! \brief Input handler for incremental zooming
   //! \param val Input value (positive to zoom in, negative to zoom out)
   //!
   //! Calls either zoomIn or zoomOut based on the sign of the input value
   virtual void zoom(float val);
 
protected:
   //! \brief Input logic that handles mapping of input actions to zoom functions
   DtInputLogic myInputLogic;
 
   //! \brief Collection of available zoom magnification levels
   std::vector<double> myZoomLevels;
 
   //! \brief Current index into the zoom levels array
   int myZoomIndex;
};
} // namespace makVre