Phx::LogicalInputEngine::ButtonSpec Class Reference

A value-type that specifies a raw button by its driver and identifier. More...

#include <PhxLogicalInputEngine.h>

List of all members.

Public Member Functions
	ButtonSpec ()
	Creates a default ButtonSpec with driver name "" and identifier RawInputEngine::INVALID_BUTTON_IDENTIFIER.
	ButtonSpec (const String &driverName, RawInputEngine::ButtonIdentifier identifier)
	Creates a ButtonSpec with the given values for its driverName() and identifier() attributes.
bool	operator== (const ButtonSpec &b) const
	Performs equality comparison of a ButtonSpec to this one.
bool	operator!= (const ButtonSpec &b) const
	Performs inequality comparison of a ButtonSpec with this one.
const String &	driverName () const
	Gets the driver name of the specified button's RawInputEngine driver.
RawInputEngine::ButtonIdentifier	identifier () const
	Gets the identifier for the button.
Static Public Attributes
static const ButtonSpec	INVALID
	The default value for new AxisSpec values.

---

Detailed Description

A value-type that specifies a raw button by its driver and identifier.

This value is used to configure the DigitalAxisDriver and DigitalButtonDriver.

---

Constructor & Destructor Documentation

Phx::LogicalInputEngine::ButtonSpec::ButtonSpec (  const String &  driverName, RawInputEngine::ButtonIdentifier  identifier )  [inline]

Creates a ButtonSpec with the given values for its driverName() and identifier() attributes. Parameters: driverName  The name of the RawInputEngine input driver for the button. identifier  The identifier for the button, as defined by the given driver.

---

Member Function Documentation

const String& Phx::LogicalInputEngine::ButtonSpec::driverName (   )  const [inline]

Gets the driver name of the specified button's RawInputEngine driver. Returns: The driver name for the button in the RawInputEngine.

RawInputEngine::ButtonIdentifier Phx::LogicalInputEngine::ButtonSpec::identifier (  void   )  const [inline]

Gets the identifier for the button. Returns: The identifier that specifies a button from those of the driver named by driverName().

bool Phx::LogicalInputEngine::ButtonSpec::operator!= (  const ButtonSpec &  b  )  const [inline]

Performs inequality comparison of a ButtonSpec with this one. Parameters: b  The ButtonSpec to compare with this one. Returns: !this->operator==(b);

bool Phx::LogicalInputEngine::ButtonSpec::operator== (  const ButtonSpec &  b  )  const [inline]

Performs equality comparison of a ButtonSpec to this one. Parameters: b  The ButtonSpec to compare for equality with this one. Returns: true if and only if the driverName() and identifier() attributes of b are the same as those of this ButtonSpec.

---

The documentation for this class was generated from the following file:

• PhxLogicalInputEngine.h

---