Documentation

IContactGloveManager

An interface that provides access to the ContactGlove API. ContactGloveManagerWithSteamVR implements this interface.

GetFingerRotationAmplitude

Gets the rotation amplitude of a finger joint.

declaration

float GetFingerRotationAmplitude(HandSides hand, FingerRotationAmplitude_e index)

parameters

name type                     description       
hand HandSides                 Left or right hand       
indexFingerRotationAmplitude_eThe finger joint

return

type description       
floatRotation amplitude (0.0 ~ 1.0)

GetFingerTransform

Gets the Transform of a finger.

declaration

Transform GetFingerTransform(HandSides hand, FingerRotationAmplitude_e bone)

parameters

name type                     description       
hand HandSides                 Left or right hand       
indexFingerRotationAmplitude_eThe finger joint

return

type     description       
TransformThe finger's Transform

SetVibration

Vibrates the glove.

declaration

public void SetVibration(HandSides hand, float amplitude, float frequency, float duration)

parameters

name     type   description       
hand     HandSidesLeft or right hand       
amplitudefloat Vibration amplitude (0.0 ~ 1.0)
frequencyfloat Vibration frequency (Hz)
durationfloat Vibration duration (seconds)

GetVibration

Gets the glove's vibration strength.

declaration

public VibrationType GetVibration(HandSides hand)

parameters

name     type   description       
hand     HandSidesLeft or right hand       

return

type description       
VibrationTypeVibration amplitude and frequency

SetHaptics

Activates the glove's haptic module.

Note

This function can only be used on models equipped with the haptic module, which are available for corporate sales only. Standard models only support vibration via SetVibration.

declaration

public void SetHaptics(HandSides hand, ColliderFinger_e section, bool enable)

parameters

name     type   description       
hand     HandSidesLeft or right hand       
sectionColliderFinger_eThe type of finger section
enableboolWhether to enable or not

GetControllerInput(Bool)

This function has been removed in v1.1.0 and later.

Gets the bool-type controller input.

declaration

public bool GetControllerInput(HandSides hand, ControllerBoolInputType type)

parameters

name     type   description       
hand     HandSidesLeft or right hand       
typeControllerBoolInputTypeThe type of input

return

type description       
boolThe state of the input

GetControllerInput (ButtonState)

This function was added in v1.1.0.

Gets the ButtonState-type controller input.

declaration

public ButtonState GetControllerInput(HandSides hand, ControllerButtonType type)

parameters

name     type   description       
hand     HandSidesLeft or right hand       
typeControllerButtonTypeThe type of input

return

type description       
ButtonStateThe state of the input

GetControllerInput (Float)

Gets the float-type controller input.

declaration

public float GetControllerInput(HandSides hand, ControllerFloatInputType type)

parameters

name     type   description       
hand     HandSidesLeft or right hand       
typeControllerFloatInputTypeThe type of input

return

type description       
floatThe state of the input

AddOnControllerInputHandler

Adds a handler to be called when the controller input changes from Off to On.

declaration

public void AddOnControllerInputHandler(HandSides hand, ControllerButtonType type, ControllerInputHandler handler)

parameters

name     type   description       
hand     HandSidesLeft or right hand       
typeControllerButtonTypeThe type of input
handlerControllerInputHandlerThe handler
Before v1.1.0

declaration

public void AddOnControllerInputHandler(HandSides hand, ControllerBoolInputType type, ControllerInputHandler handler)

parameters

name     type   description       
hand     HandSidesLeft or right hand       
typeControllerBoolInputTypeThe type of input
handlerControllerInputHandlerThe handler

AddOffControllerInputHandler

Adds a handler to be called when the controller input changes from On to Off.

declaration

public void AddOffControllerInputHandler(HandSides hand, ControllerButtonType type, ControllerInputHandler handler)

parameters

name     type   description       
hand     HandSidesLeft or right hand       
typeControllerButtonTypeThe type of input
handlerControllerInputHandlerThe handler
Before v1.1.0

