clGPSDevice Class Reference

#include <Input.h>

List of all members.

Public Member Functions
	clGPSDevice ()
virtual	~clGPSDevice ()
virtual std::string	GetName () const
	Human-readable device name.
virtual bool	Poll ()
	Explicit device polling.
virtual bool	Start ()
	Initialize device.
virtual bool	IsStarted () const
	Is the device started and active.
virtual bool	Stop ()
	Deinitialize device.
virtual int	GetNumAxes () const
	number of axes for mouses/gamepads/joysticks
virtual bool	SetAxisRange (int AxisIdx, float MinVal, float MaxVal)
	Internal conversion of the axis value to [Min,Max] range.
virtual bool	SetAxisDeadZone (int AxisIdx, float DeadZone)
	Set dead zone (minimum acceptable value) for the axis.
virtual bool	SetAxisSaturation (int AxisIdx, float Saturation)
	Set saturation value (high-cutoff, after which the axis is considered being at full swing)
virtual LVector3	GetValues () const
	shortcut to GetAxisValue() with 3-axis devices
virtual float	GetAxisValue (int AxisIdx) const
	get current axis value
virtual std::string	GetAxisName (int AxisIdx) const
	Human-readable axis name.
virtual void	SetAxisValue (int AxisIdx, float Val)
	External override for axis values.
virtual std::string	GetKeyName (int KeyIdx) const
	Human-readable key/button name.
virtual bool	IsPressed (int KeyIdx) const
	check if the key/button is pressed
virtual int	GetNumKeys () const
	Number of buttons for gamepads/mouses/keyboards.
virtual void	SetKeyState (int KeyIdx, bool Pressed)
	External override for key states.
Static Public Attributes
static const int	GPS_ALTITUDE = 0
static const int	GPS_LATITUDE = 1
static const int	GPS_LONGITUDE = 2
static const int	GPS_SPEED = 3
static const int	GPS_BEARING = 4
static const int	GPS_TIME = 5
Private Attributes
bool	FStarted

---

Constructor & Destructor Documentation

clGPSDevice::clGPSDevice

(

)

[inline]

virtual clGPSDevice::~clGPSDevice

(

)

[inline, virtual]

---

Member Function Documentation

virtual std::string clGPSDevice::GetAxisName

(

int

AxisIdx

)

const [inline, virtual]

Human-readable axis name.

Implements iInputDevice.

virtual float clGPSDevice::GetAxisValue

(

int

AxisIdx

)

const [inline, virtual]

get current axis value

Implements iInputDevice.

virtual std::string clGPSDevice::GetKeyName

(

int

KeyIdx

)

const [inline, virtual]

Human-readable key/button name.

Implements iInputDevice.

virtual std::string clGPSDevice::GetName

(

)

const [inline, virtual]

Human-readable device name.

Implements iInputDevice.

virtual int clGPSDevice::GetNumAxes

(

)

const [inline, virtual]

number of axes for mouses/gamepads/joysticks

Implements iInputDevice.

virtual int clGPSDevice::GetNumKeys

(

)

const [inline, virtual]

Number of buttons for gamepads/mouses/keyboards.

Implements iInputDevice.

virtual LVector3 clGPSDevice::GetValues

(

)

const [inline, virtual]

shortcut to GetAxisValue() with 3-axis devices

Reimplemented from iInputDevice.

virtual bool clGPSDevice::IsPressed

(

int

KeyIdx

)

const [inline, virtual]

check if the key/button is pressed

Implements iInputDevice.

virtual bool clGPSDevice::IsStarted

(

)

const [inline, virtual]

Is the device started and active.

Implements iInputDevice.

virtual bool clGPSDevice::Poll

(

)

[inline, virtual]

Explicit device polling.

Implements iInputDevice.

virtual bool clGPSDevice::SetAxisDeadZone	(	int	AxisIdx,
		float	DeadZone
	)		[inline, virtual]

Set dead zone (minimum acceptable value) for the axis.

Implements iInputDevice.

virtual bool clGPSDevice::SetAxisRange	(	int	AxisIdx,
		float	MinVal,
		float	MaxVal
	)		[inline, virtual]

Internal conversion of the axis value to [Min,Max] range.

Implements iInputDevice.

virtual bool clGPSDevice::SetAxisSaturation	(	int	AxisIdx,
		float	Saturation
	)		[inline, virtual]

Set saturation value (high-cutoff, after which the axis is considered being at full swing)

Implements iInputDevice.

virtual void clGPSDevice::SetAxisValue	(	int	AxisIdx,
		float	Val
	)		[inline, virtual]

External override for axis values.

Implements iInputDevice.

virtual void clGPSDevice::SetKeyState	(	int	KeyIdx,
		bool	Pressed
	)		[inline, virtual]

External override for key states.

Implements iInputDevice.

bool clGPSDevice::Start

(

)

[virtual]

Initialize device.

Implements iInputDevice.

bool clGPSDevice::Stop

(

)

[virtual]

Deinitialize device.

Implements iInputDevice.

---

Member Data Documentation

bool clGPSDevice::FStarted [private]

const int clGPSDevice::GPS_ALTITUDE = 0 [static]

const int clGPSDevice::GPS_BEARING = 4 [static]

const int clGPSDevice::GPS_LATITUDE = 1 [static]

const int clGPSDevice::GPS_LONGITUDE = 2 [static]

const int clGPSDevice::GPS_SPEED = 3 [static]

const int clGPSDevice::GPS_TIME = 5 [static]

---

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

• Input.h
• Input.cpp