diff --git a/README.md b/README.md index 621f474f..b89b0ea9 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,7 @@ 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` property. diff --git a/docs/hierarchy.md b/docs/hierarchy.md index 2427cec7..720af5d2 100644 --- a/docs/hierarchy.md +++ b/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` \ No newline at end of file diff --git a/docs/images/hierarchy.png b/docs/images/hierarchy.png index e202c6af..9e9394ac 100644 Binary files a/docs/images/hierarchy.png and b/docs/images/hierarchy.png differ diff --git a/docs/images/spatial-showcase-FX.png b/docs/images/solid-showcase-FX.png similarity index 100% rename from docs/images/spatial-showcase-FX.png rename to docs/images/solid-showcase-FX.png diff --git a/docs/images/spatial-showcase.png b/docs/images/solid-showcase.png similarity index 100% rename from docs/images/spatial-showcase.png rename to docs/images/solid-showcase.png diff --git a/docs/inheritance.md b/docs/inheritance.md index 079d1940..d57bed71 100644 --- a/docs/inheritance.md +++ b/docs/inheritance.md @@ -2,6 +2,7 @@ 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 @@ -16,8 +17,9 @@ As for `prototypes`, this property has to be set after styles, but before parent * 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 +33,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 +53,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 +66,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. diff --git a/docs/uml/Vision.puml b/docs/uml/Vision.puml index 2b4d9953..04e873b9 100644 --- a/docs/uml/Vision.puml +++ b/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) diff --git a/visionforge-core/src/commonMain/kotlin/space/kscience/visionforge/VisionBase.kt b/visionforge-core/src/commonMain/kotlin/space/kscience/visionforge/VisionBase.kt index 74f173ae..dce9bbd5 100644 --- a/visionforge-core/src/commonMain/kotlin/space/kscience/visionforge/VisionBase.kt +++ b/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")