This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Basics
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
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
Animations-Related Classes
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
VR-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Unigine::Plugins::UltraleapDevice Class

Header: #include <plugins/Unigine/Ultraleap/UnigineUltraleap.h>

UltraleapDevice Class

Enums

HARDWARE_TYPE#

NameDescription
HARDWARE_TYPE_UNKNOWN = 0x0000An unknown device that is compatible with the tracking software.
HARDWARE_TYPE_PERIPHERAL = 0x0003The Leap Motion Controller (the first consumer peripheral).
HARDWARE_TYPE_DRAGONFLY = 0x1102Internal research product codename “Dragonfly”.
HARDWARE_TYPE_NIGHTCRAWLER = 0x1201Internal research product codename “Nightcrawler”.
HARDWARE_TYPE_RIGEL = 0x1202Research product codename “Rigel”.
HARDWARE_TYPE_SIR170 = 0x1203he Ultraleap Stereo IR 170 (SIR170) hand tracking module.
HARDWARE_TYPE__3DI = 0x1204The Ultraleap 3Di hand tracking camera.
HARDWARE_TYPE_INVALID = -1An invalid device type.

TRANSFORM_MODE#

NameDescription
TRANSFORM_MODE_HMD_VARJO = 0HMD Pose from AppVarjo and the IModelView from Game::getPlayer() are used for transform.
TRANSFORM_MODE_MANUAL = 1The user manually sets the transform matrix as described for the Ultraleap Coordinate System.

Members


bool isStatusConnected ( ) const#

Returns a value indicating if the Ultraleap Controller device is connected.

Return value

true if the device is connected; otherwise, false.

bool isStatusStreaming ( ) const#

Returns a value indicating if the Ultraleap Controller device is sending out frames.

Return value

true if the device is sending out frames; otherwise, false.

bool isStatusPaused ( ) const#

Returns a value indicating if the Ultraleap Controller device streaming has been paused.

Return value

true if the device streaming has been paused; otherwise, false.

bool isStatusRobust ( ) const#

Returns a value indicating if the Ultraleap Controller device has transitioned to robust mode in order to compensate for known sources of infrared interference.

Return value

true if the device has transitioned to robust mode in order to compensate; otherwise, false.

bool isStatusSmudged ( ) const#

Returns a value indicating if the Ultraleap Controller device’s window is smudged. If the device’s window is smudged, tracking may be degraded.

Return value

true if the device’s window is smudged; otherwise, false.

bool isStatusLowResource ( ) const#

Returns a value indicating if the Ultraleap Controller device has entered low-resource mode.

Return value

true if the device has entered low-resource mode; otherwise, false.

bool isStatusUnknownFailure ( ) const#

Returns a value indicating if the Ultraleap Controller device has failed, but the failure reason is not known.

Return value

true if the device has failed, but the failure reason is not known; otherwise, false.

bool isStatusBadCalibration ( ) const#

Returns a value indicating if the Ultraleap Controller device has a bad calibration record and cannot send frames.

Return value

true if the device has a bad calibration record and cannot send frames; otherwise, false.

bool isStatusBadFirmware ( ) const#

Returns a value indicating if the Ultraleap Controller device reports corrupt firmware or cannot install a required firmware update.

Return value

true if the device reports corrupt firmware or cannot install a required firmware update; otherwise, false.

bool isStatusBadTransport ( ) const#

Returns a value indicating if the Ultraleap Controller device USB connection is faulty.

Return value

true if the device USB connection is faulty; otherwise, false.

bool isStatusBadControl ( ) const#

Returns a value indicating if the Ultraleap Controller device USB control interfaces failed to initialize.

Return value

true if the device USB control interfaces failed to initialize; otherwise, false.

String getSerial ( ) const#

Returns the device serial number.

Return value

The device serial number.

float getHFov ( ) const#

Returns the horizontal field of view of this device in radians.

Return value

The horizontal field of view of this device in radians.

float getVFov ( ) const#

Returns the vertical field of view of this device in radians.

Return value

The vertical field of view of this device in radians.

double getRange ( ) const#

Returns the maximum range for this device, in meters.

Return value

The maximum range for this device, in meters.

double getDistanceBetweenCameras ( ) const#

Returns the distance between the Ultraleap cameras, in meters.

Return value

The distance between the Ultraleap cameras, in meters.

