bauiv1lib.gather

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Provides UI for inviting/joining friends."""
  4
  5from __future__ import annotations
  6
  7import weakref
  8import logging
  9from enum import Enum
 10
 11from bauiv1lib.tabs import TabRow
 12import bauiv1 as bui
 13
 14
 15class GatherTab:
 16    """Defines a tab for use in the gather UI."""
 17
 18    def __init__(self, window: GatherWindow) -> None:
 19        self._window = weakref.ref(window)
 20
 21    @property
 22    def window(self) -> GatherWindow:
 23        """The GatherWindow that this tab belongs to."""
 24        window = self._window()
 25        if window is None:
 26            raise bui.NotFoundError("GatherTab's window no longer exists.")
 27        return window
 28
 29    def on_activate(
 30        self,
 31        parent_widget: bui.Widget,
 32        tab_button: bui.Widget,
 33        region_width: float,
 34        region_height: float,
 35        region_left: float,
 36        region_bottom: float,
 37    ) -> bui.Widget:
 38        """Called when the tab becomes the active one.
 39
 40        The tab should create and return a container widget covering the
 41        specified region.
 42        """
 43        raise RuntimeError('Should not get here.')
 44
 45    def on_deactivate(self) -> None:
 46        """Called when the tab will no longer be the active one."""
 47
 48    def save_state(self) -> None:
 49        """Called when the parent window is saving state."""
 50
 51    def restore_state(self) -> None:
 52        """Called when the parent window is restoring state."""
 53
 54
 55class GatherWindow(bui.Window):
 56    """Window for joining/inviting friends."""
 57
 58    class TabID(Enum):
 59        """Our available tab types."""
 60
 61        ABOUT = 'about'
 62        INTERNET = 'internet'
 63        PRIVATE = 'private'
 64        NEARBY = 'nearby'
 65        MANUAL = 'manual'
 66
 67    def __init__(
 68        self,
 69        transition: str | None = 'in_right',
 70        origin_widget: bui.Widget | None = None,
 71    ):
 72        # pylint: disable=too-many-statements
 73        # pylint: disable=too-many-locals
 74        # pylint: disable=cyclic-import
 75        from bauiv1lib.gather.abouttab import AboutGatherTab
 76        from bauiv1lib.gather.manualtab import ManualGatherTab
 77        from bauiv1lib.gather.privatetab import PrivateGatherTab
 78        from bauiv1lib.gather.publictab import PublicGatherTab
 79        from bauiv1lib.gather.nearbytab import NearbyGatherTab
 80
 81        plus = bui.app.plus
 82        assert plus is not None
 83
 84        bui.set_analytics_screen('Gather Window')
 85        scale_origin: tuple[float, float] | None
 86        if origin_widget is not None:
 87            self._transition_out = 'out_scale'
 88            scale_origin = origin_widget.get_screen_space_center()
 89            transition = 'in_scale'
 90        else:
 91            self._transition_out = 'out_right'
 92            scale_origin = None
 93        assert bui.app.classic is not None
 94        bui.app.ui_v1.set_main_menu_location('Gather')
 95        bui.set_party_icon_always_visible(True)
 96        uiscale = bui.app.ui_v1.uiscale
 97        self._width = 1240 if uiscale is bui.UIScale.SMALL else 1040
 98        x_offs = 100 if uiscale is bui.UIScale.SMALL else 0
 99        self._height = (
100            582
101            if uiscale is bui.UIScale.SMALL
102            else 680
103            if uiscale is bui.UIScale.MEDIUM
104            else 800
105        )
106        self._current_tab: GatherWindow.TabID | None = None
107        extra_top = 20 if uiscale is bui.UIScale.SMALL else 0
108        self._r = 'gatherWindow'
109
110        super().__init__(
111            root_widget=bui.containerwidget(
112                size=(self._width, self._height + extra_top),
113                transition=transition,
114                toolbar_visibility='menu_minimal',
115                scale_origin_stack_offset=scale_origin,
116                scale=(
117                    1.3
118                    if uiscale is bui.UIScale.SMALL
119                    else 0.97
120                    if uiscale is bui.UIScale.MEDIUM
121                    else 0.8
122                ),
123                stack_offset=(0, -11)
124                if uiscale is bui.UIScale.SMALL
125                else (0, 0)
126                if uiscale is bui.UIScale.MEDIUM
127                else (0, 0),
128            )
129        )
130
131        if uiscale is bui.UIScale.SMALL and bui.app.ui_v1.use_toolbars:
132            bui.containerwidget(
133                edit=self._root_widget, on_cancel_call=self._back
134            )
135            self._back_button = None
136        else:
137            self._back_button = btn = bui.buttonwidget(
138                parent=self._root_widget,
139                position=(70 + x_offs, self._height - 74),
140                size=(140, 60),
141                scale=1.1,
142                autoselect=True,
143                label=bui.Lstr(resource='backText'),
144                button_type='back',
145                on_activate_call=self._back,
146            )
147            bui.containerwidget(edit=self._root_widget, cancel_button=btn)
148            bui.buttonwidget(
149                edit=btn,
150                button_type='backSmall',
151                position=(70 + x_offs, self._height - 78),
152                size=(60, 60),
153                label=bui.charstr(bui.SpecialChar.BACK),
154            )
155
156        condensed = uiscale is not bui.UIScale.LARGE
157        t_offs_y = (
158            0 if not condensed else 25 if uiscale is bui.UIScale.MEDIUM else 17
159        )
160        bui.textwidget(
161            parent=self._root_widget,
162            position=(self._width * 0.5, self._height - 42 + t_offs_y),
163            size=(0, 0),
164            color=bui.app.ui_v1.title_color,
165            scale=(
166                1.5
167                if not condensed
168                else 1.0
169                if uiscale is bui.UIScale.MEDIUM
170                else 0.6
171            ),
172            h_align='center',
173            v_align='center',
174            text=bui.Lstr(resource=self._r + '.titleText'),
175            maxwidth=550,
176        )
177
178        scroll_buffer_h = 130 + 2 * x_offs
179        tab_buffer_h = (320 if condensed else 250) + 2 * x_offs
180
181        # Build up the set of tabs we want.
182        tabdefs: list[tuple[GatherWindow.TabID, bui.Lstr]] = [
183            (self.TabID.ABOUT, bui.Lstr(resource=self._r + '.aboutText'))
184        ]
185        if plus.get_v1_account_misc_read_val('enablePublicParties', True):
186            tabdefs.append(
187                (
188                    self.TabID.INTERNET,
189                    bui.Lstr(resource=self._r + '.publicText'),
190                )
191            )
192        tabdefs.append(
193            (self.TabID.PRIVATE, bui.Lstr(resource=self._r + '.privateText'))
194        )
195        tabdefs.append(
196            (self.TabID.NEARBY, bui.Lstr(resource=self._r + '.nearbyText'))
197        )
198        tabdefs.append(
199            (self.TabID.MANUAL, bui.Lstr(resource=self._r + '.manualText'))
200        )
201
202        # On small UI, push our tabs up closer to the top of the screen to
203        # save a bit of space.
204        tabs_top_extra = 42 if condensed else 0
205        self._tab_row = TabRow(
206            self._root_widget,
207            tabdefs,
208            pos=(tab_buffer_h * 0.5, self._height - 130 + tabs_top_extra),
209            size=(self._width - tab_buffer_h, 50),
210            on_select_call=bui.WeakCall(self._set_tab),
211        )
212
213        # Now instantiate handlers for these tabs.
214        tabtypes: dict[GatherWindow.TabID, type[GatherTab]] = {
215            self.TabID.ABOUT: AboutGatherTab,
216            self.TabID.MANUAL: ManualGatherTab,
217            self.TabID.PRIVATE: PrivateGatherTab,
218            self.TabID.INTERNET: PublicGatherTab,
219            self.TabID.NEARBY: NearbyGatherTab,
220        }
221        self._tabs: dict[GatherWindow.TabID, GatherTab] = {}
222        for tab_id in self._tab_row.tabs:
223            tabtype = tabtypes.get(tab_id)
224            if tabtype is not None:
225                self._tabs[tab_id] = tabtype(self)
226
227        if bui.app.ui_v1.use_toolbars:
228            bui.widget(
229                edit=self._tab_row.tabs[tabdefs[-1][0]].button,
230                right_widget=bui.get_special_widget('party_button'),
231            )
232            if uiscale is bui.UIScale.SMALL:
233                bui.widget(
234                    edit=self._tab_row.tabs[tabdefs[0][0]].button,
235                    left_widget=bui.get_special_widget('back_button'),
236                )
237
238        self._scroll_width = self._width - scroll_buffer_h
239        self._scroll_height = self._height - 180.0 + tabs_top_extra
240
241        self._scroll_left = (self._width - self._scroll_width) * 0.5
242        self._scroll_bottom = (
243            self._height - self._scroll_height - 79 - 48 + tabs_top_extra
244        )
245        buffer_h = 10
246        buffer_v = 4
247
248        # Not actually using a scroll widget anymore; just an image.
249        bui.imagewidget(
250            parent=self._root_widget,
251            position=(
252                self._scroll_left - buffer_h,
253                self._scroll_bottom - buffer_v,
254            ),
255            size=(
256                self._scroll_width + 2 * buffer_h,
257                self._scroll_height + 2 * buffer_v,
258            ),
259            texture=bui.gettexture('scrollWidget'),
260            mesh_transparent=bui.getmesh('softEdgeOutside'),
261        )
262        self._tab_container: bui.Widget | None = None
263
264        self._restore_state()
265
266    def __del__(self) -> None:
267        bui.set_party_icon_always_visible(False)
268
269    def playlist_select(self, origin_widget: bui.Widget) -> None:
270        """Called by the private-hosting tab to select a playlist."""
271        from bauiv1lib.play import PlayWindow
272
273        self._save_state()
274        bui.containerwidget(edit=self._root_widget, transition='out_left')
275        assert bui.app.classic is not None
276        bui.app.ui_v1.selecting_private_party_playlist = True
277        bui.app.ui_v1.set_main_menu_window(
278            PlayWindow(origin_widget=origin_widget).get_root_widget()
279        )
280
281    def _set_tab(self, tab_id: TabID) -> None:
282        if self._current_tab is tab_id:
283            return
284        prev_tab_id = self._current_tab
285        self._current_tab = tab_id
286
287        # We wanna preserve our current tab between runs.
288        cfg = bui.app.config
289        cfg['Gather Tab'] = tab_id.value
290        cfg.commit()
291
292        # Update tab colors based on which is selected.
293        self._tab_row.update_appearance(tab_id)
294
295        if prev_tab_id is not None:
296            prev_tab = self._tabs.get(prev_tab_id)
297            if prev_tab is not None:
298                prev_tab.on_deactivate()
299
300        # Clear up prev container if it hasn't been done.
301        if self._tab_container:
302            self._tab_container.delete()
303
304        tab = self._tabs.get(tab_id)
305        if tab is not None:
306            self._tab_container = tab.on_activate(
307                self._root_widget,
308                self._tab_row.tabs[tab_id].button,
309                self._scroll_width,
310                self._scroll_height,
311                self._scroll_left,
312                self._scroll_bottom,
313            )
314            return
315
316    def _save_state(self) -> None:
317        try:
318            for tab in self._tabs.values():
319                tab.save_state()
320
321            sel = self._root_widget.get_selected_child()
322            selected_tab_ids = [
323                tab_id
324                for tab_id, tab in self._tab_row.tabs.items()
325                if sel == tab.button
326            ]
327            if sel == self._back_button:
328                sel_name = 'Back'
329            elif selected_tab_ids:
330                assert len(selected_tab_ids) == 1
331                sel_name = f'Tab:{selected_tab_ids[0].value}'
332            elif sel == self._tab_container:
333                sel_name = 'TabContainer'
334            else:
335                raise ValueError(f'unrecognized selection: \'{sel}\'')
336            assert bui.app.classic is not None
337            bui.app.ui_v1.window_states[type(self)] = {
338                'sel_name': sel_name,
339            }
340        except Exception:
341            logging.exception('Error saving state for %s.', self)
342
343    def _restore_state(self) -> None:
344        from efro.util import enum_by_value
345
346        try:
347            for tab in self._tabs.values():
348                tab.restore_state()
349
350            sel: bui.Widget | None
351            assert bui.app.classic is not None
352            winstate = bui.app.ui_v1.window_states.get(type(self), {})
353            sel_name = winstate.get('sel_name', None)
354            assert isinstance(sel_name, (str, type(None)))
355            current_tab = self.TabID.ABOUT
356            gather_tab_val = bui.app.config.get('Gather Tab')
357            try:
358                stored_tab = enum_by_value(self.TabID, gather_tab_val)
359                if stored_tab in self._tab_row.tabs:
360                    current_tab = stored_tab
361            except ValueError:
362                pass
363            self._set_tab(current_tab)
364            if sel_name == 'Back':
365                sel = self._back_button
366            elif sel_name == 'TabContainer':
367                sel = self._tab_container
368            elif isinstance(sel_name, str) and sel_name.startswith('Tab:'):
369                try:
370                    sel_tab_id = enum_by_value(
371                        self.TabID, sel_name.split(':')[-1]
372                    )
373                except ValueError:
374                    sel_tab_id = self.TabID.ABOUT
375                sel = self._tab_row.tabs[sel_tab_id].button
376            else:
377                sel = self._tab_row.tabs[current_tab].button
378            bui.containerwidget(edit=self._root_widget, selected_child=sel)
379
380        except Exception:
381            logging.exception('Error restoring state for %s.', self)
382
383    def _back(self) -> None:
384        from bauiv1lib.mainmenu import MainMenuWindow
385
386        self._save_state()
387        bui.containerwidget(
388            edit=self._root_widget, transition=self._transition_out
389        )
390        assert bui.app.classic is not None
391        bui.app.ui_v1.set_main_menu_window(
392            MainMenuWindow(transition='in_left').get_root_widget()
393        )