declaration

public void AddOffControllerInputHandler(HandSides hand, ControllerBoolInputType type, ControllerInputHandler handler)

parameters

name     type   description       
hand     HandSidesLeft or right hand       
typeControllerBoolInputTypeThe type of input
handlerControllerInputHandlerThe handler

HandSides

An enum representing the left or right hand.

declaration

public enum HandSides

fields

nametypedescription
LeftHandSidesLeft hand
RightHandSidesRight hand

FingerRotationAmplitude_e

An enum representing the rotation amplitude of finger joints.

declaration

public enum FingerRotationAmplitude_e

fields

name     typedescription
LittleProximalFingerRotationAmplitude_eLittle finger proximal joint
LittleIntermediateFingerRotationAmplitude_eLittle finger intermediate joint
LittleDistalFingerRotationAmplitude_eLittle finger distal joint
RingProximalFingerRotationAmplitude_eRing finger proximal joint
RingIntermediateFingerRotationAmplitude_eRing finger intermediate joint
RingDistalFingerRotationAmplitude_eRing finger distal joint
MiddleProximalFingerRotationAmplitude_eMiddle finger proximal joint
MiddleIntermediateFingerRotationAmplitude_eMiddle finger intermediate joint
MiddleDistalFingerRotationAmplitude_eMiddle finger distal joint
IndexProximalFingerRotationAmplitude_eIndex finger proximal joint
IndexIntermediateFingerRotationAmplitude_eIndex finger intermediate joint
IndexDistalFingerRotationAmplitude_eIndex finger distal joint
ThumbProximalFingerRotationAmplitude_eThumb proximal joint
ThumbIntermediateFingerRotationAmplitude_eThumb intermediate joint
ThumbDistalFingerRotationAmplitude_eThumb base
ThumbAbductionFingerRotationAmplitude_eThumb base rotation

ControllerBoolInputType

This enum has been removed in v1.1.0 and later.

An enum representing bool-type controller inputs.

declaration

public enum ControllerBoolInputType

fields

name     typedescription
AControllerBoolInputTypeA button
BControllerBoolInputTypeB button
HomeControllerBoolInputTypeHome button
JoystickButtonControllerBoolInputTypeJoystick button
TrackpadTouchControllerBoolInputTypeTrackpad touch

ControllerButtonType

This enum was added in v1.1.0.

An enum representing button-type controller inputs.

declaration

public enum ControllerButtonType

fields

name     typedescription
AControllerButtonTypeA button
BControllerButtonTypeB button
SystemControllerButtonTypeSystem button
TriggerButtonControllerButtonTypeTrigger button
JoystickButtonControllerButtonTypeJoystick button
TrackpadTouchControllerButtonTypeTrackpad touch

ButtonState

This enum was added in v1.1.0.

An enum representing the input state for button-type controller inputs.

declaration

public enum ButtonState

fields

name     typedescription
IdleButtonStateButton is not pressed
TouchedButtonStateButton is touched
PressedButtonStateButton is pressed

ControllerFloatInputType

An enum representing float-type controller inputs.

declaration

public enum ControllerFloatInputType

fields

name     typedescription
JoystickXControllerFloatInputTypeJoystick X-axis
JoystickYControllerFloatInputTypeJoystick Y-axis
TriggerControllerFloatInputTypeTrigger value
GripValueControllerFloatInputTypeGrip value
GripForceControllerFloatInputTypeGrip force

How to Use the UnitySDK

Previous Page

On this page

IContactGloveManagerGetFingerRotationAmplitudeGetFingerTransformSetVibrationGetVibrationSetHapticsGetControllerInput(Bool)GetControllerInput (ButtonState)GetControllerInput (Float)AddOnControllerInputHandlerAddOffControllerInputHandlerHandSidesFingerRotationAmplitude_eControllerBoolInputTypeControllerButtonTypeButtonStateControllerFloatInputType