WPILib 2012
WPILibRoboticsLibraryforFRC
Classes | Public Types | Public Member Functions | Static Public Member Functions
Kinect Class Reference
Inheritance diagram for Kinect:
SensorBase ErrorBase

List of all members.

Classes

struct  Point4

Public Types

enum  SkeletonTrackingState { kNotTracked, kPositionOnly, kTracked }
enum  SkeletonQuality { kClippedRight = 1, kClippedLeft = 2, kClippedTop = 4, kClippedBottom = 8 }

Public Member Functions

int GetNumberOfPlayers ()
Point4 GetFloorClipPlane ()
Point4 GetGravityNormal ()
Skeleton GetSkeleton (int skeletonIndex=1)
Point4 GetPosition (int skeletonIndex=1)
UINT32 GetQuality (int skeletonIndex=1)
SkeletonTrackingState GetTrackingState (int skeletonIndex=1)

Static Public Member Functions

static KinectGetInstance ()

Member Function Documentation

Kinect::Point4 Kinect::GetFloorClipPlane ( )

Get the floor clip plane as defined in the Kinect SDK

Returns:
The floor clip plane
Kinect::Point4 Kinect::GetGravityNormal ( )

Get the gravity normal from the kinect as defined in the Kinect SDK

Returns:
The gravity normal (w is ignored)
Kinect * Kinect::GetInstance ( ) [static]

Get the one and only Kinect object

Returns:
pointer to a Kinect
int Kinect::GetNumberOfPlayers ( )

Get the number of tracked players on the Kinect

Returns:
the number of players being actively tracked
Kinect::Point4 Kinect::GetPosition ( int  skeletonIndex = 1)

Get the current position of the skeleton

Parameters:
skeletonIndexthe skeleton to read from
Returns:
the current position as defined in the Kinect SDK (w is ignored)
UINT32 Kinect::GetQuality ( int  skeletonIndex = 1)

Get the quality of the skeleton. Quality masks are defined in the SkeletonQuality enum

Parameters:
skeletonIndexthe skeleton to read from
Returns:
the quality value as defined in the Kinect SDK
Skeleton Kinect::GetSkeleton ( int  skeletonIndex = 1)

Get the skeleton data Returns the detected skeleton data from the kinect as defined in the Kinect SDK

Parameters:
skeletonIndexWhich of (potentially 2) skeletons to return. This is ignored in this implementation and only a single skeleton is supported for the FRC release default gesture interpretation.
Returns:
The current version of the skeleton object.
Kinect::SkeletonTrackingState Kinect::GetTrackingState ( int  skeletonIndex = 1)

Get the TrackingState of the skeleton. Tracking states are defined in the SkeletonTrackingState enum

Parameters:
skeletonIndexthe skeleton to read from
Returns:
the tracking state value as defined in the Kinect SDK

The documentation for this class was generated from the following files:
 All Classes Functions Variables