spectatorSimLogic.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file spectatorSimLogic.h
//! \brief Defines the simulation logic for the spectator role
//! \ingroup vreSpectatorFrontend
 
#pragma once
 
#include <vreSpectatorFrontend/export.h>
 
#include "vrePlayerStation/entityControlLogic.h"
 
#include "vreUtil/initializer.h"
 
namespace makVre
{
namespace SpectatorSimLogicConfig
{
//! \ingroup RoleConfigParams
//! \defgroup SpectatorSimLogicRoleParams Spectator Simulation Logic Role Parameters
//! \roleInherits{EntityControlLogicRoleParams}
//! Configuration Options for spectator simulation logic role.
//! @{
 
//! \vreRoleParam{disableInputHandler,bool,false,spectatorSimLogic,Flag to disable input handler setup for manual input management.}
constexpr const char* disableInputHandler = "disableInputHandler";
 
//! @}
} // namespace SpectatorSimLogicConfig
 
//! \brief Type identifier for DtSpectatorSimLogic component
constexpr const char* DtSpectatorSimLogicType = "DtSpectatorSimLogic";
 
//! \brief Simulation logic component for the spectator role
//!
//! This component implements the simulation logic for the spectator role,
//! managing view control, camera movement, and spectator-specific behavior.
//! It processes view manipulation inputs, handles zoom operations, and
//! provides spectator view control capabilities. As an entity control logic
//! component, it also manages entity interactions in the simulation.
class SPECTATOR_DLL DtSpectatorSimLogic : public makVre::DtEntityControlLogic
{
public:
   //! \brief Default constructor
   DtSpectatorSimLogic();
 
   //! \brief Virtual destructor
   virtual ~DtSpectatorSimLogic() override;
 
   //! \brief Initializes the simulation logic component
   //! \param player Pointer to the player station
   //! \param config Reference to the initialization configuration
   //! \return True if initialization was successful, false otherwise
   //!
   //! Sets up the spectator simulation logic and initializes input logic
   virtual bool initialize(makVre::DtPlayerStation* player, makVre::DtInitTable& config) override;
 
   //! \brief Updates simulation state each frame
   //! \param dt Delta time since the last update in seconds
   //!
   //! Updates the spectator simulation state based on inputs and current conditions
   virtual void tick(double dt) override;
 
   //! \brief Performs cleanup when the component is shut down
   //!
   //! Releases resources and performs necessary cleanup operations
   virtual void shutdown() override;
 
   //! \brief Returns the component type identifier
   //! \return The component type string
   virtual const char* type() const override;
 
   //! \name Input Functions
   //! @{
 
   //! \brief Resets the view to default position
   //! \param val Reset magnitude (typically 1.0 for full reset)
   //!
   //! Returns the view to its default orientation and position
   virtual void resetView(float val = 1);
 
   //! \brief Adjusts the view azimuth (horizontal rotation)
   //! \param val Azimuth adjustment value
   //!
   //! Rotates the view horizontally by the specified amount
   virtual void azimuth(float val);
 
   //! \brief Adjusts the view elevation (vertical angle)
   //! \param val Elevation adjustment value
   //!
   //! Rotates the view vertically by the specified amount
   virtual void elevation(float val);
 
   //! \brief Zooms the view out
   //! \param val Zoom magnitude value
   //!
   //! Increases the view distance by the specified amount
   virtual void zoomOut(float val);
 
   //! \brief Zooms the view in
   //! \param val Zoom magnitude value
   //!
   //! Decreases the view distance by the specified amount
   virtual void zoomIn(float val);
 
   //! \brief Adjusts the view zoom level directly
   //! \param val Zoom level value
   //!
   //! Sets the view zoom level to the specified value
   virtual void zoom(float val);
 
   //! @}
 
protected:
   //! \brief Input logic component for handling user inputs
   //!
   //! Processes user inputs and translates them into simulation actions
   DtInputLogic myInputLogic;
};
} // namespace makVre