From 8898ad9b25fca6afe2374d293a981db02a83d7e9 Mon Sep 17 00:00:00 2001 From: "FWoltermann@gmail.com" Date: Thu, 31 May 2012 14:46:27 +0000 Subject: Committing the documentation to svn to have it accessible online --- Doc/doxygen/html/class_joystick.html | 1304 ++++++++++++++++++++++++++++++++++ 1 file changed, 1304 insertions(+) create mode 100644 Doc/doxygen/html/class_joystick.html (limited to 'Doc/doxygen/html/class_joystick.html') diff --git a/Doc/doxygen/html/class_joystick.html b/Doc/doxygen/html/class_joystick.html new file mode 100644 index 0000000..48fcafe --- /dev/null +++ b/Doc/doxygen/html/class_joystick.html @@ -0,0 +1,1304 @@ + + + + + +Starshatter_Open: Joystick Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Member Functions | +Static Public Member Functions | +Protected Member Functions | +Protected Attributes
+
+
Joystick Class Reference
+
+
+ +

#include <Joystick.h>

+
+Inheritance diagram for Joystick:
+
+
+ + +MotionController + +
+ +

List of all members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 Joystick ()
virtual ~Joystick ()
virtual void MapKeys (KeyMapEntry *mapping, int nkeys)
virtual void Acquire ()
virtual double X ()
virtual double Y ()
virtual double Z ()
virtual double Pitch ()
virtual double Roll ()
virtual double Yaw ()
virtual int Center ()
virtual double Throttle ()
virtual void SetThrottle (double throttle)
virtual int Action (int n)
virtual int ActionMap (int n)
- Public Member Functions inherited from MotionController
 MotionController ()
virtual ~MotionController ()
StatusValue Status () const
int Sensitivity () const
int DeadZone () const
int Swapped () const
int Inverted () const
int RudderEnabled () const
int ThrottleEnabled () const
int Selector () const
virtual void SetSensitivity (int sense, int dead)
virtual void SetSelector (int sel)
virtual void SetRudderEnabled (int rud)
virtual void SetThrottleEnabled (int t)
virtual void SwapYawRoll (int swap)
virtual int GetSwapYawRoll ()
virtual void InvertPitch (int inv)
virtual int GetInverted ()
+ + + + + + + + + + + +

+Static Public Member Functions

static const char * TYPENAME ()
static bool KeyDown (int key)
static bool KeyDownMap (int key)
static Joystick * GetInstance ()
static void EnumerateDevices ()
static int NumDevices ()
static const char * GetDeviceName (int i)
static int ReadRawAxis (int axis)
static int GetAxisMap (int n)
static int GetAxisInv (int n)
+ + + + + +

+Protected Member Functions

double ReadAxisDI (int axis)
double ReadAxisMM (int axis)
void ProcessAxes (double joy_x, double joy_y, double joy_r, double joy_t)
void ProcessHat (int i, DWORD joy_pov)
+ + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

double x
double y
double z
double p
double r
double w
double t
bool action [MotionController::MaxActions]
bool hat [4][4]
int map [KEY_MAP_SIZE]
int map_axis [4]
bool inv_axis [4]
- Protected Attributes inherited from MotionController
StatusValue status
int sensitivity
int dead_zone
int swapped
int inverted
int rudder
int throttle
int select
+ + + + +

+Additional Inherited Members

- Public Types inherited from MotionController
enum  StatusValue { StatusOK, +StatusErr, +StatusBadParm + }
enum  ActionValue { MaxActions = 32 + }
+

Detailed Description

+
+

Definition at line 22 of file Joystick.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + +
Joystick::Joystick ()
+
+ +

Definition at line 49 of file Joystick.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Joystick::~Joystick ()
+ 		+virtual
+
+ +

Definition at line 106 of file Joystick.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
void Joystick::Acquire ()
+ 		+virtual
+
+ +

Reimplemented from MotionController.

+ +

Definition at line 521 of file Joystick.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual int Joystick::Action (int n)
+ 		+inlinevirtual
+
+ +

Reimplemented from MotionController.

+ +

Definition at line 52 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual int Joystick::ActionMap (int n)
+ 		+inlinevirtual
+
+ +

Reimplemented from MotionController.

+ +

Definition at line 53 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual int Joystick::Center ()
+ 		+inlinevirtual
+
+ +

Reimplemented from MotionController.

