Class Leap::Device

class Leap.Device : public IEquatable<Device>

The Device class represents a physically connected device.

The Device class contains information related to a particular connected device such as device id, field of view relative to the device, and the position and orientation of the device in relative coordinates.

The position and orientation describe the alignment of the device relative to the user. The alignment relative to the user is only descriptive. Aligning devices to users provides consistency in the parameters that describe user interactions.

Note that Device objects can be invalid, which means that they do not contain valid device information and do not correspond to a physical device.

Since

1.0

Public Types

enum DeviceType

The available types of Leap Motion controllers.

Values:

TYPE_INVALID

TYPE_PERIPHERAL

A standalone USB peripheral. The original Leap Motion controller device.

Since

1.2

TYPE_DRAGONFLY

Internal research product codename “Dragonfly”.

TYPE_NIGHTCRAWLER

Internal research product codename “Nightcrawler”.

TYPE_RIGEL

Research product codename “Rigel”.

TYPE_SIR170

The Ultraleap Stereo IR 170 (SIR170) hand tracking module.

TYPE_3DI

The Ultraleap 3Di hand tracking camera.

TYPE_LMC2

The Ultraleap Leap Motion Controller 2 hand tracking camera.

Public Functions

Device ()

Constructs a default Device object.

Get valid Device objects from a DeviceList object obtained using the Controller.Devices() method.

Since

1.0

void Update (float horizontalViewAngle, float verticalViewAngle, float range, float baseline, uint status, string serialNumber)

For internal use only.

void Update (Device updatedDevice)

For internal use only.

bool Equals (Device other)

Compare Device object equality.

Two Device objects are equal if and only if both Device objects represent the exact same Device and both Devices are valid.

Since

1.0

override string ToString ()

A string containing a brief, human readable description of the Device object.

Since

1.0

Properties

IntPtr Handle { get; set; }

For internal use only.

float HorizontalViewAngle { get; set; }

The angle in radians of view along the x axis of this device.

The Leap Motion controller scans a region in the shape of an inverted pyramid centered at the device’s center and extending upwards. The horizontalViewAngle reports the view angle along the long dimension of the device.

Since

1.0

float VerticalViewAngle { get; set; }

The angle in radians of view along the z axis of this device.

The Leap Motion controller scans a region in the shape of an inverted pyramid centered at the device’s center and extending upwards. The verticalViewAngle reports the view angle along the short dimension of the device.

Since

1.0

float Range { get; set; }

The maximum reliable tracking range from the center of this device.

The range reports the maximum recommended distance from the device center for which tracking is expected to be reliable. This distance is not a hard limit. Tracking may be still be functional above this distance or begin to degrade slightly before this distance depending on calibration and extreme environmental conditions.

Since

1.0

float Baseline { get; set; }

The distance in mm between the center points of the stereo sensors.

The baseline value, together with the maximum resolution, influence the maximum range.

Since

2.2.5

bool IsStreaming { get; set; }

Reports whether this device is streaming data to your application.

Currently only one controller can provide data at a time.

Since

1.2

DeviceType Type { get; set; }

The device type.

Use the device type value in the (rare) circumstances that you have an application feature which relies on a particular type of device. Current types of device include the original Leap Motion peripheral, keyboard-embedded controllers, and laptop-embedded controllers.

Since

1.2

string SerialNumber { get; set; }

An alphanumeric serial number unique to each device.

Consumer device serial numbers consist of 2 letters followed by 11 digits.

When using multiple devices, the serial number provides an unambiguous identifier for each device.

Since

2.2.2

uint DeviceID { get; set; }

Reports the ID assoicated with the device

Pose DevicePose { get; set; }

The transform to world coordinates from 3D Leap coordinates.

bool IsSmudged { get; set; }

The software has detected a possible smudge on the translucent cover over the Leap Motion cameras.

Since

3.0

bool IsLowResource { get; set; }

The software has entered low-resource mode

Since

3.0

bool IsLightingBad { get; set; }

The software has detected excessive IR illumination, which may interfere with tracking. If robust mode is enabled, the system will enter robust mode when isLightingBad() is true.

Since

3.0