Add textboxes. (facebookresearch#1957)

habitat-hitl/habitat_hitl/core/client_message_manager.py

@@ -28,6 +28,18 @@ def __init__(self, button_id: str, text: str, enabled: bool):
         self.enabled = enabled
 
 
+@dataclass
+class UITextbox:
+    """
+    Networked UI textbox. Use RemoteClientState.get_textbox_content() to retrieve content.
+    """
+
+    def __init__(self, textbox_id: str, text: str, enabled: bool):
+        self.textbox_id = textbox_id
+        self.text = text
+        self.enabled = enabled
+
+
 class ClientMessageManager:
     r"""
     Extends gfx-replay keyframes to include server messages to be interpreted by the clients.
@@ -163,6 +175,7 @@ def show_modal_dialogue_box(
         title: str,
         text: str,
         buttons: List[UIButton],
+        textbox: Optional[UITextbox] = None,
         destination_mask: Mask = Mask.ALL,
     ):
         r"""
@@ -177,6 +190,12 @@ def show_modal_dialogue_box(
                 "text": text,
                 "buttons": [],
             }
+            if textbox is not None:
+                message["dialog"]["textbox"] = {
+                    "id": textbox.textbox_id,
+                    "text": textbox.text,
+                    "enabled": textbox.enabled,
+                }
             for button in buttons:
                 message["dialog"]["buttons"].append(
                     {

habitat-hitl/habitat_hitl/core/remote_client_state.py

@@ -5,7 +5,7 @@
 # LICENSE file in the root directory of this source tree.
 
 import math
-from typing import Any, List, Optional, Set, Tuple
+from typing import Any, Dict, List, Optional, Set, Tuple
 
 import magnum as mn
 
@@ -51,6 +51,7 @@ def __init__(
 
         # TODO: Handle UI in a different class.
         self._pressed_ui_buttons: List[Set[str]] = []
+        self._textboxes: List[Dict[str, str]] = []
 
         self._gui_inputs: List[GuiInput] = []
         self._client_state_history: List[List[ClientState]] = []
@@ -60,6 +61,7 @@ def __init__(
             self._client_state_history.append([])
             self._receive_rate_trackers.append(AverageRateTracker(2.0))
             self._pressed_ui_buttons.append(set())
+            self._textboxes.append({})
 
         self._client_loading: List[bool] = [False] * users.max_user_count
 
@@ -102,6 +104,10 @@ def bind_gui_input(self, gui_input: GuiInput, user_index: int) -> None:
     def ui_button_pressed(self, user_index: int, button_id: str) -> bool:
         return button_id in self._pressed_ui_buttons[user_index]
 
+    def get_textbox_content(self, user_index: int, textbox_id: str) -> str:
+        user_textboxes = self._textboxes[user_index]
+        return user_textboxes.get(textbox_id, "")
+
     def get_history_length(self) -> int:
         """Length of client state history preserved. Anything beyond this horizon is discarded."""
         return 4
@@ -236,6 +242,8 @@ def _update_input_state(
                 if ui is not None:
                     for button in ui.get("buttonsPressed", []):
                         self._pressed_ui_buttons[user_index].add(button)
+                    for textbox_id, text in ui.get("textboxes", {}).items():
+                        self._textboxes[user_index][textbox_id] = text
 
                 input_json = (
                     client_state["input"] if "input" in client_state else None
@@ -472,12 +480,14 @@ def on_frame_end(self) -> None:
         for user_index in self._users.indices(Mask.ALL):
             self._gui_inputs[user_index].on_frame_end()
             self._pressed_ui_buttons[user_index].clear()
+            self._textboxes[user_index].clear()
         self._new_connection_records = None
 
     def clear_history(self, user_mask=Mask.ALL) -> None:
         for user_index in self._users.indices(user_mask):
             self._client_state_history[user_index].clear()
             self._pressed_ui_buttons[user_index].clear()
+            self._textboxes[user_index].clear()
 
     def kick(self, user_mask: Mask) -> None:
         """