stmm-games-doc  0.32.0
Public Member Functions | List of all members
stmi::testing::FakeJoystickCapability Class Reference

Fake joystick capability. More...

Inheritance diagram for stmi::testing::FakeJoystickCapability:
Inheritance graph
[legend]

Public Member Functions

 FakeJoystickCapability (FakeDevice< FakeJoystickCapability > *p0Device) noexcept
 Constructor. More...
 
shared_ptr< DevicegetDevice () const noexcept override
 Returns the device owning this capability, if any. More...
 
bool hasButton (JoystickCapability::BUTTON) const noexcept override
 Not implemented. More...
 
int32_t getTotHats () const noexcept override
 Not implemented. More...
 
bool hasAxis (JoystickCapability::AXIS) const noexcept override
 Not implemented. More...
 
bool isButtonPressed (JoystickCapability::BUTTON) const noexcept override
 Not implemented. More...
 
HAT_VALUE getHatValue (int32_t) const noexcept override
 Not implemented. More...
 
int32_t getAxisValue (JoystickCapability::AXIS) const noexcept override
 Not implemented. More...
 
- Public Member Functions inherited from stmi::Capability
virtual ~Capability () noexcept=default
 
int32_t getId () const noexcept
 The capability id. More...
 
const ClassgetCapabilityClass () const noexcept
 Get the registered class of the capability instance. More...
 

Additional Inherited Members

- Public Types inherited from stmi::JoystickCapability
enum  HAT_VALUE {
  HAT_VALUE_NOT_SET = -1, HAT_CENTER = 0, HAT_UP = 4, HAT_RIGHT = 2,
  HAT_DOWN = 8, HAT_LEFT = 1, HAT_RIGHTUP = (HAT_RIGHT | HAT_UP), HAT_RIGHTDOWN = (HAT_RIGHT | HAT_DOWN),
  HAT_LEFTUP = (HAT_LEFT | HAT_UP), HAT_LEFTDOWN = (HAT_LEFT | HAT_DOWN), HAT_CENTER_CANCEL = 16
}
 The valid states of a hat. More...
 
enum  BUTTON {
  BUTTON_TRIGGER = 0x120, BUTTON_THUMB = 0x121, BUTTON_THUMB2 = 0x122, BUTTON_TOP = 0x123,
  BUTTON_TOP2 = 0x124, BUTTON_PINKIE = 0x125, BUTTON_BASE = 0x126, BUTTON_A = 0x130,
  BUTTON_B = 0x131, BUTTON_C = 0x132, BUTTON_X = 0x133, BUTTON_Y = 0x134,
  BUTTON_Z = 0x135, BUTTON_TL = 0x136, BUTTON_TR = 0x137, BUTTON_TL2 = 0x138,
  BUTTON_TR2 = 0x139, BUTTON_SELECT = 0x13a, BUTTON_START = 0x13b, BUTTON_MODE = 0x13c,
  BUTTON_THUMBL = 0x13d, BUTTON_THUMBR = 0x13e, BUTTON_GEAR_DOWN = 0x150, BUTTON_GEAR_UP = 0x151
}
 The valid buttons. More...
 
enum  AXIS {
  AXIS_X = 0x00, AXIS_Y = 0x01, AXIS_Z = 0x02, AXIS_RX = 0x03,
  AXIS_RY = 0x04, AXIS_RZ = 0x05, AXIS_THROTTLE = 0x06, AXIS_RUDDER = 0x07,
  AXIS_WHEEL = 0x08, AXIS_GAS = 0x09, AXIS_BRAKE = 0x0a, AXIS_PRESSURE = 0x18,
  AXIS_DISTANCE = 0x19, AXIS_TILT_X = 0x1a, AXIS_TILT_Y = 0x1b
}
 The valid axes. More...
 
- Static Public Member Functions inherited from stmi::JoystickCapability
static const std::vector< HAT_VALUE > & getHatValues () noexcept
 Returns the defined HAT_VALUE values as an ordered vector (HAT_VALUE_NOT_SET excluded). More...
 
static bool isValidHatValue (HAT_VALUE eValue) noexcept
 Tells whether a hat value is valid. More...
 
static const std::vector< BUTTON > & getButtons () noexcept
 Returns the defined BUTTON values as an ordered vector. More...
 
