savedViewInputLogic.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file savedViewInputLogic.h
//! \brief Input handling component for saved view navigation
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vreCommonComponents/export.h"
#include "vrePlayerStation/inputLogic.h"
 
#include <string>
 
namespace makVrv
{
class DtObserverViewsManager;
}
 
namespace makVre
{
class DtSavedViewUpdater;
 
//! \brief Input handling component for navigating between saved views
//!
//! DtSavedViewInputLogic processes keyboard and controller inputs to navigate
//! between saved observer views. It provides functionality for cycling through
//! views sequentially, directly accessing specific views by number, and toggling
//! special views such as the backup view. This component works in conjunction with
//! the DtSavedViewUpdater to provide a complete saved view navigation system.
class VRECOMMONCOMPONENTS_DLL DtSavedViewInputLogic : public DtInputLogic
{
public:
   //! \brief Constructor for DtSavedViewInputLogic
   //! \param de Reference to the display engine
   //! \param updater Reference to the saved view updater that will execute view changes
   //!
   //! Initializes the input logic component with references to the display engine
   //! and the saved view updater that will perform the actual view changes
   DtSavedViewInputLogic(makVrv::DtDe& de, DtSavedViewUpdater& updater);
 
   //! \brief Virtual destructor for DtSavedViewInputLogic
   virtual ~DtSavedViewInputLogic() override;
 
   //! \brief Initializes the saved view input logic
   //!
   //! Loads the input configuration from commonInput.lua and sets up
   //! action handlers for view navigation commands
   virtual void initialize() override;
 
   //! \brief Shuts down the saved view input logic
   //!
   //! Performs cleanup operations before component destruction
   virtual void shutdown() override;
 
   //! \brief Gets the class name of this component
   //! \return String containing the class name
   //!
   //! Returns the name of this component class for identification purposes
   virtual const std::string& className();
 
   //! \brief Handler for the next view input action
   //! \param value Input value (non-zero to trigger the action)
   //!
   //! Advances to the next saved view in sequence when triggered
   virtual void nextView(float value);
 
   //! \brief Handler for the previous view input action
   //! \param value Input value (non-zero to trigger the action)
   //!
   //! Returns to the previous saved view in sequence when triggered
   virtual void previousView(float value);
 
   //! \brief Handler for toggling to/from the backup view
   //! \param value Input value (non-zero to trigger the action)
   //!
   //! Toggles between the current view and a view containing "Backup View" in its name.
   //! If already in the backup view, returns to the previous view.
   virtual void toggleBackupView(float value);
 
   //! \brief Handler for directly selecting view 1
   //! \param value Input value (non-zero to trigger the action)
   virtual void view1(float value);
 
   //! \brief Handler for directly selecting view 2
   //! \param value Input value (non-zero to trigger the action)
   virtual void view2(float value);
 
   //! \brief Handler for directly selecting view 3
   //! \param value Input value (non-zero to trigger the action)
   virtual void view3(float value);
 
   //! \brief Handler for directly selecting view 4
   //! \param value Input value (non-zero to trigger the action)
   virtual void view4(float value);
 
   //! \brief Handler for directly selecting view 5
   //! \param value Input value (non-zero to trigger the action)
   virtual void view5(float value);
 
   //! \brief Handler for directly selecting view 6
   //! \param value Input value (non-zero to trigger the action)
   virtual void view6(float value);
 
   //! \brief Handler for directly selecting view 7
   //! \param value Input value (non-zero to trigger the action)
   virtual void view7(float value);
 
   //! \brief Handler for directly selecting view 8
   //! \param value Input value (non-zero to trigger the action)
   virtual void view8(float value);
 
   //! \brief Handler for directly selecting view 9
   //! \param value Input value (non-zero to trigger the action)
   virtual void view9(float value);
 
   //! \brief Handler for directly selecting view 10
   //! \param value Input value (non-zero to trigger the action)
   virtual void view10(float value);
 
protected:
   //! \brief Reference to the display engine
   makVrv::DtDe& myDe;
 
   //! \brief Name of this component class
   std::string myClassName;
 
   //! \brief Reference to the saved view updater that executes view changes
   DtSavedViewUpdater& myUpdater;
};
} // namespace makVre