NiTE 2.0: nite::GestureData Class Reference

NiTE 2.0

nite::GestureData Class Reference

#include <NiTE.h>

Inheritance diagram for nite::GestureData:

List of all members.

Public Member Functions

const Point3fgetCurrentPosition () const
GestureType getType () const
bool isComplete () const
bool isInProgress () const

Detailed Description

This class stores data on a gesture that is being detected. "Gestures" in this context indicate gestures detected directly from the depthmap, so there are no handpoint ID's at this stage. Objects of this class store the data for a specific instance of a specific gesture.

The type, position in space, and completion status of the gesture can all be tracked.

All positions are given in "real world" coordinates. See the OpenNI 2.0 documentation for more information on the coordinate systems used by OpenNI/NiTE.

See also:
GestureType enumeration for a list of available hand gestures.
HandTracker for more information on using gestures.

Member Function Documentation

const Point3f& nite::GestureData::getCurrentPosition ( ) const [inline]

This function provides the position in space of the projected gesture, using "real world" coordinates.

Returns:
The position of the gesture being detected.
GestureType nite::GestureData::getType ( ) const [inline]

This function is used to find out what type of gesture that this object is storing detection data for.

Returns:
the type of gesture.
See also:
GestureType for a list of valid gestures.
bool nite::GestureData::isComplete ( ) const [inline]

This function indicates whether the complete gesture has been detected yet.

Returns:
True if the gesture is complete, false otherwise.
See also:
isInProgress() to detect gestures that are only partially complete.
bool nite::GestureData::isInProgress ( ) const [inline]

This function indicates whether a non-completed gesture has been detected. This can be useful for providing user feedback during the gesture.

Returns:
True if a gesture is currently being detected. False if detection is complete or has not yet started.
See also:
isComplete() to detect only the completed gesture rather than a gesture in progress.

The documentation for this class was generated from the following file:
Generated on Thu Jun 6 2013 17:48:15 for NiTE 2.0 by   doxygen 1.7.5.1