Phx::LogicalInputEngine::AnalogAxisDriver Class Reference

A LogicalInputEngine driver that binds a logical axis directly to an raw axis. More...

#include <PhxLogicalInputEngine.h>

Inheritance diagram for Phx::LogicalInputEngine::AnalogAxisDriver:

List of all members.

Public Member Functions
virtual void	axis (const AxisSpec &axis)=0
	Specifies which RawInputEngine axis this driver is bound to.
virtual AxisSpec	axis (void) const =0
	Gets the current AxisSpec to which this driver is bound.
virtual void	axisMax (RawInputEngine::AxisState axisMax)=0
	Sets the raw axis value that maps to the maximum of the logical range.
virtual RawInputEngine::AxisState	axisMax (void) const =0
	Gets the raw axis value mapped to the maximum of the logical range.
virtual void	axisCenter (RawInputEngine::AxisState axisCenter)=0
	Sets the raw axis center value.
virtual RawInputEngine::AxisState	axisCenter (void) const =0
	Gets the raw axis center value.
virtual void	axisMin (RawInputEngine::AxisState axisMin)=0
	Sets the raw axis value that maps to the minimum of the logical axis range.
virtual RawInputEngine::AxisState	axisMin (void) const =0
	Gets the minimum raw axis value.

---

Detailed Description

A LogicalInputEngine driver that binds a logical axis directly to an raw axis.

Note that the axisMax, axisMin, and axisCenter values are used to calibrate the axis. By default, they are all set to 0, resulting in an axis that doesn't move -- you will need to set appropriate values in order for the axis to respond properly. When axisMax() < axisMin(), axisMax() < axisCenter() or axisMin() > axisCenter(), the mapping from raw to logical values becomes invalid. In these cases, the logical value 0 is output.

---

Member Function Documentation

virtual AxisSpec Phx::LogicalInputEngine::AnalogAxisDriver::axis (  void   )  const [pure virtual]

Gets the current AxisSpec to which this driver is bound. Returns: The AxisSpec specifying which raw axis this driver is bound to.

virtual void Phx::LogicalInputEngine::AnalogAxisDriver::axis (  const AxisSpec &  axis  )  [pure virtual]

Specifies which RawInputEngine axis this driver is bound to. Parameters: axis  An AxisSpec specifying the driver and identifier of the raw input axis.

virtual RawInputEngine::AxisState Phx::LogicalInputEngine::AnalogAxisDriver::axisCenter (  void   )  const [pure virtual]

Gets the raw axis center value. Returns: The raw axis value that maps to logical value 0.

virtual void Phx::LogicalInputEngine::AnalogAxisDriver::axisCenter (  RawInputEngine::AxisState  axisCenter  )  [pure virtual]

Sets the raw axis center value. Parameters: axisCenter  The raw axis value that maps to logical value 0.

virtual RawInputEngine::AxisState Phx::LogicalInputEngine::AnalogAxisDriver::axisMax (  void   )  const [pure virtual]

Gets the raw axis value mapped to the maximum of the logical range. Returns: The raw axis value that is mapped to logical value +1.

virtual void Phx::LogicalInputEngine::AnalogAxisDriver::axisMax (  RawInputEngine::AxisState  axisMax  )  [pure virtual]

Sets the raw axis value that maps to the maximum of the logical range. This maximum value is the raw value mapped to logical value +1. axisMax The raw axis value that maps to logical value +1, beyond which all other axis inputs will be saturated.

virtual RawInputEngine::AxisState Phx::LogicalInputEngine::AnalogAxisDriver::axisMin (  void   )  const [pure virtual]

Gets the minimum raw axis value. Returns: The raw axis value that is mapped to logical value -1.

virtual void Phx::LogicalInputEngine::AnalogAxisDriver::axisMin (  RawInputEngine::AxisState  axisMin  )  [pure virtual]

Sets the raw axis value that maps to the minimum of the logical axis range. This minimum value is the raw value mapped to logical value -1. axisMin The raw axis value that maps to logical value -1, beyond which all other axis inputs will be saturated.

---

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

• PhxLogicalInputEngine.h

---