Drag[en]gine Script Module DragonScript  1.23
Dragengine.Scenery.BAAVRGrab Interface Reference

Interface for VR grab object support with base actor actions. More...

Public Member Functions

void grab ()
 Grab. More...
 
void grabAnalog (float value)
 Grab in the range from 0 to 1. More...
 
void squeeze (float value)
 Squeeze force in the range from 0 to 1. More...
 
void ungrab ()
 Ungrab. More...
 

Detailed Description

Interface for VR grab object support with base actor actions.

Version
1.10

Implementing actions provide a grab and release action as well as an analog grab and squeeze action.

The grab and release are binary actions. If the VR controller supports analog grab input the grab and release actions are triggered if a controller defined threshold value is reached.

The analog grab action is a gradual value in the range from 0 (ungrabbed) to 1 (grabbed). Not all VR controllers support analog grab input. If not supported the value is always 0.

The squeeze action is a gradual value in the range from 0 (no force applied) to 1 (maximum supported force applied). Not all VR controller support squeeze input. If not supported the value is always 0.

Member Function Documentation

◆ grab()

void Dragengine.Scenery.BAAVRGrab.grab ( )

Grab.

◆ grabAnalog()

void Dragengine.Scenery.BAAVRGrab.grabAnalog ( float  value)

Grab in the range from 0 to 1.

◆ squeeze()

void Dragengine.Scenery.BAAVRGrab.squeeze ( float  value)

Squeeze force in the range from 0 to 1.

◆ ungrab()

void Dragengine.Scenery.BAAVRGrab.ungrab ( )

Ungrab.


The documentation for this interface was generated from the following file: