add overview doc, window placement

This commit is contained in:
Crispy 2022-05-08 21:35:41 +02:00
parent 7edd005bb7
commit b1098a13ec
2 changed files with 38 additions and 0 deletions

35
docs/README.md Normal file
View file

@ -0,0 +1,35 @@
# WIP documentation
## Hierarchy
```
OverlayManager
- MyOverlayInstance
- [...]
- OverlayViewport
- Container
- MyOverlay
- [...]
- OverlayInteraction
- VR
- [colliders for vr trackers etc]
- Grabbable
- Clickable
- Touchable
```
## overlay interaction types
Each overlay instance has a OverlayInteraction node, which spawns the different interaction modules depending on what is defined in the OVERLAY_PROPERTIES.
The modules/interaction types are:
- Grabbable
- Touchable
- Clickable
These modules connect signals from different places to the interaction manager (`OverlayInteraction`)
Touchable connects collision signals to mouse inputs (potentially logic between to help prevent double presses)
Clickable connects vr button signals to mouse inputs
Grabbable connects vr button signals to grab logic, while telling the interaction manager to pause normal interaction

View file

@ -30,7 +30,10 @@ func _init() -> void:
func _ready() -> void: func _ready() -> void:
OS.window_size = Vector2(16, 16)
OS.window_position = Vector2(32, 32)
OS.window_minimized = true OS.window_minimized = true
ARVRServer.connect("tracker_added", self, "_tracker_added") ARVRServer.connect("tracker_added", self, "_tracker_added")
ARVRServer.connect("tracker_removed", self, "_tracker_removed") ARVRServer.connect("tracker_removed", self, "_tracker_removed")
update_hand_ids() update_hand_ids()