LeapObjectiveC.hΒΆ

LeapObjectiveC.h File Reference

Enumerations

enum  LeapBoneType { LEAP_BONE_TYPE_METACARPAL = 0, LEAP_BONE_TYPE_PROXIMAL = 1, LEAP_BONE_TYPE_INTERMEDIATE = 2, LEAP_BONE_TYPE_DISTAL = 3 }
 Enumerates the names of the bones. More...
 
enum  LeapDeviceFailureType {
  LEAP_DEVICE_FAIL_UNKNOWN, LEAP_DEVICE_FAIL_CALIBRATION, LEAP_DEVICE_FAIL_FIRMWARE, LEAP_DEVICE_FAIL_TRANSPORT,
  LEAP_DEVICE_FAIL_CONTROL, LEAP_DEVICE_FAIL_COUNT
}
 The errors that can cause a device to fail to properly connect to the service. More...
 
enum  LeapDeviceType { DEVICE_PERIPHERAL = 1, DEVICE_KEYBOARD, DEVICE_LAPTOP }
 The available types of Leap Motion controllers. More...
 
enum  LeapFingerJoint { LEAP_FINGER_JOINT_MCP = 0, LEAP_FINGER_JOINT_PIP = 1, LEAP_FINGER_JOINT_DIP = 2, LEAP_FINGER_JOINT_TIP = 3 }
 Enumerates the joints of a finger. More...
 
enum  LeapFingerType {
  LEAP_FINGER_TYPE_THUMB = 0, LEAP_FINGER_TYPE_INDEX = 1, LEAP_FINGER_TYPE_MIDDLE = 2, LEAP_FINGER_TYPE_RING = 3,
  LEAP_FINGER_TYPE_PINKY = 4
}
 Enumerates the names of the fingers. More...
 
enum  LeapGestureState { LEAP_GESTURE_STATE_INVALID = -1, LEAP_GESTURE_STATE_START = 1, LEAP_GESTURE_STATE_UPDATE = 2, LEAP_GESTURE_STATE_STOP = 3 }
 The possible gesture states. More...
 
enum  LeapGestureType {
  LEAP_GESTURE_TYPE_INVALID = -1, LEAP_GESTURE_TYPE_SWIPE = 1, LEAP_GESTURE_TYPE_CIRCLE = 4, LEAP_GESTURE_TYPE_SCREEN_TAP = 5,
  LEAP_GESTURE_TYPE_KEY_TAP = 6
}
 The supported types of gestures. More...
 
enum  LeapImageFormatType
 Enumerates the possible image formats. More...
 
enum  LeapPointableZone { LEAP_POINTABLE_ZONE_NONE = 0, LEAP_POINTABLE_ZONE_HOVERING = 1, LEAP_POINTABLE_ZONE_TOUCHING = 2 }
 Defines the values for reporting the state of a Pointable object in relation to an adaptive touch plane. More...
 
enum  LeapPolicyFlag {
  LEAP_POLICY_DEFAULT = 0, LEAP_POLICY_BACKGROUND_FRAMES = (1 << 0), LEAP_POLICY_IMAGES = (1 << 1), LEAP_POLICY_OPTIMIZE_HMD = (1 << 2),
  LEAP_POLICY_ALLOW_PAUSE_RESUME = (1 << 3)
}
 The supported controller policies. More...
 
enum  LeapValueType
 Enumerates the possible data types for configuration values. More...
 

Variables

const float LEAP_DEG_TO_RAD
 The constant ratio to convert an angle measure from degrees to radians. More...
 
const float LEAP_PI
 The constant pi as a single precision floating point number. More...
 
const float LEAP_RAD_TO_DEG
 The constant ratio to convert an angle measure from radians to degrees. More...
 

Enumeration Type Documentation

◆ LeapBoneType

Enumerates the names of the bones.

Since 2.0
Enumerator
LEAP_BONE_TYPE_METACARPAL 

The metacarpal bone connecting to the wrist.

LEAP_BONE_TYPE_PROXIMAL 

The first finger phalanx bone.

LEAP_BONE_TYPE_INTERMEDIATE 

The middle finger phalanx bone.

LEAP_BONE_TYPE_DISTAL 

The finger phalanx bone at the end of the finger.

◆ LeapDeviceFailureType

The errors that can cause a device to fail to properly connect to the service.

Since
3.0
Enumerator
LEAP_DEVICE_FAIL_UNKNOWN 

The cause of the error is unknown.

Since
3.0
LEAP_DEVICE_FAIL_CALIBRATION 

The device has a bad calibration record.

Since
3.0
LEAP_DEVICE_FAIL_FIRMWARE 

The device firmware is corrupt or failed to update.

Since
3.0
LEAP_DEVICE_FAIL_TRANSPORT 

The device is unresponsive.

Since
3.0
LEAP_DEVICE_FAIL_CONTROL 

The service cannot establish the required USB control interfaces.

Since
3.0
LEAP_DEVICE_FAIL_COUNT 

Not currently used.

Since
3.0

◆ LeapDeviceType

The available types of Leap Motion controllers.

Since
1.2
Enumerator
DEVICE_PERIPHERAL 

A standalone USB peripheral.

The original Leap Motion controller device.

Since
1.2
DEVICE_KEYBOARD 
DEVICE_LAPTOP 

