inputData.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
 
//! \file
//! \brief Defines data structures and enumerations for input device data
 
#pragma once
 
#include <vrvCore/DtKeyState.h>
 
namespace makVre
{
//! \brief Enumeration of input device types
//!
//! Defines the various types of input devices supported by the system
using DtDeviceName = enum DtDeviceType {
   DtGamepad = 0,     //!< Gamepad/controller device
   DtJoystick,        //!< Joystick device
   DtKeyboard,        //!< Keyboard device
   DtMouse,           //!< Mouse device
   DtTouchController, //!< Touch-based controller device
   DtOther            //!< Other device types
};
 
//! \brief Enumeration of input event types
//!
//! Defines the various types of input events that can be generated by devices
using DtInputType = enum DtInputType {
   DtInputTypeAxis = 0,    //!< Axis movement (joystick, analog stick, etc.)
   DtInputTypeButton,      //!< Button press/release
   DtInputTypeDoubleClick, //!< Double-click event
   DtInputTypeHat,         //!< Hat/POV switch event
   DtInputTypeTrackBall,   //!< Trackball movement
   DtInputTypeMotion,      //!< Motion-based input (accelerometer, etc.)
   DtInputTypeScroll,      //!< Scrolling input (mouse wheel, etc.)
   DtInputTypeKey,         //!< Keyboard key press/release
   DtInputTypeInvalid      //!< Invalid or unknown input type
};
 
//! \brief Enumeration of mouse button types
//!
//! Defines standard mouse buttons that can be used as input
using DtMouseButton = enum DtMouseButton {
   DtLeftButton = 0, //!< Left mouse button
   DtRightButton,    //!< Right mouse button
   DtMiddleButton    //!< Middle mouse button (scroll wheel button)
};
 
//! \brief Enumeration of axis directions
//!
//! Defines standard axes that can be used for directional input
using DtInputAxis = enum DtAxisFlags {
   DtAxisNone = 0, //!< No axis specified
   DtAxisX,        //!< X-axis (horizontal)
   DtAxisY,        //!< Y-axis (vertical)
   DtAxisZ         //!< Z-axis (depth)
};
 
//! \brief Enumeration of hat/POV switch positions
//!
//! Defines the directional positions for a hat switch or POV controller
//! with bit flags that can be combined for diagonal directions
using DtHatFlags = enum DtHatFlags {
   DtHatCentered = 0x00,                    //!< Hat in center/neutral position
   DtHatUp = 0x01,                          //!< Hat in up position
   DtHatRight = 0x02,                       //!< Hat in right position
   DtHatDown = 0x04,                        //!< Hat in down position
   DtHatLeft = 0x08,                        //!< Hat in left position
   DtHatRightUp = DtHatRight | DtHatUp,     //!< Hat in up-right diagonal position
   DtHatRightDown = DtHatRight | DtHatDown, //!< Hat in down-right diagonal position
   DtHatLeftUp = DtHatLeft | DtHatUp,       //!< Hat in up-left diagonal position
   DtHatLeftDown = DtHatLeft | DtHatDown,   //!< Hat in down-left diagonal position
   DtHatInvalid                             //!< Invalid hat position
};
 
//! \brief Alias for key modifier flags from DtKeyState
//!
//! Reuses the existing KeyModifier enum to represent input modifiers (Shift, Ctrl, Alt, etc.)
using DtInputModifier = makVrv::DtKeyState::KeyModifier;
 
//! \brief Structure for transferring input data through the input system
//!
//! Contains all information about an input event, including device information,
//! input type, and value. This is the primary data structure used to communicate
//! input events between devices and the input manager.
struct DtInputData
{
   //! \brief Type of device that generated the input
   DtDeviceType myDeviceType;
 
   //! \brief Name of the specific device instance
   //!
   //! When combined with device ID, uniquely identifies the source of the input
   //! across all attached devices. If not set, the device type is used instead.
   std::string myDeviceName;
 
   //! \brief Index of the device instance, starting with 0
   //!
   //! Used to distinguish between multiple devices with the same name
   int myDeviceIndex;
 
   //! \brief Timestamp when the input event occurred (simulation time)
   double myTimestamp;
 
   //! \brief Type of input event (button press, axis movement, etc.)
   DtInputType myInputType;
 
   //! \brief Identifier for the specific input control
   //!
   //! For DtInputTypeKey: ASCII character code
   //! For DtInputTypeAxis: Axis index (0, 1, 2, etc.)
   //! For DtInputTypeButton: Button index
   int myInputID;
 
   //! \brief Value of the input event
   //!
   //! For buttons: 1.0 (pressed) or 0.0 (released)
   //! For axes: Normalized value, typically -1.0 to 1.0
   //! For other inputs: Depends on input type
   float myInputValue;
 
   //! \brief Optional flags specific to the input type
   //!
   //! For hat inputs: DtHatFlags values
   //! For axis inputs: DtAxisFlags values
   int myInputFlags = 0;
 
   //! \brief Keyboard modifiers active during the input event
   //!
   //! Stores modifier key states (Ctrl, Alt, Shift, etc.)
   int myModifiers = 0;
};
 
} // namespace makVre