Phx::LogicalInputEngine::AxisClient Class Reference

A sub-interface of LogicalInputEngine that allows a client to retrieve the state of a logical axis. More...

#include <PhxLogicalInputEngine.h>

Inheritance diagram for Phx::LogicalInputEngine::AxisClient:

List of all members.

Public Member Functions
virtual void	listener (Listener *listener)=0
	Sets the listener that will be notified when the axis state changes.
virtual AxisState	axisState (void) const =0
	Gets the axis state for this logical axis.
const String &	name (void) const
	Returns the name of this logical axis.
Protected Member Functions
void	setName (const String &name)
Classes
class	Listener
	A listener that allows a client to be notified when the axisState() attribute changes. More...

---

Detailed Description

A sub-interface of LogicalInputEngine that allows a client to retrieve the state of a logical axis.

---

Member Function Documentation

virtual AxisState Phx::LogicalInputEngine::AxisClient::axisState (  void   )  const [pure virtual]

Gets the axis state for this logical axis. Returns: The state of the logical axis, or 0 if the name is not known and/or has no driver attached to it.

virtual void Phx::LogicalInputEngine::AxisClient::listener (  Listener *  listener  )  [pure virtual]

Sets the listener that will be notified when the axis state changes. Parameters: listener  The listener to be notified when axisState() changes.

const String& Phx::LogicalInputEngine::AxisClient::name (  void   )  const [inline]

Returns the name of this logical axis. Returns: The name of this logical axis.

---

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

• PhxLogicalInputEngine.h

---