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_motion_controller.html | 1289 +++++++++++++++++++++++++ 1 file changed, 1289 insertions(+) create mode 100644 Doc/doxygen/html/class_motion_controller.html (limited to 'Doc/doxygen/html/class_motion_controller.html') diff --git a/Doc/doxygen/html/class_motion_controller.html b/Doc/doxygen/html/class_motion_controller.html new file mode 100644 index 0000000..466760e --- /dev/null +++ b/Doc/doxygen/html/class_motion_controller.html @@ -0,0 +1,1289 @@ + + + + + +Starshatter_Open: MotionController Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Types | +Public Member Functions | +Static Public Member Functions | +Protected Attributes
+
+
MotionController Class Reference
+
+
+ +

#include <MotionController.h>

+
+Inheritance diagram for MotionController:
+
+
+ + +Joystick +Keyboard +MouseController +MultiController + +
+ +

List of all members.

+ + + + +

+Public Types

enum  StatusValue { StatusOK, +StatusErr, +StatusBadParm + }
enum  ActionValue { MaxActions = 32 + }
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 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 ()
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 t)
virtual int Action (int n)
virtual int ActionMap (int n)
+ + +

+Static Public Member Functions

static const char * TYPENAME ()
+ + + + + + + + + +

+Protected Attributes

StatusValue status
int sensitivity
int dead_zone
int swapped
int inverted
int rudder
int throttle
int select
+

Detailed Description

+
+

Definition at line 155 of file MotionController.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum MotionController::ActionValue
+
+
Enumerator:
+ +
MaxActions  +
+
+
+ +

Definition at line 167 of file MotionController.h.

+ +
+
+ +
+
+ + + + +
enum MotionController::StatusValue
+
+
Enumerator:
+ + + +
StatusOK  +
StatusErr  +
StatusBadParm  +
+
+
+ +

Definition at line 166 of file MotionController.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + +
+ + + + + + + +
MotionController::MotionController ()
+ 		+inline
+
+ +

Definition at line 160 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual MotionController::~MotionController ()
+ 		+inlinevirtual
+
+ +

Definition at line 164 of file MotionController.h.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
virtual void MotionController::Acquire ()
+ 		+inlinevirtual
+
+ +

Reimplemented in MultiController, Joystick, Keyboard, and MouseController.

+ +

Definition at line 198 of file MotionController.h.

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

Reimplemented in MultiController, Joystick, Keyboard, and MouseController.

+ +

Definition at line 216 of file MotionController.h.

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

Reimplemented in MultiController, Joystick, Keyboard, and MouseController.

+ +

Definition at line 217 of file MotionController.h.

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

Reimplemented in MultiController, Joystick, Keyboard, and MouseController.

+ +

Definition at line 209 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int MotionController::DeadZone () const
+ 		+inline
+
+ +

Definition at line 171 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual int MotionController::GetInverted ()
+ 		+inlinevirtual
+
+ +

Definition at line 193 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
virtual int MotionController::GetSwapYawRoll ()
+ 		+inlinevirtual
+
+ +

Definition at line 191 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int MotionController::Inverted () const
+ 		+inline
+
+ +

Definition at line 173 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual void MotionController::InvertPitch (int inv)
+ 		+inlinevirtual
+
+ +

Definition at line 192 of file MotionController.h.

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

Reimplemented in Joystick, Keyboard, MouseController, and MultiController.

+ +

Definition at line 195 of file MotionController.h.

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

Reimplemented in MultiController, Joystick, Keyboard, and MouseController.

+ +

Definition at line 206 of file MotionController.h.

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

Reimplemented in MultiController, Joystick, Keyboard, and MouseController.

+ +

Definition at line 207 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int MotionController::RudderEnabled () const
+ 		+inline
+
+ +

Definition at line 174 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int MotionController::Selector () const
+ 		+inline
+
+ +

Definition at line 176 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int MotionController::Sensitivity () const
+ 		+inline
+
+ +

Definition at line 170 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual void MotionController::SetRudderEnabled (int rud)
+ 		+inlinevirtual
+
+ +

Definition at line 187 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual void MotionController::SetSelector (int sel)
+ 		+inlinevirtual
+
+ +

Definition at line 186 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
virtual void MotionController::SetSensitivity (int sense,
int dead 
)
+ 		+inlinevirtual
+
+ +

Definition at line 180 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual void MotionController::SetThrottle (double t)
+ 		+inlinevirtual
+
+ +

Reimplemented in MultiController, Joystick, Keyboard, and MouseController.

+ +

Definition at line 213 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual void MotionController::SetThrottleEnabled (int t)
+ 		+inlinevirtual
+
+ +

Definition at line 188 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
StatusValue MotionController::Status () const
+ 		+inline
+
+ +

Definition at line 169 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int MotionController::Swapped () const
+ 		+inline
+
+ +

Definition at line 172 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
virtual void MotionController::SwapYawRoll (int swap)
+ 		+inlinevirtual
+
+ +

Reimplemented in MultiController.

+ +

Definition at line 190 of file MotionController.h.

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

Reimplemented in MultiController, Joystick, Keyboard, and MouseController.

+ +

Definition at line 212 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int MotionController::ThrottleEnabled () const
+ 		+inline
+
+ +

Definition at line 175 of file MotionController.h.

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

Reimplemented in Joystick, Keyboard, MouseController, and MultiController.

+ +

Definition at line 158 of file MotionController.h.

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

Reimplemented in MultiController, Joystick, Keyboard, and MouseController.

+ +

Definition at line 201 of file MotionController.h.

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

Reimplemented in MultiController, Joystick, Keyboard, and MouseController.

+ +

Definition at line 202 of file MotionController.h.

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

Reimplemented in MultiController, Joystick, Keyboard, and MouseController.

+ +

Definition at line 208 of file MotionController.h.

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

Reimplemented in MultiController, Joystick, Keyboard, and MouseController.

+ +

Definition at line 203 of file MotionController.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
int MotionController::dead_zone
+ 		+protected
+
+ +

Definition at line 222 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MotionController::inverted
+ 		+protected
+
+ +

Definition at line 224 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MotionController::rudder
+ 		+protected
+
+ +

Definition at line 225 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MotionController::select
+ 		+protected
+
+ +

Definition at line 227 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MotionController::sensitivity
+ 		+protected
+
+ +

Definition at line 221 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
StatusValue MotionController::status
+ 		+protected
+
+ +

Definition at line 220 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MotionController::swapped
+ 		+protected
+
+ +

Definition at line 223 of file MotionController.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MotionController::throttle
+ 		+protected
+
+ +

Definition at line 226 of file MotionController.h.

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