vreScopeSimLogic.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreScopeSimLogic.h
//! \brief Component for managing weapon scope zoom functionality
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vreCommonComponents/export.h"
#include "vreCommonComponents/stateDefines.h"
#include "vreMessageManager/vreMessage.h"
#include "vrePlayerStation/playerComponent.h"
 
namespace makVrv
{
class DtVirtualRealityDriver;
}
 
namespace makVre
{
namespace ScopeSimLogicConfig
{
//! \ingroup RoleConfigParams
//! \defgroup ScopeSimLogicRoleParams Scope Sim Logic Role Parameters
//! \roleInherits{PlayerComponentRoleParams}
//! Configuration Options for scope simulation logic role.
//! @{
 
//! \vreRoleParam{hmdSmoothingAlpha,double,0.8,scopeSimLogic,Alpha value for HMD orientation smoothing when using scopes in VR mode.}
constexpr const char* hmdSmoothingAlpha = "hmdSmoothingAlpha";
 
//! \vreRoleParam{hmdSmoothingEnabled,bool,true,scopeSimLogic,Whether to enable HMD orientation smoothing when using scopes in VR mode.}
constexpr const char* hmdSmoothingEnabled = "hmdSmoothingEnabled";
 
//! \vreRoleParam{hmdSmoothingThreshold,double,60.0,scopeSimLogic,Threshold angle in degrees for triggering HMD orientation smoothing.}
constexpr const char* hmdSmoothingThreshold = "hmdSmoothingThreshold";
 
//! @}
} // namespace ScopeSimLogicConfig
 
//! \brief Type identifier for DtScopeSimLogic component
constexpr const char* DtScopeSimLogicType = "DtScopeSimLogic";
 
//! \brief Component for managing weapon scope simulation and zoom controls
//!
//! DtScopeSimLogic manages zoom functionality for weapon scopes, handling both
//! discrete zoom level changes and observer view mode adjustments when aiming.
//! The component responds to zoom increase/decrease messages and automatically
//! configures VR-specific settings such as head orientation smoothing when in VR mode.
//! It also enforces first-person view when aiming through a scope and manages the
//! transition between aiming and non-aiming states.
class VRECOMMONCOMPONENTS_DLL DtScopeSimLogic : public DtPlayerComponent
{
public:
   //! \brief Constructor for DtScopeSimLogic
   //! \param className Class name for identification, defaults to "DtScopeSimLogic"
   //!
   //! Initializes the component with default zoom and smoothing settings
   DtScopeSimLogic();
 
   //! \brief Virtual destructor for DtScopeSimLogic
   virtual ~DtScopeSimLogic() override;
 
   //! \brief Initializes the scope simulation logic component
   //! \param player Pointer to the player station this component belongs to
   //! \param config Configuration table containing scope settings
   //! \return True if initialization succeeded, false otherwise
   //!
   //! Reads configuration values for HMD smoothing settings, registers message handlers
   //! for scope zoom messages, and sets up attribute callbacks for aiming state and
   //! view magnification changes
   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
   //!
   //! Sets up VR-specific configurations if applicable, including
   //! configuring the VR driver's orientation smoothing settings
   virtual bool postInitialize() override;
 
   //! \brief Called every frame to update the component state
   //! \param dt Delta time since the last frame in seconds
   //!
   //! Current implementation is empty as updates occur through message handlers
   //! and attribute change callbacks
   virtual void tick(double dt) override;
   
   //! \brief Shuts down the scope simulation logic component
   //!
   //! Removes message handlers and attribute change callbacks
   virtual void shutdown() override;
 
   //! \brief Returns the type identifier for this component
   //! \return The type string for DtScopeSimLogic
   virtual const char* type() const override;
 
   //! \brief Handles messages to increase scope zoom level
   //! \param msg The scope increase zoom message
   //! \return Message handling result indicating the message was handled
   //!
   //! Increases the zoom index and updates the view magnification to the next
   //! higher zoom level from the configured scopeZoomLevels array
   virtual makVre::DtVreMessageResult handleScopeIncreaseZoom(makVre::DtVreMessage* msg);
 
   //! \brief Handles messages to decrease scope zoom level
   //! \param msg The scope decrease zoom message
   //! \return Message handling result indicating the message was handled
   //!
   //! Decreases the zoom index and updates the view magnification to the next
   //! lower zoom level from the configured scopeZoomLevels array
   virtual makVre::DtVreMessageResult handleScopeDecreaseZoom(makVre::DtVreMessage* msg);
 
   //! \brief Callback for when the aiming state changes
   //! \param aiming New aiming state (true when aiming, false otherwise)
   //!
   //! When entering aiming state, sets initial zoom level, disables third person view,
   //! and forces first person observer mode. When exiting aiming state, restores the
   //! previous observer attach mode.
   virtual void onAimingChanged(bool aiming);
 
   //! \brief Callback for view magnification attribute changes
   //! \param mag New magnification value
   //!
   //! Current implementation is empty
   virtual void onViewMagnificationChanged(double mag);
 
protected:
   //! \brief Maximum allowed view magnification value
   double myMaxViewMagnification;
 
   //! \brief Pointer to the VR driver if available
   makVrv::DtVirtualRealityDriver* myVrDriver;
 
   //! \brief Flag indicating if mixed reality was active before entering aiming mode
   bool myMrWasActive;
 
   //! \brief The observer attach mode used before entering aiming mode
   //!
   //! Stored when entering aiming mode so it can be restored when exiting
   ObserverAttachMode myLastObserverAttachMode;
 
   //! \brief Flag indicating if HMD orientation smoothing is enabled
   bool myHmdSmoothingEnabled;
 
   //! \brief Smoothing alpha parameter for HMD orientation smoothing
   //! \note Higher values (closer to 1.0) produce more smoothing
   double myHmdSmoothingAlpha;
 
   //! \brief Threshold parameter for HMD orientation smoothing in degrees per second
   //! \note Rotation speeds below this threshold will be smoothed
   double myHmdSmoothingThreshold;
};
} // namespace makVre