Base class for controller mappings that represent a physical input. More...
#include <ControllerInputMapping.h>
Public Member Functions | |
| ControllerInputMapping (PhysicalDeviceType physicalDeviceType) | |
| Constructs a ControllerInputMapping for the given physical device type. | |
| ~ControllerInputMapping () | |
| virtual std::string | GetPhysicalInputName () |
| Returns a human-readable name for the physical input this mapping represents. | |
 Public Member Functions inherited from Ship::ControllerMapping | |
| ControllerMapping (PhysicalDeviceType physicalDeviceType) | |
| Constructs a ControllerMapping for the given physical device type. | |
| ~ControllerMapping () | |
| virtual std::string | GetPhysicalDeviceName () |
| Returns a human-readable name for the physical device associated with this mapping. | |
| PhysicalDeviceType | GetPhysicalDeviceType () |
| Returns the physical device type for this mapping. | |
Additional Inherited Members | |
| Protected Attributes inherited from Ship::ControllerMapping | |
| PhysicalDeviceType | mPhysicalDeviceType |
Detailed Description
Base class for controller mappings that represent a physical input.
Extends ControllerMapping to add an interface for querying the name of the specific physical input (e.g. a button label, axis name, or key name). ControllerButtonMapping, ControllerAxisDirectionMapping, and ControllerGyroMapping derive from this class.
Constructor & Destructor Documentation
◆ ControllerInputMapping()
| Ship::ControllerInputMapping::ControllerInputMapping | ( | PhysicalDeviceType | physicalDeviceType | ) |
Constructs a ControllerInputMapping for the given physical device type.
- Parameters
-
physicalDeviceType The type of physical device this input mapping targets.
◆ ~ControllerInputMapping()
| Ship::ControllerInputMapping::~ControllerInputMapping | ( | ) |
Member Function Documentation
◆ GetPhysicalInputName()
|
virtual |
Returns a human-readable name for the physical input this mapping represents.
- Returns
- The physical input name string.
Reimplemented in Ship::KeyboardKeyToAnyMapping, Ship::KeyboardKeyToAxisDirectionMapping, Ship::KeyboardKeyToButtonMapping, Ship::MouseButtonToAnyMapping, Ship::MouseButtonToAxisDirectionMapping, Ship::MouseButtonToButtonMapping, Ship::MouseWheelToAnyMapping, Ship::MouseWheelToAxisDirectionMapping, Ship::MouseWheelToButtonMapping, Ship::SDLAxisDirectionToAnyMapping, Ship::SDLAxisDirectionToAxisDirectionMapping, Ship::SDLAxisDirectionToButtonMapping, Ship::SDLButtonToAnyMapping, Ship::SDLButtonToAxisDirectionMapping, and Ship::SDLButtonToButtonMapping.
The documentation for this class was generated from the following file:
- include/ship/controller/controldevice/controller/mapping/ControllerInputMapping.h
