Make floor indicator persistent

Frozenreflex · dfgHiatus · commit bb8197129a1b · 2025-10-22T16:00:05.000-05:00
diff --git a/Scripts/BackendHelpers.cs b/Scripts/BackendHelpers.cs
@@ -5,9 +5,9 @@ namespace BabbleCalibration.Scripts;
 
 public static class BackendHelpers
 {
-    public static ElementBase CreateElementWithObject(this IBackend backend, Control obj, bool head = false)
+    public static ElementBase CreateElementWithObject(this IBackend backend, Control obj, bool head = false, bool persistent = false)
     {
-        var elem = head ? backend.CreateHeadElement() : backend.CreateWorldElement();
+        var elem = head ? backend.CreateHeadElement(persistent) : backend.CreateWorldElement(persistent);
         elem.Root.AddChild(obj);
         return elem;
     }
diff --git a/Scripts/Backends/DebugBackend.cs b/Scripts/Backends/DebugBackend.cs
@@ -1,3 +1,4 @@
+using System.Linq;
 using BabbleCalibration.Scripts.Elements;
 using Godot;
 
@@ -42,22 +43,31 @@ public override void _Process(double delta)
             (Vector3.Up * 1.8f));
     }
 
-    public ElementBase CreateHeadElement()
+    public ElementBase CreateHeadElement(bool persistent = false)
     {
         var elem = OpenXRElement.CreateElement();
         elem.Head = Camera;
+        elem.IsInternal = persistent;
         ElementRoot.AddChild(elem);
         return elem;
     }
 
-    public ElementBase CreateWorldElement()
+    public ElementBase CreateWorldElement(bool persistent = false)
     {
         var elem = OpenXRElement.CreateElement();
+        elem.IsInternal = persistent;
         ElementRoot.AddChild(elem);
         return elem;
     }
 
-    public void ClearElements() => BackendHelpers.ClearAllChildren(ElementRoot);
+    public void ClearElements()
+    {
+        foreach (var c in ElementRoot.GetChildren().OfType<OpenXRElement>().Where(i => !i.IsInternal))
+        {
+            ElementRoot.RemoveChild(c);
+            c.QueueFree();
+        }
+    }
     public Transform3D HeadTransform() => Camera.GlobalTransform;
     public Transform3D EyeTransform(bool left) => Camera.GlobalTransform.TranslatedLocal((left ? Vector3.Left : Vector3.Right) * 0.035f);
 }
diff --git a/Scripts/Backends/OpenVRBackend.cs b/Scripts/Backends/OpenVRBackend.cs
@@ -28,15 +28,15 @@ public void Initialize()
         _interface = xrInt;
     }
 
-    public ElementBase CreateHeadElement()
+    public ElementBase CreateHeadElement(bool persistent = false)
     {
-        var elem = CreateElement();
+        var elem = CreateElement(persistent);
         elem.HeadMode = true;
         return elem;
     }
-    public ElementBase CreateWorldElement()
+    public ElementBase CreateWorldElement(bool persistent = false)
     {
-        var elem = CreateElement();
+        var elem = CreateElement(persistent);
         return elem;
     }
 
@@ -60,9 +60,9 @@ public Transform3D EyeTransform(bool left)
         return new Transform3D(head.Basis, eyeBall.Origin);
     }
 
-    private OpenVRElement CreateElement()
+    private OpenVRElement CreateElement(bool persistent = false)
     {
-        if (_storedPool.TryPop(out var result))
+        if (!persistent && _storedPool.TryPop(out var result))
         {
             _usedPool.Add(result);
             result.Visible = true;
@@ -71,7 +71,7 @@ private OpenVRElement CreateElement()
         result = ResourceLoader.Load<PackedScene>("res://Scenes/Elements/OpenVRElement.tscn")
             .Instantiate<OpenVRElement>();
         ElementRoot.AddChild(result);
-        _usedPool.Add(result);
+        if (!persistent) _usedPool.Add(result);
         return result;
     }
 }
diff --git a/Scripts/Backends/OpenXRBackend.cs b/Scripts/Backends/OpenXRBackend.cs
@@ -1,3 +1,4 @@
+using System.Linq;
 using BabbleCalibration.Scripts.Elements;
 using Godot;
 
@@ -24,21 +25,31 @@ public void Initialize()
         }
     }
 
