Docking terms

omar 2019-12-09 20:22:03 +01:00
parent 6554be5b72
commit d75ad4399c

@ -3,6 +3,7 @@
## Index
- [General Terms](#general-terms)
- [Docking Terms](#docking-terms)
- [Multi-Viewports Terms](#multi-viewports-terms)
## General Terms
@ -31,6 +32,24 @@
**Widgets**: (same as Item): a single ImGui element (e.g. a `ImGui::Button()` or `ImGui::Text()` call).
## Docking Terms
**Docking**: refer to the Docking subsystem as a whole, or to the action of Docking one Window or Dock Node into another Window or Dock Node.
**Dock Node**: carry a Tab Bar + zero or more Windows _or_ child dock nodes. A Dock Node can be either Floating Dock Node or a Dockspace. Dock Node are hosted by their Host Window.
**Dockspace**: a dock node whose Host Window has been created by the user. This imply that the position and size of the dock node is not controlled by the Docking system. This also imply that the lifetime of the dock node is not controlled by the Docking system.
**Dock Node Hierarchy**: a dock node and all its child dock nodes.
**Floating Dock Node**: a dock node whose Host Window is automatically created and managed by the Docking system. They are generally freely moveable.
**Root Dock Node**: a dock node that has no parent dock node.
**Leaf Dock Node**: a dock node that that no child dock nodes.
**Host Window**: the Window used to display docking decorations (Tab Bar, Close Button). In a Dock Node Hierarchy sitting over a Dockspace, the Host Window is always the window where the Dockspace was submitted. In a Dock Node Hierarchy sitting over a Floating Window, the Host Window is created thee Docking system.
## Multi-Viewports Terms
Note: when talking about issues related to the multi-viewports feature, always try to remove ambiguity by specifying e.g. "_Dear ImGui Window_" vs "_Platform Window_".