-
Notifications
You must be signed in to change notification settings - Fork 64
Expand file tree
/
Copy path_base.py
More file actions
363 lines (271 loc) · 10.8 KB
/
_base.py
File metadata and controls
363 lines (271 loc) · 10.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
import enum
from typing import Literal
import numpy as np
from imgui_bundle import imgui, icons_fontawesome_6 as fa
from ..layouts._figure import Figure
# width of the collapse/expand button
COLLAPSE_BUTTON_WIDTH = 12
GUI_EDGES = ["right", "bottom"]
class BaseGUI:
"""
Base class for all ImGUI based GUIs, windows and popups
The main purpose of this base is for setting a unique ID between multiple figs with identical UI elements
This ID can be pushed in subclasses within the `update()` method
"""
ID_COUNTER: int = 0
def __init__(self):
BaseGUI.ID_COUNTER += 1
self._id_counter = BaseGUI.ID_COUNTER
def update(self):
"""must be implemented in subclass"""
raise NotImplementedError
class Window(BaseGUI):
"""Base class for imgui windows drawn within Figures"""
pass
class EdgeWindow(Window):
def __init__(
self,
figure: Figure,
size: int,
location: Literal["bottom", "right"],
title: str,
window_flags: enum.IntFlag = imgui.WindowFlags_.no_collapse
| imgui.WindowFlags_.no_resize,
*args,
**kwargs,
):
"""
A base class for imgui windows displayed at the bottom or top edge of a Figure
Parameters
----------
figure: Figure
Figure instance that this window will be placed in
size: int
width or height of the window, depending on its location
location: str, "bottom" | "right"
location of the window
title: str
window title
window_flags: enum.IntFlag
Window flag enum, can be compared with ``|`` operator. Valid flags are:
.. code-block:: py
imgui.WindowFlags_.no_title_bar
imgui.WindowFlags_.no_resize
imgui.WindowFlags_.no_move
imgui.WindowFlags_.no_scrollbar
imgui.WindowFlags_.no_scroll_with_mouse
imgui.WindowFlags_.no_collapse
imgui.WindowFlags_.always_auto_resize
imgui.WindowFlags_.no_background
imgui.WindowFlags_.no_saved_settings
imgui.WindowFlags_.no_mouse_inputs
imgui.WindowFlags_.menu_bar
imgui.WindowFlags_.horizontal_scrollbar
imgui.WindowFlags_.no_focus_on_appearing
imgui.WindowFlags_.no_bring_to_front_on_focus
imgui.WindowFlags_.always_vertical_scrollbar
imgui.WindowFlags_.always_horizontal_scrollbar
imgui.WindowFlags_.no_nav_inputs
imgui.WindowFlags_.no_nav_focus
imgui.WindowFlags_.unsaved_document
imgui.WindowFlags_.no_docking
imgui.WindowFlags_.no_nav
imgui.WindowFlags_.no_decoration
imgui.WindowFlags_.no_inputs
*args
additional args for the GUI
**kwargs
additional kwargs for teh GUI
"""
super().__init__()
if location not in GUI_EDGES:
f"GUI does not have a valid location, valid locations are: {GUI_EDGES}, you have passed: {location}"
self._figure = figure
self._size = size
self._location = location
self._title = title
self._window_flags = window_flags
# collapse state for right-side GUI panels
# TODO: other sides when they're supported
self._collapsed = False
self._x, self._y, self._width, self._height = self.get_rect()
self._figure.canvas.add_event_handler(self._set_rect, "resize")
@property
def size(self) -> int | None:
"""width or height of the edge window"""
return self._size
@size.setter
def size(self, value):
if not isinstance(value, int):
raise TypeError
self._size = value
@property
def location(self) -> str:
"""location of the window"""
return self._location
@property
def x(self) -> int:
"""canvas x position of the window"""
return self._x
@property
def y(self) -> int:
"""canvas y position of the window"""
return self._y
@property
def width(self) -> int:
"""with the window"""
return self._width
@property
def height(self) -> int:
"""height of the window"""
return self._height
@property
def collapsed(self) -> bool:
"""whether the window is collapsed, only applicable to right-side GUI"""
return self._collapsed
@collapsed.setter
def collapsed(self, value: bool):
# TODO: support other edges when needed
if self._location != "right":
return
self._collapsed = bool(value)
self._set_rect()
def _set_rect(self, *args):
self._x, self._y, self._width, self._height = self.get_rect()
def get_rect(self) -> tuple[int, int, int, int]:
"""
Compute the rect that defines the area this GUI is drawn to
Returns
-------
int, int, int, int
x_pos, y_pos, width, height
"""
width_canvas, height_canvas = self._figure.canvas.get_logical_size()
match self._location:
case "bottom":
x_pos = 0
y_pos = height_canvas - self.size
width, height = (width_canvas, self.size)
case "right":
# GUI panel starts after the collapse button area
x_pos, y_pos = (width_canvas - self.size, 0)
width, height = (self.size, height_canvas)
if self._figure.guis["bottom"] is not None:
height -= self._figure.guis["bottom"].size
return x_pos, y_pos, width, height
def draw_window(self):
"""helps simplify using imgui by managing window creation & position, and pushing/popping the ID"""
if self._location == "right" and self._collapsed:
self._draw_expand_button()
return
if self._location == "right":
self._draw_collapse_button()
# window position & size
x, y, w, h = self.get_rect()
imgui.set_next_window_size((self.width, self.height))
imgui.set_next_window_pos((self.x, self.y))
flags = self._window_flags
# begin window
imgui.begin(self._title, p_open=None, flags=flags)
# push ID to prevent conflict between multiple figs with same UI
imgui.push_id(self._id_counter)
# draw stuff from subclass into window
self.update()
# pop ID
imgui.pop_id()
# end the window
imgui.end()
def _draw_collapse_button(self):
"""draw collapse button in the reserved area between plot and GUI panel"""
width_canvas, height_canvas = self._figure.canvas.get_logical_size()
# account for bottom GUI if present
if self._figure.guis["bottom"] is not None:
height_canvas -= self._figure.guis["bottom"].size
x_pos = width_canvas - self._size - COLLAPSE_BUTTON_WIDTH
y_pos = 0
# remove all window padding so position is exact
imgui.push_style_var(imgui.StyleVar_.window_padding, (0, 0))
imgui.set_next_window_pos((x_pos, y_pos))
imgui.set_next_window_size((COLLAPSE_BUTTON_WIDTH, height_canvas))
flags = (
imgui.WindowFlags_.no_title_bar
| imgui.WindowFlags_.no_resize
| imgui.WindowFlags_.no_move
| imgui.WindowFlags_.no_scrollbar
| imgui.WindowFlags_.no_collapse
| imgui.WindowFlags_.no_background
)
imgui.begin(f"collapse-{self._title}", p_open=None, flags=flags)
imgui.push_id(self._id_counter + 1000)
# transparent button, visible on hover
imgui.push_style_color(imgui.Col_.button, (0, 0, 0, 0))
imgui.push_style_color(imgui.Col_.button_hovered, (0.5, 0.5, 0.5, 0.5))
imgui.push_style_color(imgui.Col_.button_active, (0.6, 0.6, 0.6, 0.6))
if imgui.button(fa.ICON_FA_CARET_RIGHT, (COLLAPSE_BUTTON_WIDTH, height_canvas)):
self._collapsed = True
self._set_rect()
self._figure._fpl_reset_layout()
imgui.pop_style_color(3)
if imgui.is_item_hovered(0):
imgui.set_tooltip("collapse")
imgui.pop_id()
imgui.end()
imgui.pop_style_var(1) # window_padding
def _draw_expand_button(self):
"""draw expand button at right edge when collapsed"""
width_canvas, height_canvas = self._figure.canvas.get_logical_size()
# account for bottom GUI if present
if self._figure.guis["bottom"] is not None:
height_canvas -= self._figure.guis["bottom"].size
x_pos = width_canvas - COLLAPSE_BUTTON_WIDTH
y_pos = 0
# remove all window padding so position is exact
imgui.push_style_var(imgui.StyleVar_.window_padding, (0, 0))
imgui.set_next_window_pos((x_pos, y_pos))
imgui.set_next_window_size((COLLAPSE_BUTTON_WIDTH, height_canvas))
flags = (
imgui.WindowFlags_.no_title_bar
| imgui.WindowFlags_.no_resize
| imgui.WindowFlags_.no_move
| imgui.WindowFlags_.no_scrollbar
| imgui.WindowFlags_.no_collapse
| imgui.WindowFlags_.no_background
)
imgui.begin(f"expand-{self._title}", p_open=None, flags=flags)
imgui.push_id(self._id_counter)
# visible button - needs to stand out when panel is collapsed
imgui.push_style_color(imgui.Col_.button, (0.4, 0.4, 0.4, 0.9))
imgui.push_style_color(imgui.Col_.button_hovered, (0.5, 0.5, 0.5, 1.0))
imgui.push_style_color(imgui.Col_.button_active, (0.6, 0.6, 0.6, 1.0))
if imgui.button(fa.ICON_FA_CARET_LEFT, (COLLAPSE_BUTTON_WIDTH, height_canvas)):
self._collapsed = False
self._set_rect()
self._figure._fpl_reset_layout()
imgui.pop_style_color(3)
if imgui.is_item_hovered(0):
imgui.set_tooltip("expand")
imgui.pop_id()
imgui.end()
imgui.pop_style_var(1) # window_padding
def update(self):
"""Implement your GUI here and it will be drawn within the window. See the GUI examples"""
raise NotImplementedError
class Popup(BaseGUI):
def __init__(self, figure: Figure, *args, **kwargs):
"""
Base class for creating ImGUI popups within Figures
Parameters
----------
figure: Figure
Figure instance
*args
any args to pass to subclass constructor
**kwargs
any kwargs to pass to subclass constructor
"""
super().__init__()
self._figure = figure
self.is_open = False
def open(self, pos: tuple[int, int], *args, **kwargs):
"""implement in subclass"""
raise NotImplementedError