nite::HandTrackerFrameRef Class Reference

#include <NiTE.h>

List of all members.

Public Member Functions
	HandTrackerFrameRef ()
	HandTrackerFrameRef (const HandTrackerFrameRef &other)
	~HandTrackerFrameRef ()
openni::VideoFrameRef	getDepthFrame () const
int	getFrameIndex () const
const Array< GestureData > &	getGestures () const
const Array< HandData > &	getHands () const
uint64_t	getTimestamp () const
bool	isValid () const
HandTrackerFrameRef &	operator= (const HandTrackerFrameRef &other)
void	release ()
Friends
class	HandTracker

---

Detailed Description

Snapshot of the Hand Tracker algorithm. It contains all output from a single frame of the Hand Tracking algorithm, which corresponds to a single input depth frame.

It holds all the hands identified at this time, as well as the detected gestures.

See also:

HandTracker for how this data is created

---

Constructor & Destructor Documentation

nite::HandTrackerFrameRef::HandTrackerFrameRef

(

)

[inline]

Default constructor. Creates a new empty HandTrackerFrameRef. This object will not be valid or useful until it has been initalized with data from a specific frame.

nite::HandTrackerFrameRef::~HandTrackerFrameRef

(

)

[inline]

Destructor. Calls the provided release() function.

nite::HandTrackerFrameRef::HandTrackerFrameRef

(

const HandTrackerFrameRef &

other

)

[inline]

Copy constructor. Creates a HandTrackerFrameRef that is identical to and existing one.

Parameters:

[in]

@ref

HandTrackerFrameRef to be copied.

---

Member Function Documentation

openni::VideoFrameRef nite::HandTrackerFrameRef::getDepthFrame

(

)

const [inline]

Provides the raw depth frame used to generate this Hand Tracker frame. See the OpenNI 2.0 documentation for more information on manipulating this data.

Returns:

VideoFrameRef used to create this object.

int nite::HandTrackerFrameRef::getFrameIndex

(

)

const [inline]

Gets the frame index of the raw depth frame that generated this frame. Frame indexes are consequitive integer numbers assigned to frames by OpenNI. See the OpenNI documentation for more information.

Returns:

FrameIndex of the depth frame used to generate this User Tracker frame.

const Array<GestureData>& nite::HandTrackerFrameRef::getGestures

(

)

const [inline]

This function provides a list of all gestures being actively detected in this frame.

Returns:

Array of GestureData objects, one for each gesture being detected.

const Array<HandData>& nite::HandTrackerFrameRef::getHands

(

)

const [inline]

This function provides a list of all hands being tracked in this frame.

Returns:

Array of HandData objects, one for each hand being tracked.

uint64_t nite::HandTrackerFrameRef::getTimestamp

(

)

const [inline]

Get the timestamp in which this frame was processed. See the OpenNI 2.0 documentation for more information on how OpenNI assigns time stamps to depth frames.

Returns:

Timestamp in microseconds

bool nite::HandTrackerFrameRef::isValid

(

)

const [inline]

Indicates whether this object has been loaded with valid data.

Returns:

True if this object contains valid data, false otherwise.

HandTrackerFrameRef& nite::HandTrackerFrameRef::operator=

(

const HandTrackerFrameRef &

other

)

[inline]

Operator. Impliments the assignment operator for this class.

Parameters:

[in]

other

HandTrackerFrameRef to be assigned.

void nite::HandTrackerFrameRef::release

(

)

[inline]

Properly releases all resources used by this object. This function is automatically called by the destructor, but it is a good practice to release the resources as soon as they are no longer required. It is safe to run this function multiple times on the same object.

---

Friends And Related Function Documentation

friend class HandTracker [friend]

---

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

• NiTE.h