Class TagCalibrationBehaviour
TagCalibrationBehaviour is the base class from which you must inherit to define the NeuroTag's behaviour during calibration.
Namespace: NextMind.Calibration
Assembly: NextMind.dll
Syntax
public abstract class TagCalibrationBehaviourRemarks
This is the way to override the behaviour of the NeuroTags by script, but you can still use directlty the events in the editor.
NextMind is bringing a default behaviour (NextMind.Calibration.DefaultTagCalibrationBehaviour), scaling the NeuroTags up and down during calibration, but you may want to implement a different one. In this case, your custom NeuroTag behaviour classes must inherit from this one and implement OnInitialize(NeuroTag), OnStartCalibrating(NeuroTag) and OnEndCalibrating(NeuroTag).
Please refer to the "Create custom NeuroTags calibration behaviours" for further information.
Constructors
TagCalibrationBehaviour()
Constructor for this class.
Declaration
public TagCalibrationBehaviour()Methods
OnEndCalibrating(NeuroTag)
Triggered when the tag stops being used by the calibration manager.
Declaration
public abstract IEnumerator OnEndCalibrating(NeuroTag tag)Parameters
| Type | Name | Description |
|---|---|---|
| NeuroTag | tag | The NeuroTag used during the trial which just ends. |
Returns
| Type | Description |
|---|---|
| System.Collections.IEnumerator |
OnInitialize(NeuroTag)
Triggered just before the beginning of the calibration. Can be used to setup your NeuroTags.
Declaration
public abstract void OnInitialize(NeuroTag tag)Parameters
| Type | Name | Description |
|---|---|---|
| NeuroTag | tag | The NeuroTag initialized. |
OnStartCalibrating(NeuroTag)
Triggered when the tag becomes the one use by the calibration manager.
Declaration
public abstract IEnumerator OnStartCalibrating(NeuroTag tag)Parameters
| Type | Name | Description |
|---|---|---|
| NeuroTag | tag | The NeuroTag used during the trial about to start. |
Returns
| Type | Description |
|---|---|
| System.Collections.IEnumerator |
SetCalibrationManager(CalibrationManager)
Set the CalibrationManager used by this behaviour.
Declaration
public void SetCalibrationManager(CalibrationManager newManager)Parameters
| Type | Name | Description |
|---|---|---|
| CalibrationManager | newManager | The CalibrationManager to be used. |
Remarks
An instance of the CalibrationManager is automatically retrieved by Object.FindObjectOfType<CalibrationManager>() in the constructor of this class but you can still set the instance you want using this function. It may be useful if you are using multiple CalibrationManagers in your scene.