-    public ElementBase CreateHeadElement()
+    public ElementBase CreateHeadElement(bool persistent = false)
     {
         var elem = OpenXRElement.CreateElement();
         elem.Head = Camera;
+        elem.IsInternal = persistent;
         ElementRoot.AddChild(elem);
         return elem;
     }
 
-    public ElementBase CreateWorldElement()
+    public ElementBase CreateWorldElement(bool persistent = false)
     {
         var elem = OpenXRElement.CreateElement();
+        elem.IsInternal = persistent;
         ElementRoot.AddChild(elem);
         return elem;
     }
-    public void ClearElements() => BackendHelpers.ClearAllChildren(ElementRoot);
+    public void ClearElements()
+    {
+        foreach (var c in ElementRoot.GetChildren().OfType<OpenXRElement>().Where(i => !i.IsInternal))
+        {
+            ElementRoot.RemoveChild(c);
+            c.QueueFree();
+        }
+    }
+
     public Transform3D HeadTransform() => Camera.GlobalTransform;
 
     public Transform3D EyeTransform(bool left)
diff --git a/Scripts/Backends/OpenXROverlayBackend.cs b/Scripts/Backends/OpenXROverlayBackend.cs
@@ -16,12 +16,12 @@ public void Initialize()
         throw new System.NotImplementedException();
     }
 
-    public ElementBase CreateHeadElement()
+    public ElementBase CreateHeadElement(bool persistent = false)
     {
         throw new System.NotImplementedException();
     }
 
-    public ElementBase CreateWorldElement()
+    public ElementBase CreateWorldElement(bool persistent = false)
     {
         throw new System.NotImplementedException();
     }
diff --git a/Scripts/Elements/OpenXRElement.cs b/Scripts/Elements/OpenXRElement.cs
@@ -8,6 +8,7 @@ public partial class OpenXRElement : ElementBase
     [Export] public MeshInstance3D Mesh;
     [Export] public PlaneMesh PlaneMesh;
     [Export] public Node3D Head;
