This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Unigine.Plugins.Ultraleap Class

Ultraleap Class

Enums

TRACKING_MODE#

NameDescription
DESKTOP = 0The tracking mode optimised for desktop devices.
HMD = 1The tracking mode optimised for head-mounted devices.
SCREEN_TOP = 2The tracking mode optimised for screen top-mounted devices.
UNKNOWN = 3Tracking mode is not known.

CONNECTION_STATUS#

NameDescription
NOT_CONNECTED = 0The connection is not open.
CONNECTED = 1The connection is open.
HANDSHAKE_INCOMPLETE = 2Opening the connection is underway, but not complete.
NOT_RUNNING = -1The connection could not be opened because the Ultraleap Tracking Service does not appear to be running.

OPTIMIZE_MODE#

NameDescription
DISABLED = 0Tracking optimization is disabled.
AUTO = 1Tracking optimization is set to automatic.
HMD = 2Tracking is optimized for head-mounted devices. The optimize HMD policy improves tracking in situations where the Ultraleap hardware is attached to a head-mounted display. This policy is not granted for devices that cannot be mounted to an HMD, such as Ultraleap controllers embedded in a laptop or keyboard.
SCREEN_TOP = 3Tracking is optimized for screen-top devices.

Properties

bool BackgroundUpdate#

The value indicating if the application is allowed to receive frames in the background.

bool StreamImages#

The value indicating if streaming of images is currently enabled.

bool Paused#

The value indicating if the Ultraleap service is currently paused.

bool AllowPauseResume#

The value indicating if the application is allowed to pause and unpause the Ultraleap service.

Ultraleap.OPTIMIZE_MODE OptimizeMode#

The optimization mode. One of the OPTIMIZE_MODE values.

Ultraleap.TRACKING_MODE TrackingMode#

The tracking mode. One of the TRACKING_MODE values.

bool TrackingInterpolation#

The value indicating if the tracking interpolation is enabled.

Ultraleap.CONNECTION_STATUS ConnectionStatus#

The connection status. One of the CONNECTION_STATUS values.

bool IsStatusLowFPSDetected#

The value indicating if the service cannot receive frames fast enough from the underlying hardware.

bool IsStatusPoorPerformancePause#

The value indicating if the service has paused itself due to an insufficient frame rate from the hardware.

bool IsStatusTrackingErrorUnknown#

The value indicating if the service has failed to start tracking due to unknown reasons.

vec3 TrackingOffsetDefault#

The default offset for the newly connected device. The Y value specifies the offset from the eyes to the frontal camera plane, in meters, and the Z value — the offset from the eye level up to the camera level, in meters.

UltraleapDevice.TRANSFORM_MODE TransformModeOffsetDefault#

The transform mode. One of the TRANSFORM_MODE values.

int NumDevices#

The number of connected devices.

int NumDevicesConnected#

The number of connected Ultraleap controller devices.

long LeapNow#

The time, in microseconds since an unspecified epoch.

Members


UltraleapDevice GetDevice ( int device_id ) #

Returns the Ultraleap controller device from the list of recognized devices.

Arguments

  • int device_id - The ID of the Ultraleap controller device.

Return value

The Ultraleap controller device.

UltraleapDevice GetDeviceConnected ( int device_id ) #

Returns the Ultraleap controller device from the list of connected devices.

Arguments

  • int device_id - The ID of the Ultraleap controller device.

Return value

The Ultraleap controller device.
Last update: 2022-12-14
Build: ()