UltraleapDevice::HARDWARE_TYPE getHardwareType ( ) const#

Returns the recognized type of hardware.

Return value

The hardware type. One of the HARDWARE_TYPE_* values.

unsigned int getLeapID ( ) const#

Returns the ID of the current device.

Return value

The device ID.

bool isSupportedColorImages ( ) const#

Returns the value indicating if color images are supported for this device.

Return value

true if color images are supported for this device; otherwise, false.

bool isSupportedAccelerometer ( ) const#

Returns the value indicating if the accelerometer is supported for this device.

Return value

true if the accelerometer is supported for this device; otherwise, false.

bool isSupportedGyroscope ( ) const#

Returns the value indicating if the gyroscope is supported for this device.

Return value

true if the gyroscope is supported for this device; otherwise, false.

bool isSupportedTemperature ( ) const#

Returns the value indicating if temperature measuring is supported for this device.

Return value

true if temperature measuring is supported for this device; otherwise, false.

Math::vec3 getAccelerometer ( ) const#

Returns the accelerometer measurements, in in m/s^2.

Return value

The accelerometer measurements, in m/s^2.

Math::vec3 getGyroscope ( ) const#

Returns the gyroscope measurements, in rad/s.

Return value

The gyroscope measurements, in rad/s.

float getTemperature ( ) const#

Returns the measured temperature, in deg C.

Return value

The measured temperature, in deg C.

void setTrackingOffset ( const Math::Vec3& offset ) #

Sets 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. The X value should be set to 0. These settings can be used to match the physical position and orientation of the Tracking Hardware on a tracked device it is mounted on (such as a VR headset).

Arguments

  • const Math::Vec3& offset - 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. The X value should be set to 0.

Math::Vec3 getTrackingOffset ( ) const#

Returns the current virtual offset of the tracking 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.

Return value

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. The X value should be set to 0.

float getTrackingFPS ( ) const#

Returns the number of the tracking frames per second for this device.

Return value

The tracking FPS value.

void setTransform ( const Math::Mat4& transform ) #

Sets the transformation matrix for this device.

Arguments

  • const Math::Mat4& transform - The transformation matrix.

Math::Mat4 getTransform ( ) const#

Returns the current transformation matrix for this device.

Return value

The transformation matrix.

void setTransformMode ( UltraleapDevice::TRANSFORM_MODE mode ) #

Sets the transform mode for this device.
Notice
If the HMD VARJO transform mode has been set, but AppVarjo hasn't been found, the transform mode is switched to MANUAL.

Arguments

UltraleapDevice::TRANSFORM_MODE getTransformMode ( ) const#

Returns the current transform mode for this device.

Return value

The transform mode. One of the TRANSFORM_MODE* values.

UltraleapHand * getLeftHand ( ) const#

Returns the object for the left hand.

Return value

The object for the left hand.

UltraleapHand * getRightHand ( ) const#

Returns the object for the right hand.

Return value

The object for the right hand.

bool isLeftDistortionReceived ( ) const#

Returns a value indicating if the distortion calibration map for the left-eye image has been received.

Return value

true if the distortion calibration map for the left-eye image has been received; otherwise, false.

Ptr<Image> getLeftDistortionImage ( ) const#

Returns the distortion calibration map for the left-eye image.

Return value

The distortion calibration map for the left-eye image.

bool isLeftColorReceived ( ) const#

Returns a value indicating if the color image for the left eye image has been received.

Return value

true if the color image for the left eye image has been received; otherwise, false.

Ptr<Image> getLeftColorImage ( ) const#

Returns the color image for the left eye.

Return value

The color image for the left eye.

bool isRightDistortionReceived ( ) const#

Returns a value indicating if the distortion calibration map for the right-eye image has been received.

Return value

true if the distortion calibration map for the right-eye image has been received; otherwise, false.

Ptr<Image> getRightDistortionImage ( ) const#

Returns the distortion calibration map for the right-eye image.

Return value

The distortion calibration map for the right-eye image.

bool isRightColorReceived ( ) const#

Returns a value indicating if the color image for the right eye image has been received.

Return value

true if the color image for the right eye image has been received; otherwise, false.

Ptr<Image> getRightColorImage ( ) const#

Returns the color image for the right eye.

Return value

The color image for the right eye.
Last update: 2024-08-16
Build: ()