static bool isValidButton (BUTTON eButton) noexcept
 Tells whether a button value is valid. More...
 
static const std::vector< AXIS > & getAxes () noexcept
 Returns the defined AXIS values as an ordered vector. More...
 
static bool isValidAxis (AXIS eAxis) noexcept
 Tells whether an axis value is valid. More...
 
static constexpr BUTTON getMinButtonValue () noexcept
 The minimal value of enum JoystickCapability::BUTTON. More...
 
static constexpr BUTTON getMaxButtonValue () noexcept
 The maximal value of enum JoystickCapability::BUTTON. More...
 
static constexpr AXIS getMinAxisValue () noexcept
 The minimal value of enum JoystickCapability::AXIS. More...
 
static constexpr AXIS getMaxAxisValue () noexcept
 The maximal value of enum JoystickCapability::AXIS. More...
 
static const Capability::ClassgetClass () noexcept
 
- Static Public Member Functions inherited from stmi::Capability
static bool isCapabilityClassIdRegistered (const std::string &sCapabilityClassId) noexcept
 Tells whether the given capability class id is registered. More...
 
static Class getCapabilityClassIdClass (const std::string &sCapabilityClassId) noexcept
 Gets the class with given class id. More...
 
- Static Public Attributes inherited from stmi::JoystickCapability
static const char *const s_sClassId
 
- Protected Member Functions inherited from stmi::JoystickCapability
 JoystickCapability () noexcept
 Constructor. More...
 
- Protected Member Functions inherited from stmi::Capability
 Capability (const Class &oClass) noexcept
 Constructor to be called from subclasses. More...
 
- Static Protected Member Functions inherited from stmi::Capability
static bool isCapabilityTypeRegistered (const std::type_info &oCapabilityType) noexcept
 Tells whether a capability type was registered. More...
 
static const std::type_info & getCapabilityClassIdType (const std::string &sCapabilityClassId, bool &bRegistered) noexcept
 Gets the type of the registered capability subclass associated with class id. More...
 
static std::string getCapabilityTypeClassId (const std::type_info &oType) noexcept
 Gets the class id of the given type. More...
 

Detailed Description

Fake joystick capability.

Constructor & Destructor Documentation

◆ FakeJoystickCapability()

stmi::testing::FakeJoystickCapability::FakeJoystickCapability ( FakeDevice< FakeJoystickCapability > *  p0Device)
inlinenoexcept

Constructor.

Parameters
p0DeviceThe fake device the instance belongs to. Cannot be null.

Member Function Documentation

◆ getAxisValue()

int32_t stmi::testing::FakeJoystickCapability::getAxisValue ( JoystickCapability::AXIS  ) const
inlineoverridevirtualnoexcept

Not implemented.

Implements stmi::JoystickCapability.

◆ getDevice()

shared_ptr<Device> stmi::testing::FakeJoystickCapability::getDevice ( ) const
inlineoverridevirtualnoexcept

Returns the device owning this capability, if any.

If it's a device manager capability this might return null. It also can be null if the device was deleted.

Implements stmi::Capability.

◆ getHatValue()

HAT_VALUE stmi::testing::FakeJoystickCapability::getHatValue ( int32_t  ) const
inlineoverridevirtualnoexcept

Not implemented.

Implements stmi::JoystickCapability.

◆ getTotHats()

int32_t stmi::testing::FakeJoystickCapability::getTotHats ( ) const
inlineoverridevirtualnoexcept

Not implemented.

Implements stmi::JoystickCapability.

◆ hasAxis()

bool stmi::testing::FakeJoystickCapability::hasAxis ( JoystickCapability::AXIS  ) const
inlineoverridevirtualnoexcept

Not implemented.

Implements stmi::JoystickCapability.

◆ hasButton()

bool stmi::testing::FakeJoystickCapability::hasButton ( JoystickCapability::BUTTON  ) const
inlineoverridevirtualnoexcept

Not implemented.

Implements stmi::JoystickCapability.

◆ isButtonPressed()

bool stmi::testing::FakeJoystickCapability::isButtonPressed ( JoystickCapability::BUTTON  ) const
inlineoverridevirtualnoexcept

Not implemented.

Implements stmi::JoystickCapability.