Rubber Hand VR  V1.0
Toolkit for developing VR neuroplasticity experiments relying on the leap motion hand tracker
HandVR.IHand Interface Reference

Interface for hand modifications More...

Inheritance diagram for HandVR.IHand:

Public Member Functions

IEnumerator StartEffect ()
 Begins the modification effect More...
 
IEnumerator Reset ()
 Resets the modification to its initial position More...
 

Properties

bool IsStarted [get]
 Returns true if the modification has been started More...
 
bool IsFinished [get]
 Returns true if the modification is over More...
 
string Label [get]
 Label for the modification More...
 
float Value [get, set]
 Target value for the modification. ie. scale factor, etc More...
 

Detailed Description

Interface for hand modifications

Definition at line 11 of file IHand.cs.

Member Function Documentation

◆ Reset()

IEnumerator HandVR.IHand.Reset ( )

Resets the modification to its initial position

Returns

Implemented in HandVR.ModificationExamples.HandSlider, and HandVR.ModificationExamples.HandScaler.

Here is the caller graph for this function:

◆ StartEffect()

IEnumerator HandVR.IHand.StartEffect ( )

Begins the modification effect

Returns

Implemented in HandVR.ModificationExamples.HandSlider, and HandVR.ModificationExamples.HandScaler.

Here is the caller graph for this function:

Property Documentation

◆ IsFinished

bool HandVR.IHand.IsFinished
get

Returns true if the modification is over

Definition at line 21 of file IHand.cs.

◆ IsStarted

bool HandVR.IHand.IsStarted
get

Returns true if the modification has been started

Definition at line 16 of file IHand.cs.

◆ Label

string HandVR.IHand.Label
get

Label for the modification

Definition at line 26 of file IHand.cs.

◆ Value

float HandVR.IHand.Value
getset

Target value for the modification. ie. scale factor, etc

Definition at line 31 of file IHand.cs.


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