com.primesense.nite
Class HandTrackerFrameRef

java.lang.Object
  extended by com.primesense.nite.HandTrackerFrameRef

public class HandTrackerFrameRef
extends java.lang.Object

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

Method Summary
protected  void finalize()
           
 org.openni.VideoFrameRef getDepthFrame()
          Provides the raw depth frame used to generate this Hand Tracker frame.
 long getFrameHandle()
          Getter function for frame handle.
 int getFrameIndex()
          Gets the frame index of the raw depth frame that generated this frame.
 java.util.List<GestureData> getGestures()
          This function provides a list of all gestures being actively detected in this frame.
 java.util.List<HandData> getHands()
          This function provides a list of all hands being tracked in this frame.
 long getTimestamp()
          Getter function for timestamp.
 void release()
          Properly releases all resources used by this object.
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getFrameHandle

public long getFrameHandle()
Getter function for frame handle.

Returns:
Frame handle.

getTimestamp

public long getTimestamp()
Getter function for timestamp.

Returns:
Timestamp.

getFrameIndex

public int getFrameIndex()
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.

getHands

public java.util.List<HandData> getHands()
This function provides a list of all hands being tracked in this frame.

Returns:
List of HandData objects, one for each hand being tracked.

getGestures

public java.util.List<GestureData> getGestures()
This function provides a list of all gestures being actively detected in this frame.

Returns:
List of GestureData objects, one for each gesture being detected.

getDepthFrame

public org.openni.VideoFrameRef getDepthFrame()
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.

release

public void release()
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.


finalize

protected void finalize()
                 throws java.lang.Throwable
Overrides:
finalize in class java.lang.Object
Throws:
java.lang.Throwable