CellexalVR.Spatial.AllenReferenceBrain Class Reference

This class takes care of the brain reference model. The mouse brain model is downloaded using the allen sdk https://allensdk.readthedocs.io/en/latest/. The reference model is useful when a spatial mouse brain dataset is analyzed. To place the data points in relation to the brain glass organ. Ids, names and acronyms are retrieved via the allen sdk and these can be used to search trough brain parts. More...

Inheritance diagram for CellexalVR.Spatial.AllenReferenceBrain:

Public Member Functions
void	Toggle (bool toggle)
	For the spatial dataset graph points to be placed in relation to the glass brain it parents the object to the spatial graph transform. More...
void	ActivateKeyboard (bool activate)
	Activates the keyboard to use to search trough brain part models to spawn. More...
void	RemovePart (string modelName)
	Remove a spawn glass brain part. More...
SpatialReferenceModelPart	SpawnModel (int id)
	Spawns a glass brain part. More...
void	SpawnModel (string modelName)
	Spawn a glass brain part. More...
void	Spread ()
	Spread out the spawned brain parts. Distances the parts from the center. More...
void	ScrollSuggestions (int dir)
	Scroll through the brain part suggestions. More...
void	UpdateSuggestions (string filter="", int offset=0)
	Writing on the keyboard filters the brain part names/acronyms. More...
IEnumerator	PopulateMeshes ()
	Helper function to deal with the imported meshes. More...

Public Attributes
bool	loadBrain
GameObject	rootModel
GameObject	models
Dictionary< int, SpatialReferenceModelPart >	idToModelDictionary = new Dictionary<int, SpatialReferenceModelPart>()
Dictionary< string, string >	acronyms = new Dictionary<string, string>()
Dictionary< string, int >	names = new Dictionary<string, int>()
BrainPartButton	brainPartButtonPrefab
Dictionary< string, GameObject >	spawnedParts = new Dictionary<string, GameObject>()
Vector3	startPosition
Vector3	startScale
Quaternion	startRotation
List< int >	nonSplittableMeshes = new List<int> { 8, 997, 567, 824 }

Static Public Attributes
static AllenReferenceBrain	instance

Detailed Description

This class takes care of the brain reference model. The mouse brain model is downloaded using the allen sdk https://allensdk.readthedocs.io/en/latest/. The reference model is useful when a spatial mouse brain dataset is analyzed. To place the data points in relation to the brain glass organ. Ids, names and acronyms are retrieved via the allen sdk and these can be used to search trough brain parts.

Member Function Documentation

ActivateKeyboard()

void CellexalVR.Spatial.AllenReferenceBrain.ActivateKeyboard

(

bool

activate

)

Activates the keyboard to use to search trough brain part models to spawn.

Parameters

activate

PopulateMeshes()

IEnumerator CellexalVR.Spatial.AllenReferenceBrain.PopulateMeshes

(

)

Helper function to deal with the imported meshes.

Returns

RemovePart()

void CellexalVR.Spatial.AllenReferenceBrain.RemovePart

(

string

modelName

)

Remove a spawn glass brain part.

Parameters

modelName

ScrollSuggestions()

void CellexalVR.Spatial.AllenReferenceBrain.ScrollSuggestions

(

int

dir

)

Scroll through the brain part suggestions.

Parameters

dir

Up/down

SpawnModel() [1/2]

SpatialReferenceModelPart CellexalVR.Spatial.AllenReferenceBrain.SpawnModel

(

int

id

)

Spawns a glass brain part.

Parameters

id	ID of the brain part.

Returns

SpawnModel() [2/2]

void CellexalVR.Spatial.AllenReferenceBrain.SpawnModel

(

string

modelName

)

Spawn a glass brain part.

Parameters

modelName

Name of the model.

Spread()

void CellexalVR.Spatial.AllenReferenceBrain.Spread

(

)

Spread out the spawned brain parts. Distances the parts from the center.

Toggle()

void CellexalVR.Spatial.AllenReferenceBrain.Toggle

(

bool

toggle

)

For the spatial dataset graph points to be placed in relation to the glass brain it parents the object to the spatial graph transform.

UpdateSuggestions()

void CellexalVR.Spatial.AllenReferenceBrain.UpdateSuggestions	(	string	filter = "",
		int	offset = 0
	)

Writing on the keyboard filters the brain part names/acronyms.

Parameters

filter	The letters that the brain part must contains.
offset	Used for the suggestions to be correct.

---

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

• cellexalvr_cloudxr/Assets/Scripts/Spatial/AllenReferenceBrain.cs