KurusView Documentation

  

KurusView

KurusView is a cross-platform visualisation tool for three-dimensional models.

Interaction with the models is supported through the following features:

• Open multiple models in the same or different windows.
• Move models freely around every axis.
• Modify and edit multiple models at once.
• Apply shrink and/or clip filters.
• Measure model dimensions along predefined or custom axis.
• Change model, background, and back-face colour independently.
• Change the structure of the model to a wireframe.
• View the individual points of the model.
• Apply 3D gridlines encapsulating any model.
• Calculation of model statistics such as:
  • Volume
  • Weight
  • Centre of Gravity
  • Number of Cells
  • Density
• Adjust lighting, model opacity and specularity.
• Save per-model view transformations (colours, position, etc) to proprietary .kurus files.

Light and dark modes are available and on Windows switching is automatic matching Windows app settings.

 

---

Requirements

• CMake >= 3.3
• Qt 5
• VTK 8.2.0

These requirements are only relevant if compiling from source. Installers are available.

Install

zip and exe installers are available for Windows, and zip, tgz and deb for Linux.

Compile from source

$ cmake -DENABLE_TESTS=OFF build/
$ cmake --build build/ --target KurusView

Or without the GUI:

$ cmake -DENABLE_TESTS=OFF build/
$ cmake --build build/ --target KurusView_LIB

Repo tree

.
├── include/                # Project Headers
|   ├── Cells/                  # MCell Children Headers
|   ├── ModelRenderer/          # Semester 2 GUI Headers
|   └── Utils/                  # Internally Used Utility Headers
├── lib/                    # Library Source Files
|   ├── Cells/                  # MCell Children Source Files
|   ├── ModelRenderer/          # Semester 2 GUI Source Files
|   ├── Utils/                  # Internally Used Utilities
|   └── KurusViewLib.cmake      # Library CMake
├── models/                 # Example Models (.kurus, .mod and .stl)
├── packaging/              # Packaging CMake Dependencies
|   └── CMakeLists.txt          # Packaging CMake
├── Resources/              # Icons, Images and Stylesheets
├── src/                    # Main Function Source File
|   └── KurusView.cmake         # Main Function CMake
├── tests/                  # Google Test Tests
|   └── CMakeLists.txt          # Tests CMake
├── googletest/             # Git Submodule: Google Test
├── doxygen-awesome-css/    # Git Submodule: Doxygen Awesome
└── CMakeLists.txt          # Main CMakeLists

Documentation

Doxygen formatted comments are used in all header files and docs are hosted here. The theme used is by :rocket:.

Testing and Continuous Integration

This repository uses Google Test and Travis CI. To run tests yourself:

$ cmake -DENABLE_TESTS=ON build/
$ make test

Other views

Welcome window	Settings