inputDevice.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
 
//! \file
//! \brief Abstract base class for input device implementations
 
#pragma once
 
#include "vreInput/export.h"
 
namespace makVre
{
//! Forward declarations
class DtVreInputManager;
 
//! \brief Abstract base class for hardware input device implementations
//!
//! This class provides a common interface for all input devices (gamepad, joystick, keyboard, etc.).
//! Instances are owned by a DtVreInputManager. Derived classes receive input from specific hardware
//! device APIs, map these inputs to DtInputData structures, and then call processInput() in the
//! DtVreInputManager to handle the input events.
class VREINPUT_DLL DtInputDevice
{
public:
   //! \brief Default constructor
   DtInputDevice() {};
   //! \brief Virtual destructor
   virtual ~DtInputDevice() {};
 
   //! \brief Copy constructor (deleted)
   //!
   //! Input devices cannot be copied due to hardware abstraction requirements
   DtInputDevice(const DtInputDevice& mapping) = delete;
 
   //! \brief Assignment operator (deleted)
   //!
   //! Input devices cannot be assigned due to hardware abstraction requirements
   DtInputDevice& operator=(const DtInputDevice&) = delete;
 
   //! \brief Initialize the device with a reference to the input manager
   //!
   //! Sets up the device and prepares it to receive input events from hardware.
   //!
   //! \param mgr Reference to the input manager that owns this device
   //! \return True if initialization succeeded, false if the device failed (e.g., hardware not present)
   virtual bool init(DtVreInputManager& mgr) = 0;
 
   //! \brief Update method called each frame by the input manager
   //!
   //! Allows the device to poll for input, handle timing-related events,
   //! and perform any per-frame processing needed.
   //!
   //! \param dt Delta time in seconds since the last frame
   virtual void tick(double dt) = 0;
 
   //! \brief Shutdown the device and release hardware resources
   //!
   //! Disconnects from the hardware device and stops receiving input events.
   //! Should clean up any resources allocated during initialization.
   virtual void shutdown() = 0;
 
   //! \brief Report the current state of all buttons, axes, and other inputs
   //!
   //! Sends input events for the current state of all device controls without
   //! requiring actual hardware input. Useful for initializing the system with
   //! the current device state or for testing.
   virtual void reportCurrentState() = 0;
 
protected:
   //! \brief Pointer to the input manager that owns this device
   //!
   //! Used to send input events to the manager for processing
   DtVreInputManager* myManager;
};
 
} // namespace makVre