visionforge/docs/hierarchy.md

44 lines
1.3 KiB
Markdown
Raw Normal View History

# Hierarchy
2021-08-17 20:23:31 +03:00
![](../docs/images/hierarchy.png)
### Vision
2021-08-20 15:43:12 +03:00
* function `getPropertyValue(name: Name, inherit: Boolean = false, includeStyles: Boolean = true, includeDefaults: Boolean = true)` - get property value with given layer flags.
2021-08-20 15:43:12 +03:00
* function `setProperty(name: Name, item: Any?)` - a convenient method to set property node or value. If `item` is null, then node is removed, not a value
2021-08-20 16:12:04 +03:00
Sets the `item` property to the element with the `name` identification.
### VisionBase
Basic vision implementation
### VisionGroup
A group of Visions.
### MutableVisionGroup
Mutable version of VisionGroup.
low structure changes of this group. Unconsumed changes are discarded.
### Solid
Interface for 3-dimensional Vision.
2021-08-20 15:43:12 +03:00
### SolidGroup
2021-08-20 15:43:12 +03:00
* 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.
2021-08-20 15:43:12 +03:00
* function `prototypes(builder: VisionContainerBuilder<Solid>.() -> Unit)` - create or edit prototype node as a group.
2021-08-20 16:12:04 +03:00
### SolidReferenceGroup
A reference Solid to reuse a template object.
2021-08-20 15:43:12 +03:00
### 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.