observerUpdater.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file observerUpdater.h
//! \brief Defines the observer updater component for the spectator role
//! \ingroup vreSpectatorFrontend
 
#pragma once
 
#include <vreSpectatorFrontend/export.h>
 
#include "vreCommonComponents/observerUpdater.h"
 
#include "vreMessageManager/vreMessage.h"
 
namespace makVrv
{
//! \brief Forward declaration of the observer class
class DtObserver;
} // namespace makVrv
 
namespace makVre
{
//! \brief Type identifier for DtSpectatorObserverUpdater component
constexpr const char* DtSpectatorObserverUpdaterType = "DtSpectatorObserverUpdater";
 
//! \brief Observer updater component for the spectator role
//!
//! This component manages the spectator's observer (camera) within the simulation,
//! controlling viewing position, orientation, and behavior. It handles observer
//! initialization, updates its position and orientation each frame, and responds
//! to events such as player creation and reset. The observer updater provides
//! features specific to the spectator role, such as free-camera movement and
//! point-of-interest focus capabilities.
class SPECTATOR_DLL DtSpectatorObserverUpdater : public makVre::DtObserverUpdater
{
public:
   //! \brief Default constructor
   DtSpectatorObserverUpdater();
 
   //! \brief Virtual destructor
   virtual ~DtSpectatorObserverUpdater() override;
 
   //! \brief Initializes the observer updater 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 observer and registers message handlers
   virtual bool initialize(makVre::DtPlayerStation* player, makVre::DtInitTable& config) override;
 
   //! \brief Updates observer state each frame
   //! \param dt Delta time since the last update in seconds
   //!
   //! Updates the observer's position and orientation based on inputs and simulation state
   virtual void tick(double dt) override;
 
   //! \brief Performs cleanup when the component is shut down
   //!
   //! Releases resources and unregisters message handlers
   virtual void shutdown() override;
 
   //! \brief Returns the component type identifier
   //! \return The component type string
   virtual const char* type() const override;
 
protected:
   //! \brief Handles player created messages
   //! \param msg Pointer to the message being processed
   //! \return Message processing result
   //!
   //! Initializes the observer when a new player is created
   virtual makVre::DtVreMessageResult handlePlayerCreated(makVre::DtVreMessage* msg);
 
   //! \brief Handles player reset messages
   //! \param msg Pointer to the message being processed
   //! \return Message processing result
   //!
   //! Resets the observer when the player is reset
   virtual makVre::DtVreMessageResult handlePlayerReset(makVre::DtVreMessage* msg);
 
   //! \brief Resets the observer to its default state
   //!
   //! Returns the observer to its initial position and orientation
   void resetObserver();
 
   //! \brief Updates the observer offset values
   //!
   //! Adjusts position and orientation offsets based on current observer state
   void updateObserverOffsets();
 
   //! \brief Pointer to the observer being managed
   makVrv::DtObserver* myObserver;
};
} // namespace makVre