Package komposten.leapjna.leapc.events

Class LEAP_TRACKING_EVENT

java.lang.Object

com.sun.jna.Structure

komposten.leapjna.leapc.events.LEAP_TRACKING_EVENT

All Implemented Interfaces:

LEAP_EVENT

@FieldOrder({"info","tracking_frame_id","nHands","pHands","framerate"})
public class LEAP_TRACKING_EVENT
extends Structure
implements LEAP_EVENT

A snapshot, or frame of data, containing the tracking data for a single moment in time.

Since:

LeapJna 1.0.0, Ultraleap Orion SDK 3.0.0

See Also:

• LeapC API - LEAP_TRACKING_EVENT

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.jna.Structure

Structure.ByReference, Structure.ByValue, Structure.FieldOrder, Structure.StructField

Field Summary

Fields

Modifier and Type	Field	Description
float	framerate	Current tracking frame rate in hertz.
LEAP_FRAME_HEADER	info	A universal frame identification header.
int	nHands	The number of hands tracked in this frame.
Pointer	pHands	A pointer to the array of hands tracked in this frame.
long	tracking_frame_id	An identifier for this tracking frame.

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor	Description
LEAP_TRACKING_EVENT()
LEAP_TRACKING_EVENT(int size)
LEAP_TRACKING_EVENT(Pointer pointer)

Method Summary

Modifier and Type	Method	Description
LEAP_HAND[]	getHands()
void	read()

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFieldOrder, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

info

public LEAP_FRAME_HEADER info

A universal frame identification header.

tracking_frame_id

public long tracking_frame_id

An identifier for this tracking frame.

This identifier is meant to be monotonically increasing, but values may be skipped if the client application does not poll for messages fast enough. This number also generally increases at the same rate as info.frame_id, but if the server cannot process every image received from the device cameras, the info.frame_id identifier may increase faster.

nHands

public int nHands

The number of hands tracked in this frame. I.e. the number of elements in the pHands array.

pHands

public Pointer pHands

A pointer to the array of hands tracked in this frame. Use getHands() to obtain the array itself.

framerate

public float framerate

Current tracking frame rate in hertz.

This frame rate is distinct from the image frame rate, which is the rate that images are being read from the device. Depending on host CPU limitations, the tracking frame rate may be substantially less than the device frame rate.

This number is generally equal to or less than the device frame rate, but there is one case where this number may be higher than the device frame rate: When the device rate drops. In this case, the device frame rate will fall sooner than the tracking frame rate.

This number is equal to zero if there are not enough frames to estimate frame rate.

This number cannot be negative.

Constructor Details

LEAP_TRACKING_EVENT

public LEAP_TRACKING_EVENT()

LEAP_TRACKING_EVENT

public LEAP_TRACKING_EVENT(int size)

LEAP_TRACKING_EVENT

public LEAP_TRACKING_EVENT(Pointer pointer)

Method Details

getHands

public LEAP_HAND[] getHands()

Returns:

An array of LEAP_HAND structs holding the hand data for this frame.

read

public void read()

Overrides:

read in class Structure