Now you can download a copy of these docs so you can use them offline! Download now

KinectStick Class Reference

Inheritance diagram for KinectStick:
Collaboration diagram for KinectStick:

List of all members.

Classes

union  KinectStickData

Public Member Functions

 KinectStick (int id)
virtual float GetX (JoystickHand hand=kRightHand)
virtual float GetY (JoystickHand hand=kRightHand)
virtual float GetZ ()
virtual float GetTwist ()
virtual float GetThrottle ()
virtual float GetRawAxis (UINT32 axis)
virtual bool GetTrigger (JoystickHand hand=kRightHand)
virtual bool GetTop (JoystickHand hand=kRightHand)
virtual bool GetBumper (JoystickHand hand=kRightHand)
virtual bool GetRawButton (UINT32 button)

Detailed Description

Definition at line 13 of file KinectStick.h.


Constructor & Destructor Documentation

KinectStick::KinectStick ( int  id  )  [explicit]

Kinect joystick constructor

Parameters:
id value is either 1 or 2 for the left or right joystick decoded from gestures interpreted by the Kinect server on the Driver Station computer.

Definition at line 27 of file KinectStick.cpp.


Member Function Documentation

float KinectStick::GetRawAxis ( UINT32  axis  )  [virtual]

Get the joystick axis value by axis number This is only supported for X in the default gestures and all others always returns 0

Definition at line 87 of file KinectStick.cpp.

float KinectStick::GetThrottle (  )  [virtual]

Get the Throttle joystick value This is not supported in the default gestures and always returns 0

Definition at line 78 of file KinectStick.cpp.

bool KinectStick::GetTop ( JoystickHand  hand = kRightHand  )  [virtual]

Get the top button value for the joystick

Parameters:
hand 
Returns:
true if the top button is pressed

Definition at line 111 of file KinectStick.cpp.

bool KinectStick::GetTrigger ( JoystickHand  hand = kRightHand  )  [virtual]

Get the trigger value for the joystick

Parameters:
hand 
Returns:
true if the triger is pressed

Definition at line 101 of file KinectStick.cpp.

float KinectStick::GetTwist (  )  [virtual]

Get the Twist joystick value This is not supported in the default gestures and always returns 0

Definition at line 69 of file KinectStick.cpp.

float KinectStick::GetX ( JoystickHand  hand = kRightHand  )  [virtual]

Get the X joystick value This is not supported in the default gestures and always returns 0

Definition at line 41 of file KinectStick.cpp.

float KinectStick::GetY ( JoystickHand  hand = kRightHand  )  [virtual]

Get the joystick Y value

Parameters:
hand 
Returns:
The floating point representation of the Y value

Definition at line 51 of file KinectStick.cpp.

float KinectStick::GetZ (  )  [virtual]

Get the Z joystick value This is not supported in the default gestures and always returns 0

Definition at line 60 of file KinectStick.cpp.


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

Generated on Thu Jan 12 2012 22:35:33 for WPILibC++ by doxygen 1.7.1