diff --git a/README.md b/README.md index 01c11d87..35c4daca 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,9 @@ * [Features](#features) * [About DataForge](#about-dataforge) * [Modules contained in this repository](#modules-contained-in-this-repository) - * [visionforge-common](#visionforge-common) - * [visionforge-spatial](#visionforge-spatial) - * [visionforge-spatial-gdml](#visionforge-spatial-gdml) - * [visionforge-jsroot](#visionforge-jsroot) + * [visionforge-core](#visionforge-core) + * [visionforge-solid](#visionforge-solid) + * [visionforge-gdml](#visionforge-gdml) * [Visualization for External Systems](#visualization-for-external-systems) * [Demonstrations](#demonstrations) * [Simple Example - Spatial Showcase](#simple-example---spatial-showcase) @@ -56,25 +55,25 @@ To learn more about DataForge, please consult the following URLs: ## Modules contained in this repository -### visionforge-common +### visionforge-core Contains a general hierarchy of classes and interfaces useful for visualization. This module is not specific to 3D-visualization. -The `visionforge-common` module also includes configuration editors for JS (in `jsMain`) and JVM (in `jvmMain`). +The `visionforge-core` module also includes configuration editors for JS (in `jsMain`) and JVM (in `jvmMain`). **Class diagram:** -![](doc/resources/class-diag-common.png) +![](doc/resources/class-diag-core.png) -### visionforge-spatial +### visionforge-solid -Includes common classes and serializers for 3D visualization, Three.js and JavaFX implementations. +Includes common classes and serializers for 3D visualization, as well as Three.js and JavaFX implementations. **Class diagram:** -![](doc/resources/class-diag-3d.png) +![](doc/resources/class-diag-solid.png) ##### Prototypes @@ -82,27 +81,20 @@ One of the important features of the framework is support for 3D object prototyp also referred to as templates). The idea is that prototype geometry can be rendered once and reused for multiple objects. This helps to significantly decrease memory usage. -The `prototypes` property tree is defined in `VisualGroup3D` class, and `Proxy` class helps to reuse a template object. +The `prototypes` property tree is defined in `SolidGroup` class via `PrototypeHolder` interface, and +`Proxy` class helps to reuse a template object. ##### Styles -`VisualGroup3D` has a `styleSheet` property that can optionally define styles at the Group's -level. Styles are applied to child (descendant) objects using `styles: List` property defined -in `VisualObject`. +`SolidGroup` has a `styleSheet` property that can optionally define styles at the Group's +level. Styles are applied to child (descendant) objects using `Vision.styles: List` property. -### visionforge-spatial-gdml +### visionforge-gdml GDML bindings for 3D visualization (to be moved to gdml project). -### visionforge-jsroot - -Some JSROOT bindings. - -Note: Currently, this part is experimental and put here for completeness. This module may not build. - - ## Visualization for External Systems The `visionforge` framework can be used to visualize geometry and events from external, diff --git a/demo/muon-monitor/README.md b/demo/muon-monitor/README.md index 39837c03..739a4956 100644 --- a/demo/muon-monitor/README.md +++ b/demo/muon-monitor/README.md @@ -20,7 +20,8 @@ object describes general geometry definitions needed in all parts of the applica client requests them. Note that in a more traditional approach when client and server are developed separately -and possibly using different languages, there would be no benefit of reusing common code. +and possibly using different languages, there would be no common code and benefits associated +with it. ##### Building project diff --git a/demo/spatial-showcase/README.md b/demo/spatial-showcase/README.md index 6537f7f2..41d3a5e3 100644 --- a/demo/spatial-showcase/README.md +++ b/demo/spatial-showcase/README.md @@ -8,7 +8,7 @@ Some shapes will also periodically change their color and visibility. To see the JS demo: run `demo/spatial-showcase/Tasks/distribution/jsBrowserDistribution` Gradle task, then open `build/distribuions/spatial-showcase-js-0.1.3-dev/index.html` file in your browser. -To see Java FX demo, run `main()` from `FXDemoApp.kt`. +To see Java FX demo, run `demo/spatial-showcase/Tasks/application/run` Gradle task, or `main()` from `FXDemoApp.kt`. ##### Example view for JS: diff --git a/doc/resources/class-diag-3d.png b/doc/resources/class-diag-3d.png deleted file mode 100644 index 4c9af2cd..00000000 Binary files a/doc/resources/class-diag-3d.png and /dev/null differ diff --git a/doc/resources/class-diag-common.png b/doc/resources/class-diag-common.png deleted file mode 100644 index 4943c3f4..00000000 Binary files a/doc/resources/class-diag-common.png and /dev/null differ diff --git a/doc/resources/class-diag-core.png b/doc/resources/class-diag-core.png new file mode 100644 index 00000000..332f607d Binary files /dev/null and b/doc/resources/class-diag-core.png differ diff --git a/doc/resources/class-diag-solid.png b/doc/resources/class-diag-solid.png new file mode 100644 index 00000000..a1a6e079 Binary files /dev/null and b/doc/resources/class-diag-solid.png differ diff --git a/doc/resources/muon-monitor.png b/doc/resources/muon-monitor.png index a5a4f154..fde07ab4 100644 Binary files a/doc/resources/muon-monitor.png and b/doc/resources/muon-monitor.png differ