GestureInputEventData

lumin. GestureInputEventData

GestureInputEventData - Gesture input event

Extends

Methods

getDeviceId() → {number}

Inherited From:
Returns:

The device Id

Type
number

getEventSource() → {lumin.input.EventSource}

Inherited From:
Returns:

The event source

Type
lumin.input.EventSource

getEventType() → {lumin.input.EventType}

Inherited From:
Returns:

The event type

Type
lumin.input.EventType

getGesture() → {lumin.input.GestureType}

Returns:

The gesture type

Type
lumin.input.GestureType

getGestureAngle() → {number}

Returns:

Angle from center of touchpad to finger

Type
number

getGestureDirection() → {lumin.input.GestureDirection}

Returns:

The gesture direction

Type
lumin.input.GestureDirection

getGestureDistance() → {number}

Returns:

The absolute value of the angular value in case of radial gestures

Type
number

getGestureFingerGap() → {number}

Returns:

Distance between 2 fingers

Type
number

getGestureForceValue() → {number}

See:
  • getTouch()
Returns:

The force/pressure value for the gesture (0.0 to 1.0)

Type
number

getGestureLocation() → {vec2}

See:
  • getTouch()
Returns:

Location of the gesture in normalized touch coordinates (-1.0 to 1.0).

Type
vec2

getGestureRadius() → {number}

Returns:

Radius of the gesture in case of Radial gestures

Type
number

getGestureSpeed() → {number}

Returns:

The gesture speed

Type
number

getHandGestureConfidence() → {number}

Get the confidence of the hand gesture

Returns:
Type
number

getHandGestureIndex() → {number}

Returns:

The hand gesture index

Type
number

getHandGestureKeypoint(keypointName) → {vec3}

Get the position of the hand gesture key point with the given index

Parameters:
Name Type Description
keypointName lumin.input.HandGestureKeypointName

the keypoint for which to get the position

Returns:

vector containing positions of keypoint

Type
vec3

getHandGestureKeyPointCount() → {number}

Returns:

the number of hand gesture key points available for this gesture

Type
number

getHandGestureKeyPoseConfidence(gesture) → {number}

Get the confidence of a given hand pose

Parameters:
Name Type Description
gesture lumin.input.GestureType

the hand pose for which to retreive the confidence

Returns:

a confidence value between 0 and 1 (higher means greater confidence)

Type
number

getHandGestureLocation() → {vec3}

Returns:

The hand gesture location in world coordinates.

Type
vec3

getPrismId() → {number}

Inherited From:

Returns the Prism ID of the target Prism.

Returns:

the Prism ID of the target Prism.

Type
number

getTouch(tidxopt) → {vec3}

Get touch xy coordinates and z force

The coordinate ranges are:


  • x: -1.0 to 1.0 (left to right)
  • y: -1.0 to 1.0 (bottom to top)
  • z: 0.0 to 1.0 (no touch to full force)

The center of the touchpad corresponds to xy coordinate (0, 0).

Parameters:
Name Type Attributes Default Description
tidx number <optional>
0

touch index

Returns:

vector containing xy coordinates and force of the touch
at the given touch index

Type
vec3

getTouchCount() → {number}

Returns:

the current touch count

Type
number

getTouchState() → {boolean}

Get current state of the touch

Returns:

true if the touch is active

Type
boolean

isHandGestureKeypointRecognized(keypointName) → {boolean}

Checks whether a given keypoint was recognized this event

Parameters:
Name Type Description
keypointName lumin.input.HandGestureKeypointName

the keypoint to test

Returns:

true if the point was recognized, false otherwise

Type
boolean

isInputEventType() → {boolean}

Inherited From:

Returns true if this is an input event (a subclass of InputEventData).

Returns:

true if this is an input event

Type
boolean

isMultiTouch() → {boolean}

Get whether the touch is a single or multi touch

Returns:

true if the touch is a multi touch

Type
boolean

toString() → {string}

Inherited From:

Returns a string representation of this event for debug purposes.

Returns:
Type
string