VR Development Framework
v 1.0.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
AVR.Core.AVR_TrialExperiment Class Referenceabstract

Base class to inherit from in order to create trial-based experiments. (One experiment consists of one or more trials.) More...

Inheritance diagram for AVR.Core.AVR_TrialExperiment:
AVR.Core.AVR_Behaviour

Public Member Functions

abstract IEnumerator trial ()
 IEnumerator-coroutine that represents a single tiral More...
 
virtual void on_start ()
 Function that gets called when the experiment starts More...
 
virtual void on_end ()
 Function that gets called when the experiment ends More...
 
virtual void on_start_trial ()
 Function that gets called when a trial starts More...
 
virtual void on_end_trial ()
 Function that gets called when a trial ends More...
 
bool can_proceed ()
 This function returns true once after the can_proceed function has been called. Use this within the trial Coroutine like so: yield return new WaitUntil(can_proceed()). Then call the proceed() function on certain events, such as button presses. More...
 
void proceed ()
 Call this function externally to allow the trial to proceed. More...
 
void commence (int trial_amount=1)
 Call this function to commence an experiment with a given amount of trials. More...
 
- Public Member Functions inherited from AVR.Core.AVR_Behaviour
virtual void OnDestroy ()
 

Private Member Functions

IEnumerator experiment (int trial_amount)
 

Private Attributes

bool _p = false
 

Additional Inherited Members

- Protected Attributes inherited from AVR.Core.AVR_Behaviour
AVR_PlayerRig playerRig => AVR_PlayerRig.Instance
 The current AVR_PlayerRig instance in the scene More...
 
AVR_Root root => AVR_Root.Instance
 The current AVR_Root instance in the scene More...
 
bool vrEnabled => UnityEngine.XR.XRSettings.enabled
 True if the application is running as a VR/XR application More...
 

Detailed Description

Base class to inherit from in order to create trial-based experiments. (One experiment consists of one or more trials.)

Definition at line 12 of file AVR_TrialExperiment.cs.