Unigine.Plugins.LeapMotion Class

Notice

This set of functions is available when the LeapMotion plugin is loaded.

If the plugin is loaded together with the engine, the HAS_LEAP_MOTION definition is set. This definition can be used, for example, to avoid errors if the plugin is not loaded: the code in which the plugin functions are executed can be wrapped around as follows:

Source code (UnigineScript)

#ifdef HAS_LEAP_MOTION
	// engine.leap_motion functions
#endif

Properties:

Name	Description
bool IsLoaded	Returns a value indicating if the LeapMotion plugin is loaded.
bool IsConnected	Returns a value indicating if the LeapMotion device is connected.
bool IsServiceConnected	Returns a value indicating if your application has a connection to the Leap Motion daemon/service.
bool IsSmudged	Returns a value indicating if a possible smudge on the translucent cover over the Leap Motion cameras was detected.
bool IsLightingBad	Returns a value indicating if the excessive IR illumination was detected.
bool Paused	Returns a value indicating if the Leap Motion service is currently paused.
float HorizontalViewAngle	Returns the angle of view along the X axis (long dimension) of the Leap Motion device.
float VerticalViewAngle	Returns the angle of view along the Z axis (short dimension) of the Leap Motion device.
float Range	Returns the maximum recommended distance from the device center for which tracking is expected to be reliable.
float Baseline	Returns the distance between the center points of the stereo cameras of the Leap Motion device.
float FPS	Returns the current framerate.

Methods:

Name	Description View: Sort by:
HasFocus	Returns a value indicating if the application is the focused (foreground) application.
SetPolicy	Requests setting the specified policy.
IsPolicySet	Returns a value indicating if the specified policy is set.
ClearPolicy	Requests clearing the specified policy.
GetDistanceToBoundary	Returns the distance from the specified point to the nearest edge of the Leap Motion controller's view volume.
GetNumImages	Returns the number of images stored in the list of the most recent images from the infrared stereo cameras of the device.
GetImage	Returns the selected image from the list of the most recent images from the infrared stereo cameras of the device.

LeapMotion Class

Enums

POLICY#

Name	Description
DEFAULT = 0	Default policy flag. Enables default policy settings.
BACKGROUND_FRAMES = 1 << 0	Background frames policy flag. Determines whether an application receives frames of tracking data while in the background. Notice By default, the Leap Motion software only sends tracking data to the foreground application. Only applications that need this ability should request the background frames policy. The "Allow Background Apps" checkbox must be enabled in the Leap Motion Control Panel or this policy will be denied.
IMAGES = 1 << 1	Images policy flag. Enables your application to receive images from the device cameras. Notice The "Allow Images" checkbox must be enabled in the Leap Motion Control Panel or this policy will be denied.
OPTIMIZE_HMD = 1 << 2	HMD optimization policy flag. Enables tracking optimization for head-mounted tracking mode. Notice This policy improves tracking in situations where the Leap Motion hardware is attached to a head-mounted display. This policy is not granted for devices that cannot be mounted to an HMD, such as Leap Motion controllers embedded in a laptop or keyboard.
ALLOW_PAUSE_RESUME = 1 << 3	Pause resume policy flag. Determines if the application is allowed to pause and unpause the Leap Motion service.
RAW_IMAGES = 1 << 6	Images policy flag. Enables your application to receive raw images from the device cameras.

Properties

bool IsLoaded#

Returns a value indicating if the LeapMotion plugin is loaded.

bool IsConnected#

Returns a value indicating if the LeapMotion device is connected.

bool IsServiceConnected#

Returns a value indicating if your application has a connection to the Leap Motion daemon/service.

Notice

Can return true even if the Leap Motion hardware is not available. To check if the hardware is connected, use the IsConnected() property.

bool IsSmudged#

Returns a value indicating if a possible smudge on the translucent cover over the Leap Motion cameras was detected.

bool IsLightingBad#

Returns a value indicating if the excessive IR illumination was detected.

bool Paused#

Returns a value indicating if the Leap Motion service is currently paused.

set

Pauses or resumes the Leap Motion service.

set value - true - to pause the Leap Motion service; false - to resume it.

float HorizontalViewAngle#

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

float VerticalViewAngle#

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

float Range#

Returns the maximum recommended distance from the device center for which tracking is expected to be reliable.

NoticeThis 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.

float Baseline#

Returns the distance between the center points of the stereo cameras of the Leap Motion device.

float FPS#

Returns the current framerate.

Members

bool HasFocus ( ) #

Returns a value indicating if the application is the focused (foreground) application.

Notice

By default, your application only receives tracking information from the Leap Motion controller when it has the operating system input focus. To receive tracking data when your application is in the background, the background frames policy flag must be set.

Return value

true if the application is the focused (foreground) application; otherwise, false.

void SetPolicy ( int policy ) #

Requests setting the specified policy. A request to change a policy is subject to user approval and a policy can be changed by the user at any time (using the Leap Motion settings dialog).

Notice

The desired policy flags must be set every time an application runs.

Arguments

int policy - Policy. One of the POLICY values.

bool IsPolicySet ( int policy ) #

Returns a value indicating if the specified policy is set. To set a policy use the SetPolicy() method.

Arguments

int policy - Policy type. One of the POLICY values.

Return value

true if the specified policy is set; otherwise, false.

void ClearPolicy ( int policy ) #

Requests clearing the specified policy. A request to change a policy is subject to user approval and a policy can be changed by the user at any time (using the Leap Motion settings dialog).

Notice

The required policy flags must be set every time an application runs.

Arguments

int policy - Policy. One of the POLICY values.

float GetDistanceToBoundary ( const vec3 & position ) #

Returns the distance from the specified point to the nearest edge of the Leap Motion controller's view volume. The view volume is an axis-aligned, inverted pyramid centered on the device origin and extending upward to the range limit. The walls of the pyramid are described by the horizontalViewAngle and verticalViewAngle and the roof by the range.

Arguments

const vec3 & position - Point to measure the distance from.

Return value

Distance from the specified point to the nearest edge of the Leap Motion controller’s view volume, in meters.

int GetNumImages ( ) #

Returns the number of images stored in the list of the most recent images from the infrared stereo cameras of the device. Images are in the Image::FORMAT_R8.

Return value

Number of images stored in the array.

Ptr<Image> & GetImage ( int num ) #

Returns the selected image from the list of the most recent images from the infrared stereo cameras of the device. Images are in the Image::FORMAT_R8.

Arguments

int num - Index number of the image in the array.

Return value

Selected image from the cameras.

Last update: 2020-04-10

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)