Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/Ultimaker/Cura.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKostas Karmas <konskarm@gmail.com>2021-02-01 17:54:55 +0300
committerKostas Karmas <konskarm@gmail.com>2021-02-01 17:54:55 +0300
commitdce6c1c871ded2618e8b3a34a3e0f7d2b6315057 (patch)
treeb319de27a9800ea6c0cb7a8e18c5324f2ff813be /docs
parent85dea31e04958f030d14a2b0ab340378f2da9c61 (diff)
Add information on the GroupDecorator
CURA-7502
Diffstat (limited to 'docs')
-rw-r--r--docs/scene/scene.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/scene/scene.md b/docs/scene/scene.md
index c2ea52577f..ace31763fa 100644
--- a/docs/scene/scene.md
+++ b/docs/scene/scene.md
@@ -72,6 +72,35 @@ Example result when iterating the above scene graph:
* 17 = {CuraSceneNode} <CuraSceneNode object: 'Cylinder.stl'>
* 18 = {CuraSceneNode} <CuraSceneNode object: 'Cube.stl'>
+SceneNodeDecorators
+----
+
+SceneNodeDecorators are decorators that can be added to the nodes of the scene to provide them with additional functions.
+
+Cura provides the following classes derived from the SceneNodeDecorator class:
+ 1. GroupDecorator
+ 2. ConvexHullDecorator
+ 3. SettingOverrideDecorator
+ 4. SliceableObjectDecorator
+ 5. BuildPlatedecorator
+ 6. LayerDataDecorator
+ 7. ZOffsetDecorator
+ 8. BlockSlicingDecorator
+ 9. GCodeListDecorator
+
+GroupDecorator
+----
+
+Whenever objects on the buildplate are grouped together, a new node is added in the scene as the parent of the grouped objects. Group nodes can be identified when traversing the SceneGraph by running the following:
+
+```python
+node.callDecoration("isGroup") == True
+```
+
+Group nodes decorated by GroupDecorators are added in the scene either by reading project files which contain grouped objects, or when the user selects multiple objects and groups them together (Ctrl + G).
+
+Group nodes that are left with only one child are removed from the scene, making their only child a child of their parent. Group nodes without any remaining children are removed from the scene.
+
Layer Data
----