Merge pull request #68 from kiruma524/dev

Supplemented files: inheritance.md and hierarchy.md

README.md

@@ -15,8 +15,13 @@
 * [About DataForge](#about-dataforge)
 * [Modules contained in this repository](#modules-contained-in-this-repository)
   * [visionforge-core](#visionforge-core)
-  * [visionforge-solid](#visionforge-solid)
+  * [visionforge-fx](#visionforge-fx)
   * [visionforge-gdml](#visionforge-gdml)
+  * [visionforge-markdown](#visionforge-markdown)
+  * [visionforge-plotly](#visionforge-plotly)
+  * [visionforge-server](#visionforge-server)
+  * [visionforge-solid](#visionforge-solid)
+  * [visionforge-threejs](#visionforge-threejs)
 * [Visualization for External Systems](#visualization-for-external-systems)  
 * [Demonstrations](#demonstrations)
   * [Simple Example - Solid Showcase](#simple-example---solid-showcase)
@@ -75,6 +80,17 @@ The `visionforge-core` module also includes configuration editors for JS (in `js
 
 ![](docs/images/class-diag-core.png)
 
+### visionforge-fx
+
+### visionforge-gdml
+
+GDML bindings for 3D visualization (to be moved to gdml project).
+
+### visionforge-markdown
+
+### visionforge-plotly
+
+### visionforge-server
 
 ### visionforge-solid
 
@@ -95,14 +111,10 @@ The `prototypes` property tree is defined in `SolidGroup` class via `PrototypeHo
 
 ##### Styles
 
-`SolidGroup` has a `styleSheet` property that can optionally define styles at the Group's 
+`VisionGroup` 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<String>` property.
 
-
-### visionforge-gdml
-
-GDML bindings for 3D visualization (to be moved to gdml project).
-
+### visionforge-threejs
 
 ## Visualization for External Systems 
 

docs/hierarchy.md

@@ -27,6 +27,7 @@ low structure changes of this group. Unconsumed changes are discarded.
 Interface for 3-dimensional Vision.
 
 ### SolidGroup
+3D Visual Group with a container for templates visible inside this group. It has an interface `PrototypeHolder` which stands for being a container with prototype support.
 
 * function `getPrototype(name: Name)` - get a prototype redirecting the request to the parent if prototype is not found. If prototype is a ref, then it is unfolded automatically.
 
@@ -34,10 +35,16 @@ Interface for 3-dimensional Vision.
 
 ### SolidReferenceGroup
 
-A reference Solid to reuse a template object.
+A class with `SolidReference` interface with reference `Solid`s for template objects reuse.
+
+### VisionGroupBase
+
+Abstract implementation of mutable group of `Vision`.
 
 ### RootVisionGroup
 
 Non-serializable root group used to propagate manager to its children.
 
-* function Vision.root(manager: VisionManager) - designate this [VisionGroup] as a root group and assign a [VisionManager] as its parent.
+### MutableVisionGroup
+
+Just a mutable version of `VisionGroup`

docs/inheritance.md

@@ -2,22 +2,21 @@
 
 Inheritance is an ability of an element to transfer a pack of properties to its `children` elements 'wrapped inside'.
 
-Properties have to be set in a specific order:
-### Main properties' inheritance:
-* styles
-* parents
+Properties, which can be inherited by objects, are `styles`, `prototypes` (if the object is a reference), `inherit` (it stands for the presence of `parent` objects), and `defaults`. 
+
+All values of `styles` property are contained in class `StyleSheet`, where they all are defined at `Group`s level. The `prototypes` property tree is defined in `SolidGroup` class via `PrototypeHolder` interface, and
+`SolidReference` class helps to reuse a template object. 
+
+The order of inheritance of properties is set in function `getPropertyValue` in `VisionBase` class.
+The order is this:
+* own styles
+* prototypes
+* parent
 * parent's styles
 * defaults
 
-As for `prototypes`, this property has to be set after styles, but before parents. So the order will be this:
-### Reference properties' inheritance:
-* styles
-* prototypes
-* parents
-* parent's styles
-* defaults
-------------------------
-Let's take a closer look using a [Muon Monitor Visualization](demo/muon-monitor/README.md).
+
+Let's take a closer look using a [Muon Monitor Visualization](../demo/muon-monitor/README.md).
 Running the demo, we will see this:
 
 ![](../docs/images/inheritance-1.png)
@@ -31,15 +30,15 @@ On the right, there is a list with changeable properties.
 ![](../docs/images/inheritance-properties.png)
 
 Properties, which can or cannot be inherited, are these:
-* `visible` - toggles the visibility of an element. To be exact, the invisibility of an element is inheritable.
+* `visible` – toggles the visibility of an element. To be exact, the invisibility of an element is inheritable.
   If a `parent` element is invisible, other elements are invisible as well, and they cannot be changed to visible mode.
   ![](../docs/images/inheritance-2-1-1.png)
   ![](../docs/images/inheritance-2-1-2.png)
 
-* `material` - a group of properties, which can be inherited and which can be changed in `children` elements.
-  * `color` - color of an element.
-  * `opacity` - a number from 0 to 1 which represents percents of opacity (0 for 0%, 1 for 100%).
-  * `wireframe` - toggles the wireframe mode.
+* `material` – a group of properties, which can be inherited and which can be changed in `children` elements.
+  * `color` – color of an element.
+  * `opacity` – a number from 0 to 1 which represents percents of opacity (0 for 0%, 1 for 100%).
+  * `wireframe` – toggles the wireframe mode.
 
   Let's see how elements of the `material` group inherit changing `color` property; ***other properties of this group inherit in the same way.***
 
@@ -51,7 +50,7 @@ Properties, which can or cannot be inherited, are these:
   ![](../docs/images/inheritance-2-2-2.png)
   It changes only, 'bottom' and 'middle' stays the same.
 
-  'top' is a `parent` element as well: it has `children` - 'SC72', 'SC73', ... ,'SC80'.
+  'top' is a `parent` element as well: it has `children` – 'SC72', 'SC73', ... ,'SC80'.
   Let's change the color of 'SC76':
   ![](../docs/images/inheritance-2-2-3.png)
   Again, only 'SC76' has changed among other 'siblings'.
@@ -64,5 +63,5 @@ Properties, which can or cannot be inherited, are these:
   If after all those changes we set at the 'World' element grey color, changes won't disappear:
   ![](../docs/images/inheritance-2-2-5.png)
 
-* `rotation` - rotation of an element. Here, it is set by `x` value. It is inheritable and unable to be changed in `children` elements.
-* `position` - position of an element, cannot be inherited.
+* `rotation` – rotation of an element. Here, it is set by `x` value. It is inheritable and unable to be changed in `children` elements.
+* `position` – position of an element, cannot be inherited.

docs/uml/Vision.puml

@@ -84,6 +84,7 @@ interface SolidReference{
     fun getPropertyValue(name,inherit,includeStyles,includeDefaults): Value?
 }
 VisionGroup <---- SolidReference
+SolidReferenceGroup -- SolidReference
 
 class SolidReferenceGroup{
     val refName: Name
@@ -93,6 +94,7 @@ class SolidReferenceGroup{
     fun getPropertyValue(name,inherit,includeStyles,includeDefaults): Value?
 }
 VisionBase <-- SolidReferenceGroup
+VisionGroup <-- SolidReferenceGroup
 
 interface MutableVisionGroup{
     fun onStructureChanged(owner, block)

visionforge-core/src/commonMain/kotlin/space/kscience/visionforge/Vision.kt

@@ -36,7 +36,7 @@ public interface Vision : Described, Configurable {
     public val manager: VisionManager? get() = parent?.manager
 
     /**
-     * This Vision own properties (ignoring inheritance, styles and defaults
+     * This Vision own properties (ignoring inheritance, styles and defaults)
      */
     override val meta: ObservableMutableMeta
 
@@ -92,7 +92,7 @@ public val Vision.propertyChanges: Flow<Name>
     }
 
 /**
- * Subscribe on property updates. The subscription is bound to the given [scope] and canceled when the scope is canceled
+ * Subscribe on property updates. The subscription is bound to the given scope and canceled when the scope is canceled
  */
 public fun Vision.onPropertyChange(callback: Meta.(Name) -> Unit) {
     meta.onChange(null, callback)

visionforge-core/src/commonMain/kotlin/space/kscience/visionforge/VisionBase.kt

@@ -23,7 +23,7 @@ internal data class MetaListener(
 
 /**
  * A full base implementation for a [Vision]
- * @param parent the parent object for this vision. Could ve set later. Not serialized.
+ * @param parent the parent object for this vision. Could've set later. Not serialized.
  */
 @Serializable
 @SerialName("vision")