Theme:

3. Tools

Console

CellexalVR features a console where you can write commands from the computer to interact with the virtual environment. This is mostly meant for lazy developers to use for debugging new features, but is available to anyone. To open or close the console, press F12 on your keyboard. Everything that is written to the CellexalVR log file is also written to this console. Some functions can be called with multiple commands.
You can press tab to autocomplete commands or filepaths, and you can access previously entered commands using the up and down arrows on your keyboard.
Most the commands are listed below with their arguments and accompanying descriptions.

Command	Arguments	Description
`listall`	`none`	Lists all commands.
`arguments` `args`	`string`	Displays the type of the arguments of a given command.
`fps`	`int`	If argument is zero, hides the fps counter. If argument is non-zero, shows the fps counter.
`lights`	`int`	If argument is zero, disables the lights. If argument is non-zero, enables the lights. There is already a light on the headset illuminating what you look at, this light is an extra light mostly used for testing or taking pictures where more light is demanded.
`quit` `goodbye`	`none`	Quits CellexalVR.
`clear` `clr` `cls`	`none`	Clears the console window of all output.
`readfolder` `rf`	`string`	Loads all data in a folder. This path is relative to CellexalVR's Data folder.
`colorbygene` `cbg`	`string`	Colors all graphs by the given gene.
`colorbyattribute` `cba`	`string`	Colors all graphs by the given attribute.
`colorbyindex` `cbi`	`string`	Colors all graphs by the given facs measurement.
`selectfromprevious` `sfp`	`int`	Reads a previous selection stored in the `Output/<username>/<dataset>` folder. The integer is the number in the `selection*.txt` filename.
`confirmselection` `confirm`	`none`	Confirms the current selection.
`cancelselection` `cs`	`none`	Cancels the current selection.
`resetcolor` `rc`	`none`	Resets all graphs' colors.
`generateheatmap` `gh`	`none`	Generates a heatmap using the last confirmed selection.
`generatenetworks` `gn`	`none`	Generates networks using the last confirmed selection.
`cg`	`string, int`	Recolors a given graphpoint. The string argument is the cell's label that the graphpoint is representing. The int argument is a color from the available colors used when making a selection.
`readcommandfile` `rcf`	`string`	Reads a file with multiple commands. If a command is not successfully excecuted the next command will not be executed. The string argument is the path to the file containing the commands, relative from where CellexalVR is installed. Commands should be written on one line each in this file.