◆ LeapFingerJoint

Enumerates the joints of a finger.

The joints along the finger are indexed from 0 to 3 (tip to knuckle). The same joint identifiers are used for the thumb, even though the thumb has one less phalanx bone than the other digits. This puts the base joint (JOINT_MCP) at the base of thumb's metacarpal bone.

Pass a member of this enumeration to [LeapPointable jointPosition] to get the physical position of that joint.

Note: The term "joint" is applied loosely here and the set of joints includes the finger tip even though it is not an anatomical joint.

Since 2.0
Enumerator
LEAP_FINGER_JOINT_MCP 

The metacarpophalangeal joint, or knuckle, of the finger.

The metacarpophalangeal joint is located at the base of a finger between the metacarpal bone and the first phalanx. The common name for this joint is the knuckle.

On a thumb, which has one less phalanx than a finger, this joint index identifies the thumb joint near the base of the hand, between the carpal and metacarpal bones.

Since 2.0
LEAP_FINGER_JOINT_PIP 

The proximal interphalangeal joint of the finger.

This joint is the middle joint of a finger.

The proximal interphalangeal joint is located between the two finger segments closest to the hand (the proximal and the intermediate phalanges). On a thumb, which lacks an intermediate phalanx, this joint index identifies the knuckle joint between the proximal phalanx and the metacarpal bone.

Since 2.0
LEAP_FINGER_JOINT_DIP 

The distal interphalangeal joint of the finger.

This joint is closest to the tip.

The distal interphalangeal joint is located between the most extreme segment of the finger (the distal phalanx) and the middle segment (the intermediate phalanx).

Since 2.0
LEAP_FINGER_JOINT_TIP 

The tip of the finger.

Since 2.0

◆ LeapFingerType

Enumerates the names of the fingers.

Members of this enumeration are returned by [LeapFinger type] to identify a Finger object.

Since 2.0
Enumerator
LEAP_FINGER_TYPE_THUMB 

The thumb.

LEAP_FINGER_TYPE_INDEX 

The index or forefinger.

LEAP_FINGER_TYPE_MIDDLE 

The middle finger.

LEAP_FINGER_TYPE_RING 

The ring finger.

LEAP_FINGER_TYPE_PINKY 

The pinky or little finger.

◆ LeapGestureState

The possible gesture states.

Enumerator
LEAP_GESTURE_STATE_INVALID 

An invalid state.

LEAP_GESTURE_STATE_START 

The gesture is starting.

Just enough has happened to recognize it.

LEAP_GESTURE_STATE_UPDATE 

The gesture is in progress.

(Note: not all gestures have updates).

LEAP_GESTURE_STATE_STOP 

The gesture has completed or stopped.

◆ LeapGestureType

The supported types of gestures.

Enumerator
LEAP_GESTURE_TYPE_INVALID 

An invalid type.

LEAP_GESTURE_TYPE_SWIPE 

A straight line movement by the hand with fingers extended.

LEAP_GESTURE_TYPE_CIRCLE 

A circular movement by a finger.

LEAP_GESTURE_TYPE_SCREEN_TAP 

A forward tapping movement by a finger.

LEAP_GESTURE_TYPE_KEY_TAP 

A downward tapping movement by a finger.

◆ LeapImageFormatType

Enumerates the possible image formats.

The [LeapImage format] method returns an item from the LEAP_IMAGE_FORMAT_TYPE enumeration.

Since 2.2.0

◆ LeapPointableZone

Defines the values for reporting the state of a Pointable object in relation to an adaptive touch plane.

Since 1.0
Enumerator
LEAP_POINTABLE_ZONE_NONE 

The Pointable object is too far from the plane to be considered hovering or touching.

LEAP_POINTABLE_ZONE_HOVERING 

The Pointable object is close to, but not touching the plane.

LEAP_POINTABLE_ZONE_TOUCHING 

The Pointable has penetrated the plane.

◆ LeapPolicyFlag

The supported controller policies.

Since 1.0
Enumerator
LEAP_POLICY_DEFAULT 

The default policy.

Since 1.0

LEAP_POLICY_BACKGROUND_FRAMES 

Receive background frames.

Since 1.0

LEAP_POLICY_IMAGES 

Receive raw images from sensor cameras.

Since 2.0.5

LEAP_POLICY_OPTIMIZE_HMD 

Optimize the tracking for head-mounted device.

Since 2.1.3

LEAP_POLICY_ALLOW_PAUSE_RESUME 

Allow pausing and unpausing of the Leap Motion service.

Since 2.2.0

◆ LeapValueType

Enumerates the possible data types for configuration values.

The [LeapConfig type] property returns an item from the LeapValueType enumeration.

Since 1.0

Variable Documentation

◆ LEAP_DEG_TO_RAD

const float LEAP_DEG_TO_RAD

The constant ratio to convert an angle measure from degrees to radians.

Multiply a value in degrees by this constant to convert to radians.

Since 1.0

◆ LEAP_PI

const float LEAP_PI

The constant pi as a single precision floating point number.

Since 1.0

◆ LEAP_RAD_TO_DEG

const float LEAP_RAD_TO_DEG

The constant ratio to convert an angle measure from radians to degrees.

Multiply a value in radians by this constant to convert to degrees.

Since 1.0