A VRL-Studio project for neuron mesh generation with a visual programming workflow and configuration of parameter values and packaging respectively containerizing generated meshes into a .vrn archive for the virtual reality project.
The project enables the end-user to create meshes and mesh bundles in our custom container format (.vrn) derived from the zip file format and is supported to be read and modified in our virtual reality project developed for the Unity gaming platform.
There is only one prerequisite which is a valid installation of the VRL-Studio IDE (and the existence of a precompiled UG4 binary, see ughub for how to build). In particular for this project see the section on howto build and generate meshes below if you have fulfilled the prerequisites.
Please note: For now the path to a precompiled UG4 (ugshell) binary has to be provided manually until further notice. If the developers of the UG4 project will allow our project to include the binary into a derived project, in particular to allow to include the binary as a resource for this project then the only requirement which remains is a valid installation of the VRL-Studio IDE which is supported on Linux, OSX and Windows.
| Linux | Windows (WSL) | OSX |
|---|---|---|
 |
 |
Currently JDK >=8 (up to JDK 13) and Gradle >=6 is supported on the operating systems listed above.
- Clone this repository
- (Optional) Edit build.properties and set path to your VRL installation
- Either
./gradlew installVRLpluginor./gradlew jarand manual installation of the compiled project
- Download a release from the tab on the right (Chose the file
vrl_plugin.zipfrom any release) - Decompress the
vrl-plugin.zipwhich will create the fileVRL-VRN-Generator.jar. - Open VRL-Studio and install the plugin via
Plugins->Install Pluginand selectVRL-VRN-Generator.jar.
In both cases (re-)start VRL-Studio and then open any of the provided template projects from the menu File->New Project from template from within VRL-Studio.
Familarize with the example workflow, then provide a neuron geometry file in the .swc format from a database like NeuroMorpho.org.
The project ships with an example 1D neuron geometry for which we will create the corresponding 3D geometry, choose the template
Mesh Generation - Example workflow with geometry. The user can also provide their own geometry in this project or load explictly
the template project anticipated for custom input geometries by choosing Mesh Generation - Example workflow.