C# Class C2M2.Simulation.Simulation

Provides an base interface for simulations using a general data type T
Inheritance: C2M2.Simulation.Interactable
Show file Open project: c2m2/NeuroVISOR

Public Properties

Property Type Description
defaultRaycastEvent RaycastPressEvents
paused bool
raycastEventManager RaycastEventManager

Protected Properties

Property Type Description
mutex Mutex
solveStepSampler CustomSampler

Public Methods

Method Description
GetValues ( ) : ValueType

Require derived classes to make simulation values available

Protected Methods

Method Description
BuildVisualization ( ) : VizType

Simulations must know how to build their visualization and what type the visualization is

See SurfaceSimulation & NeuronSimulation1D or PositionFieldSimulation for examples.

UpdateVisualization ( ) : void

Update the visualization. This will be called once per Update() call

See SurfaceSimulation & NeuronSimulation1D or PositionFieldSimulation for examples.

Method Details

BuildVisualization() protected abstract method

Simulations must know how to build their visualization and what type the visualization is
See SurfaceSimulation & NeuronSimulation1D or PositionFieldSimulation for examples.
protected abstract BuildVisualization ( ) : VizType
return VizType

GetValues() public abstract method

Require derived classes to make simulation values available
public abstract GetValues ( ) : ValueType
return ValueType

UpdateVisualization() protected abstract method

Update the visualization. This will be called once per Update() call
See SurfaceSimulation & NeuronSimulation1D or PositionFieldSimulation for examples.
protected abstract UpdateVisualization ( ) : void
return void

Property Details

defaultRaycastEvent public property

public RaycastPressEvents defaultRaycastEvent
return RaycastPressEvents

mutex protected property

Provide mutual exclusion to derived classes
protected Mutex mutex
return Mutex

paused public property

public bool paused
return bool

raycastEventManager public property

public RaycastEventManager raycastEventManager
return RaycastEventManager

solveStepSampler protected property

protected CustomSampler solveStepSampler
return CustomSampler