LeapKeyTapGesture Class Reference

The LeapKeyTapGesture class represents a tapping gesture by a finger or tool. More...

Inherits LeapGesture.

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

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

Properties
LeapVector *	direction
	The direction of finger tip motion. More...
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...
LeapPointable *	pointable
	The finger performing the key tap gesture. More...
NSArray *	pointables
	The list of fingers and tools associated with this LeapGesture, if any. More...
LeapVector *	position
	The position where the key tap is registered. More...
float	progress
	The progess value is always 1.0 for a key tap gesture. More...
LeapGestureState	state
	The gesture state. More...
LeapGestureType	type
	The gesture type. More...

Detailed Description

The LeapKeyTapGesture class represents a tapping gesture by a finger or tool.

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

- (LeapVector*) direction

readnonatomicassign

The direction of finger tip motion.

LeapVector *tapDirection = keyTap.direction;

Returns

LeapVector A unit direction vector.

- (int64_t) duration

readnonatomicassigninherited

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

readnonatomicassigninherited

The elapsed duration in seconds.

float seconds = gesture.duration;

See also

duration

Returns

float the elapsed duration in seconds.

- (LeapFrame*) frame

readnonatomicstronginherited

The LeapFrame containing this LeapGesture instance.

LeapFrame *owningFrame = gesture.frame;

Returns

The parent LeapFrame object.

- (NSArray*) hands

readnonatomicstronginherited

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

readnonatomicassigninherited

The gesture ID.

int gestureID = gesture.id;

Returns

int32_t the ID of this LeapGesture.

- (BOOL) isValid

readnonatomicassigninherited

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.

- (LeapPointable*) pointable

readnonatomicassign

The finger performing the key tap gesture.

LeapPointable * tapper = keyTap.pointable;

Returns

A LeapPointable object representing the tapping finger.

- (NSArray*) pointables

readnonatomicstronginherited

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.

- (LeapVector*) position

readnonatomicassign

The position where the key tap is registered.

LeapVector *tapPosition = keyTap.position;

Returns

A LeapVector containing the coordinates of key tap location.

- (float) progress

readnonatomicassign

The progess value is always 1.0 for a key tap gesture.

Returns

float The value 1.0.

- (LeapGestureState) state

readnonatomicassigninherited

The gesture state.

Returns

LeapGestureState A value from the LeapGestureState enumeration.

- (LeapGestureType) type

readnonatomicassigninherited

The gesture type.

LeapGestureType type = gesture.type;

Returns

LeapGestureType A value from the LeapGestureType enumeration.