Phx::LogicalInputEngine::AxisSpec Class Reference

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

#include <PhxLogicalInputEngine.h>

List of all members.

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

---

Detailed Description

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

This value is used to configure the AnalogAxisDriver and AnalogButtonDriver.

---

Constructor & Destructor Documentation

Phx::LogicalInputEngine::AxisSpec::AxisSpec (  const String &  driverName, RawInputEngine::AxisIdentifier  identifier )  [inline]

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

---

Member Function Documentation

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

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

RawInputEngine::AxisIdentifier Phx::LogicalInputEngine::AxisSpec::identifier (  void   )  const [inline]

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

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

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

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

Performs equality comparison of a AxisSpec to this one. Parameters: b  The AxisSpec 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 AxisSpec.

---

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

• PhxLogicalInputEngine.h

---