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

Unigine::Plugins::UltraleapHand Class

Header: #include <plugins/UnigineUltraleap.h>
Notice
Ultraleap plugin must be loaded.

Hands are the main entity tracked by the Ultraleap controller. The controller maintains an inner model of the human hand and validates the data from its sensors against this model. This allows the controller to track finger positions even when a finger is not completely visible.

Notice
It is possible for movement or changes in position to be lost when a finger is behind or directly in front of the hand (from the point of view of the controller).

The Ultraleap software matches the internal model against the existing data. In some cases, the software can make an incorrect match – for example, identifying a right hand as a left hand.

The Hand class represents a physical hand detected by the Leap and provides access to its attributes describing the hand position, orientation, and movement.

UltraleapHand Class

Enums

TYPE#

NameDescription
TYPE_LEFT = 0Left hand.
TYPE_RIGHT = 1Right hand.
NUM_TYPES = 2Total number of hand types.

Members


UltraleapHand::TYPE getType ( ) const#

Returns the type of the hand.

Return value

The type of the hand. One of the TYPE_* values.

bool isVisible ( ) const#

Returns a value indicating if the hand is visible to the Ultraleap Controller.

Return value

true if the hand is visible; otherwise, false.

long long getVisibleTime ( ) const#

The duration of time this Hand has been visible to the Ultraleap Controller.

Return value

The duration of time this Hand has been visible to the Ultraleap Controller.

float getPinchDistance ( ) const#

Returns the distance between the thumb and index finger of a pinch hand pose. The distance is computed by looking at the shortest distance between the last 2 phalanges of the thumb and those of the index finger. This pinch measurement only takes thumb and index finger into account.

Return value

The distance between the thumb and index finger of a pinch hand pose.

float getPinchStrength ( ) const#

Returns the holding strength of a pinch hand pose. The strength is zero for an open hand, and blends to one when a pinching hand pose is recognized. Pinching can be done between the thumb and any other finger of the same hand.

Return value

The holding strength of a pinch hand pose: 0 for an open hand, and blends to 1 when a pinching hand pose is recognized.

float getGrabStrength ( ) const#

The strength of a grab hand pose. The strength is zero for an open hand, and blends to one when a grabbing hand pose is recognized.

Return value

The strength of a grab hand pose: 0 for an open hand, and blends to 1 when a grabbing hand pose is recognized.

float getGrabAngle ( ) const#

The angle between the fingers and the hand of a grab hand pose. The angle is computed by looking at the angle between the direction of the 4 fingers and the direction of the hand. Thumb is not considered when computing the angle. The angle is 0 radian for an open hand, and reaches pi radians when the pose is a tight fist.

Return value

The angle between the fingers and the hand of a grab hand pose: 0 radian for an open hand, and reaches π radians when the pose is a tight fist.

double getPalmWidth ( ) const#

Returns the width of the palm when the hand is in a flat position, in meters.

Return value

The width of the palm when the hand is in a flat position, in meters.

Math::Vec3 getPalmPosition ( ) const#

Returns the coordinates of the position of the palm.

Return value

The coordinates of the position of the palm.

Math::Vec3 getPalmStabilizedPosition ( ) const#

Returns the modified palm position with some additional smoothing and stabilization applied. Smoothing and stabilization is performed in order to make this value more suitable for interaction with 2D content. The stabilized position lags behind the palm position by a variable amount, depending primarily on the speed of movement.

Return value

The coordinates of the modified palm position with some additional smoothing and stabilization applied.

Math::dvec3 getPalmVelocity ( ) const#

Returns the rate of change of the palm position, in m/s.

Return value

The rate of change of the palm position, in m/s.

Math::vec3 getPalmNormal ( ) const#

Returns the coordinates of the normal vector to the palm. If a hand is flat, this vector will point downward, or "out" of the front surface of your palm.

Return value

The coordinates of the normal vector to the palm.

Math::vec3 getDirection ( ) const#

Returns the normalized direction from the palm position toward the fingers.

Return value

The normalized direction from the palm position toward the fingers.

UltraleapArm * getArm ( ) const#

Returns the object for the arm.

Return value

The object for the arm.

UltraleapFinger * getFingerThumb ( ) const#

Returns the object for the thumb.

Return value

The object for the thumb.

UltraleapFinger * getFingerIndex ( ) const#

Returns the object for the index finger.

Return value

The object for the index finger.

UltraleapFinger * getFingerMiddle ( ) const#

Returns the object for the middle finger.

Return value

The object for the middle finger.

UltraleapFinger * getFingerRing ( ) const#

Returns the object for the ring finger.

Return value

The object for the ring finger.

UltraleapFinger * getFingerPinky ( ) const#

Returns the object for the pinky finger.

Return value

The object for the pinky finger.
Last update: 2022-07-01
Build: ()