Show / Hide Table of Contents

Class StimulationBehaviour

StimulationBehaviour is the base class from which you must inherit in order to define the way a NeuroTag should behave to a stimulation update.

Implements
System.IDisposable
Namespace: NextMind.NeuroTags.Stimulation
Assembly: NextMind.dll
Syntax
public abstract class StimulationBehaviour : IDisposable

Constructors

StimulationBehaviour(NeuroTag)

Constructor.

Declaration
public StimulationBehaviour(NeuroTag neuroTag)
Parameters
Type Name Description
NeuroTag neuroTag

The tag on which applies the behaviour.

Fields

shadersNames

Declaration
public static string[] shadersNames
Field Value
Type Description
System.String[]

targetMaterials

The materials used by the NextMind.NeuroTags.Stimulation.StimulationBehaviour.neuroTag's stimulation renderers, which are using the NextMind's shaders.

Declaration
protected Material[] targetMaterials
Field Value
Type Description
UnityEngine.Material[]

Methods

Dispose()

Declaration
public void Dispose()

GetShaderNames()

Return the names of the shaders used by this behaviour instance.

Declaration
protected virtual string[] GetShaderNames()
Returns
Type Description
System.String[]

A list of shader names

UpdateStimulation(GameObject, Single)

Called by the decoding system as soon as a new state of the stimulation is needed for the given NeuroTag. In case of a custom StimulationBehaviour.BehaviourType, this function has to be overriden with your own stimulation.

Declaration
public abstract void UpdateStimulation(GameObject target, float stimulationValue)
Parameters
Type Name Description
UnityEngine.GameObject target

The target affected by the stimulation update.

System.Single stimulationValue

The stimulation value.

Implements

System.IDisposable