LeapGesture Class Reference

The LeapGesture class represents a recognized movement by the user. More...

Inherits NSObject.

Inherited by LeapCircleGesture, LeapKeyTapGesture, LeapScreenTapGesture, and LeapSwipeGesture.

Instance Methods
(BOOL)	- equals:
	Compare LeapGesture object equality. More...

Class Methods
(LeapGesture *)	+ invalid
	Returns an invalid LeapGesture object. More...

Properties
int64_t	duration
	The elapsed duration of the recognized movement up to the frame containing this LeapGesture object, in microseconds. More...
float	durationSeconds
	The elapsed duration in seconds. More...
LeapFrame *	frame
	The LeapFrame containing this LeapGesture instance. More...
NSArray *	hands
	The list of hands associated with this LeapGesture, if any. More...
int32_t	id
	The gesture ID. More...
BOOL	isValid
	Reports whether this LeapGesture instance represents a valid gesture. More...
NSArray *	pointables
	The list of fingers and tools associated with this LeapGesture, if any. More...
LeapGestureState	state
	The gesture state. More...
LeapGestureType	type
	The gesture type. More...

Detailed Description

The LeapGesture class represents a recognized movement by the user.

Method Documentation

- (BOOL) equals:

(const LeapGesture *)

other

Compare LeapGesture object equality.

[thisGesture equals:thatGesture];

Parameters

other

The LeapGesture object to compare.

+ (LeapGesture *) invalid

Returns an invalid LeapGesture object.

LeapGesture *wrongGesture = LeapGesture.invalid;

Returns

The invalid LeapGesture instance.

Property Documentation

- (int64_t) duration

readnonatomicassign

The elapsed duration of the recognized movement up to the frame containing this LeapGesture object, in microseconds.

int64_t microseconds = gesture.duration;

Returns

int64_t the elapsed duration in microseconds.

- (float) durationSeconds

readnonatomicassign

The elapsed duration in seconds.

float seconds = gesture.duration;

See also

duration

Returns

float the elapsed duration in seconds.

- (LeapFrame*) frame

readnonatomicstrong

The LeapFrame containing this LeapGesture instance.

LeapFrame *owningFrame = gesture.frame;

Returns

The parent LeapFrame object.

- (NSArray*) hands

readnonatomicstrong

The list of hands associated with this LeapGesture, if any.

NSArray *handList = gesture.hands;
//Only one hand for current gestures
LeapHand *gesturingHand = [handList objectAtIndex:0];

Returns

NSArray the list of related LeapHand objects.

- (int32_t) id

readnonatomicassign

The gesture ID.

int gestureID = gesture.id;

Returns

int32_t the ID of this LeapGesture.

- (BOOL) isValid

readnonatomicassign

Reports whether this LeapGesture instance represents a valid gesture.

LeapFrame *frame = [controller frame:0];
LeapGesture *trackedGesture = [frame gesture:trackedGestureID];
if(trackedGesture.isValid)
{
    //Use the data...
}

Returns

bool Yes, if this is a valid LeapGesture instance; NO, otherwise.

- (NSArray*) pointables

readnonatomicstrong

The list of fingers and tools associated with this LeapGesture, if any.

NSArray *pointableList = gesture.pointables;
//Only one pointable for current gestures
LeapHand *gesturingPointable = [pointableList objectAtIndex:0];

Returns

NSArray the list of related LeapPointable objects.

- (LeapGestureState) state

readnonatomicassign

The gesture state.

Returns

LeapGestureState A value from the LeapGestureState enumeration.

- (LeapGestureType) type

readnonatomicassign

The gesture type.

LeapGestureType type = gesture.type;

Returns

LeapGestureType A value from the LeapGestureType enumeration.