+ +

Definition at line 45 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void Joystick::EnumerateDevices ()
+ 		+static
+
+ +

Definition at line 319 of file Joystick.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int Joystick::GetAxisInv (int n)
+ 		+static
+
+ +

Definition at line 812 of file Joystick.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int Joystick::GetAxisMap (int n)
+ 		+static
+
+ +

Definition at line 804 of file Joystick.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
const char * Joystick::GetDeviceName (int i)
+ 		+static
+
+ +

Definition at line 355 of file Joystick.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Joystick * Joystick::GetInstance ()
+ 		+static
+
+ +

Definition at line 126 of file Joystick.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool Joystick::KeyDown (int key)
+ 		+static
+
+ +

Definition at line 766 of file Joystick.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool Joystick::KeyDownMap (int key)
+ 		+static
+
+ +

Definition at line 791 of file Joystick.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void Joystick::MapKeys (KeyMapEntry * mapping,
int nkeys 
)
+ 		+virtual
+
+ +

Reimplemented from MotionController.

+ +

Definition at line 134 of file Joystick.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int Joystick::NumDevices ()
+ 		+static
+
+ +

Definition at line 349 of file Joystick.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual double Joystick::Pitch ()
+ 		+inlinevirtual
+
+ +

Reimplemented from MotionController.

+ +

Definition at line 42 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void Joystick::ProcessAxes (double joy_x,
double joy_y,
double joy_r,
double joy_t 
)
+ 		+protected
+
+ +

Definition at line 678 of file Joystick.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void Joystick::ProcessHat (int i,
DWORD joy_pov 
)
+ 		+protected
+
+ +

Definition at line 735 of file Joystick.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
double Joystick::ReadAxisDI (int axis)
+ 		+protected
+
+ +

Definition at line 417 of file Joystick.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
double Joystick::ReadAxisMM (int axis)
+ 		+protected
+
+ +

Definition at line 463 of file Joystick.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int Joystick::ReadRawAxis (int axis)
+ 		+static
+
+ +

Definition at line 369 of file Joystick.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual double Joystick::Roll ()
+ 		+inlinevirtual
+
+ +

Reimplemented from MotionController.

+ +

Definition at line 43 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual void Joystick::SetThrottle (double throttle)
+ 		+inlinevirtual
+
+ +

Reimplemented from MotionController.

+ +

Definition at line 49 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual double Joystick::Throttle ()
+ 		+inlinevirtual
+
+ +

Reimplemented from MotionController.

+ +

Definition at line 48 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
static const char* Joystick::TYPENAME ()
+ 		+inlinestatic
+
+ +

Reimplemented from MotionController.

+ +

Definition at line 25 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual double Joystick::X ()
+ 		+inlinevirtual
+
+ +

Reimplemented from MotionController.

+ +

Definition at line 37 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual double Joystick::Y ()
+ 		+inlinevirtual
+
+ +

Reimplemented from MotionController.

+ +

Definition at line 38 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual double Joystick::Yaw ()
+ 		+inlinevirtual
+
+ +

Reimplemented from MotionController.

+ +

Definition at line 44 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual double Joystick::Z ()
+ 		+inlinevirtual
+
+ +

Reimplemented from MotionController.

+ +

Definition at line 39 of file Joystick.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
bool Joystick::action[MotionController::MaxActions]
+ 		+protected
+
+ +

Definition at line 74 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool Joystick::hat[4][4]
+ 		+protected
+
+ +

Definition at line 75 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool Joystick::inv_axis[4]
+ 		+protected
+
+ +

Definition at line 78 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int Joystick::map[KEY_MAP_SIZE]
+ 		+protected
+
+ +

Definition at line 76 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int Joystick::map_axis[4]
+ 		+protected
+
+ +

Definition at line 77 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double Joystick::p
+ 		+protected
+
+ +

Definition at line 73 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double Joystick::r
+ 		+protected
+
+ +

Definition at line 73 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double Joystick::t
+ 		+protected
+
+ +

Definition at line 73 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double Joystick::w
+ 		+protected
+
+ +

Definition at line 73 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double Joystick::x
+ 		+protected
+
+ +

Definition at line 73 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double Joystick::y
+ 		+protected
+
+ +

Definition at line 73 of file Joystick.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double Joystick::z
+ 		+protected
+
+ +

Definition at line 73 of file Joystick.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.1