+    [Export] public bool IsInternal = false;
 
     public override Transform3D ElementTransform
     {
diff --git a/Scripts/IBackend.cs b/Scripts/IBackend.cs
@@ -27,12 +27,12 @@ public interface IBackend
     /// Create an element, attached to the head. Doesn't require parenting.
     /// </summary>
     /// <returns>The created element</returns>
-    public abstract ElementBase CreateHeadElement();
+    public abstract ElementBase CreateHeadElement(bool persistent = false);
     /// <summary>
     /// Create an element in free space. Doesn't require parenting.
     /// </summary>
     /// <returns>The created element</returns>
-    public abstract ElementBase CreateWorldElement();
+    public abstract ElementBase CreateWorldElement(bool persistent = false);
     /// <summary>
     /// Clears all elements
     /// </summary>
diff --git a/Scripts/MainScene.cs b/Scripts/MainScene.cs
@@ -6,6 +6,7 @@
 using System.Threading.Tasks;
 using BabbleCalibration.Scripts;
 using BabbleCalibration.Scripts.Backends;
+using BabbleCalibration.Scripts.Elements;
 using BabbleCalibration.Scripts.Routines;
 using Godot.Collections;
 using OverlaySDK;
@@ -149,6 +150,12 @@ public override void _Ready()
         
         Backend.Initialize();
         
+        var elem = Backend.CreateElementWithObject(ResourceLoader.Load<PackedScene>("res://Scenes/Routines/FloorIndicator.tscn").Instantiate<PanelContainer>(), persistent: true);
+        elem.ElementTransform = OriginOffset * new Transform3D(new Basis(new Quaternion(Vector3.Forward, Vector3.Down)), Vector3.Up * 0.001f);
+        elem.ElementWidth = 1.25f;
+        
+        if (elem is OpenXRElement openXrElement) GD.Print(openXrElement.IsInternal);
+        
         StartRoutine<TextRoutine>(RoutineHelpers.LabelRoutineArgs(Tr(ConnectingString), true, Transform3D.Identity.TranslatedLocal(Vector3.Forward)));
 
         /*Task.Run(async () =>
@@ -288,9 +295,5 @@ public override void _Process(double delta)
         Backend.ClearElements();
         CurrentRoutine = new T();
         CurrentRoutine.Initialize(Backend, args);
-
-        var elem = Backend.CreateElementWithObject(ResourceLoader.Load<PackedScene>("res://Scenes/Routines/FloorIndicator.tscn").Instantiate<PanelContainer>());
-        elem.ElementTransform = OriginOffset * new Transform3D(new Basis(new Quaternion(Vector3.Forward, Vector3.Down)), Vector3.Up * 0.001f);
-        elem.ElementWidth = 1.5f;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -5,9 +5,9 @@ namespace BabbleCalibration.Scripts;`
`5`	`5`
`6`	`6`	`public static class BackendHelpers`
`7`	`7`	`{`
`8`		`- public static ElementBase CreateElementWithObject(this IBackend backend, Control obj, bool head = false)`
	`8`	`+ public static ElementBase CreateElementWithObject(this IBackend backend, Control obj, bool head = false, bool persistent = false)`
`9`	`9`	`{`
`10`		`- var elem = head ? backend.CreateHeadElement() : backend.CreateWorldElement();`
	`10`	`+ var elem = head ? backend.CreateHeadElement(persistent) : backend.CreateWorldElement(persistent);`
`11`	`11`	`elem.Root.AddChild(obj);`
`12`	`12`	`return elem;`
`13`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,15 +28,15 @@ public void Initialize()`
`28`	`28`	`_interface = xrInt;`
`29`	`29`	`}`
`30`	`30`
`31`		`- public ElementBase CreateHeadElement()`
	`31`	`+ public ElementBase CreateHeadElement(bool persistent = false)`
`32`	`32`	`{`
`33`		`- var elem = CreateElement();`
	`33`	`+ var elem = CreateElement(persistent);`
`34`	`34`	`elem.HeadMode = true;`
`35`	`35`	`return elem;`
`36`	`36`	`}`
`37`		`- public ElementBase CreateWorldElement()`
	`37`	`+ public ElementBase CreateWorldElement(bool persistent = false)`
`38`	`38`	`{`
`39`		`- var elem = CreateElement();`
	`39`	`+ var elem = CreateElement(persistent);`
`40`	`40`	`return elem;`
`41`	`41`	`}`
`42`	`42`
`@@ -60,9 +60,9 @@ public Transform3D EyeTransform(bool left)`
`60`	`60`	`return new Transform3D(head.Basis, eyeBall.Origin);`
`61`	`61`	`}`
`62`	`62`
`63`		`- private OpenVRElement CreateElement()`
	`63`	`+ private OpenVRElement CreateElement(bool persistent = false)`
`64`	`64`	`{`
`65`		`- if (_storedPool.TryPop(out var result))`
	`65`	`+ if (!persistent && _storedPool.TryPop(out var result))`
`66`	`66`	`{`
`67`	`67`	`_usedPool.Add(result);`
`68`	`68`	`result.Visible = true;`
`@@ -71,7 +71,7 @@ private OpenVRElement CreateElement()`
`71`	`71`	`result = ResourceLoader.Load<PackedScene>("res://Scenes/Elements/OpenVRElement.tscn")`
`72`	`72`	`.Instantiate<OpenVRElement>();`
`73`	`73`	`ElementRoot.AddChild(result);`
`74`		`- _usedPool.Add(result);`
	`74`	`+ if (!persistent) _usedPool.Add(result);`
`75`	`75`	`return result;`
`76`	`76`	`}`
`77`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,12 +16,12 @@ public void Initialize()`
`16`	`16`	`throw new System.NotImplementedException();`
`17`	`17`	`}`
`18`	`18`
`19`		`- public ElementBase CreateHeadElement()`
	`19`	`+ public ElementBase CreateHeadElement(bool persistent = false)`
`20`	`20`	`{`
`21`	`21`	`throw new System.NotImplementedException();`
`22`	`22`	`}`
`23`	`23`
`24`		`- public ElementBase CreateWorldElement()`
	`24`	`+ public ElementBase CreateWorldElement(bool persistent = false)`
`25`	`25`	`{`
`26`	`26`	`throw new System.NotImplementedException();`
`27`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@ public partial class OpenXRElement : ElementBase`
`8`	`8`	`[Export] public MeshInstance3D Mesh;`
`9`	`9`	`[Export] public PlaneMesh PlaneMesh;`
`10`	`10`	`[Export] public Node3D Head;`
	`11`	`+ [Export] public bool IsInternal = false;`
`11`	`12`
`12`	`13`	`public override Transform3D ElementTransform`
`13`	`14`	`{`