forked from jayanam/bl_ui_widgets
-
Notifications
You must be signed in to change notification settings - Fork 4
/
bl_ui_drag_panel.py
226 lines (193 loc) · 10.1 KB
/
bl_ui_drag_panel.py
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
# ##### BEGIN GPL LICENSE BLOCK #####
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# ##### END GPL LICENSE BLOCK #####
# --- ### Header
bl_info = {"name": "BL UI Widgets",
"description": "UI Widgets to draw in the 3D view",
"author": "Marcelo M. Marques (fork of Jayanam's original project)",
"version": (1, 0, 2),
"blender": (2, 80, 75),
"location": "View3D > viewport area",
"support": "COMMUNITY",
"category": "3D View",
"warning": "Version numbering diverges from Jayanam's original project",
"doc_url": "https://github.com/mmmrqs/bl_ui_widgets",
"tracker_url": "https://github.com/mmmrqs/bl_ui_widgets/issues"
}
# --- ### Change log
# v1.0.2 (09.25.2022) - by Marcelo M. Marques
# Added: 'quadview' property to indicate whether panel is opened in the QuadView mode or not
# Chang: Logic to save panel screen position only when not in QuadView mode. In some future release this may get improved
# to save the position in both cases, but to distinct sets of variables in the session's saved data dictionary
# v1.0.1 (09.20.2021) - by Marcelo M. Marques
# Chang: just some pep8 code formatting
# v1.0.0 (09.01.2021) - by Marcelo M. Marques
# Added: A control to check if the panel can be dragged by the user or must stay locked in position
# Added: Logic to save/restore panel position from last session, or from last use (depending on addon 'preferences' setup)
# Added: Logic to scale the panel according to both Blender's ui scale configuration and this addon 'preferences' setup
# Added: 'style' property which automatically sets the visual according to Blender's user themes.
# Added: 'outline_color' property to allow different color on the panel outline (value is standard color tuple).
# Added: 'roundness' property to allow the panel to be painted with rounded corners,
# same as that property available in Blender's user themes and it works together with 'rounded_corners' below.
# Added: 'corner_radius' property to allow a limit for the roundness curvature, more useful when 'roundness' property
# is not overriden by programmer and the one from Blender's user themes is used instead.
# Added: 'rounded_corners' property to allow the panel to be painted with rounded corners (value is a 4 elements tuple).
# Each elements is a boolean value (0 or 1) which indicates whether the corresponding corner is to be rounded or straight
# in the following clockwise sequence: bottom left, top left, top right, bottom right.
# Added: 'shadow' property to allow the panel to be painted with a shadow (value is boolean).
# Chang: Made it a subclass of 'BL_UI_Patch' instead of 'BL_UI_Widget' so that it can inherit the layout features from there.
# Chang: Renamed some local variables so that those become restricted to this class only.
# --- ### Imports
import bpy
from . bl_ui_patch import BL_UI_Patch
class BL_UI_Drag_Panel(BL_UI_Patch):
def __init__(self, x, y, width, height):
try:
if __package__.find(".") != -1:
package = __package__[0:__package__.find(".")]
else:
package = __package__
RC_POSITION = bpy.context.preferences.addons[package].preferences.RC_POSITION
RC_POS_X = bpy.context.preferences.addons[package].preferences.RC_POS_X
RC_POS_Y = bpy.context.preferences.addons[package].preferences.RC_POS_Y
except Exception as e:
RC_POSITION = False
if RC_POSITION:
if RC_POS_X != -10000 and RC_POS_Y != -10000:
# Override input values with the ones saved from last time (any scene/session)
x = RC_POS_X
y = RC_POS_Y
else:
if bpy.context.scene.get("bl_ui_panel_saved_data") is None:
pass
else:
# Override input values with the ones saved from last session
x = bpy.context.scene.get("bl_ui_panel_saved_data")["panX"]
y = bpy.context.scene.get("bl_ui_panel_saved_data")["panY"]
# Need to apply scale to compensate for posterior calculations
x = (x / self.over_scale(1))
y = (y / self.over_scale(1))
super().__init__(x, y, width, height)
self.widgets = []
# Note: '_style' value will always be ignored if the bg_color value is overriden after object initialization.
self._style = 'NONE' # Panel background color styles are: {HEADER,PANEL,SUBPANEL,TOOLTIP,NONE}
self._bg_color = None # Panel background color (defaults to invisible)
self._outline_color = None # Panel outline color (defaults to invisible)
self._roundness = 0 # Panel corners roundness factor [0..1]
self._radius = 0 # Panel corners circular radius
self._rounded_corners = (0, 0, 0, 0) # 1=Round/0=Straight, coords:(bottomLeft,topLeft,topRight,bottomRight)
self._has_shadow = False # Indicates whether a shadow must be drawn around the panel
self._anchored = False # Indicates whether panel can be dragged around the viewport or not
self._quadview = False # Indicates whether panel is opened in the QuadView mode or not
self.__drag_offset_x = 0
self.__drag_offset_y = 0
self.__is_drag = False
@property
def anchored(self):
return self._anchored
@anchored.setter
def anchored(self, value):
self._anchored = value
@property
def quadview(self):
return self._quadview
@quadview.setter
def quadview(self, value):
self._quadview = value
def add_widget(self, widget):
self.widgets.append(widget)
def add_widgets(self, widgets):
for widget in widgets:
self.add_widget(widget)
def layout_widgets(self):
for widget in self.widgets:
widget.update(self.x_screen + widget.x, self.y_screen - widget.y)
def child_widget_focused(self, x, y):
for widget in self.widgets:
if widget.visible:
if widget.is_in_rect(x, y):
return True
return False
def save_panel_coords(self, x, y):
# Update the new coord values in the session's saved data dictionary, only when not in QuadView mode
if self.quadview:
return None
# Note: Because of the scaling logic it was necessary to make this weird correction math below
new_x = self.over_scale(x)
new_y = self.over_scale(y)
bpy.context.scene["bl_ui_panel_saved_data"] = {"panX": new_x, "panY": new_y}
try:
# Update values also in the add-on's preferences properties
if __package__.find(".") != -1:
package = __package__[0:__package__.find(".")]
else:
package = __package__
bpy.context.preferences.addons[package].preferences.RC_POS_X = new_x
bpy.context.preferences.addons[package].preferences.RC_POS_Y = new_y
except Exception as e:
pass
# Overrides base class function
def update(self, x, y):
super().update(x, y)
if self.__is_drag:
# Inform that widget has shift position so that tooltip know it must be recalculated
base_class = super().__thisclass__.__mro__[-2] # This stunt only to avoid hard coding the Base class name
widget = base_class.g_tooltip_widget
if widget is None:
pass
else:
widget.tooltip_moved = True
# Overrides base class function
def set_location(self, x, y):
super().set_location(x, y)
self.layout_widgets()
# Overrides base class function
def mouse_down(self, event, x, y):
if self.anchored:
# Means the panel is not draggable
return False
if self.is_in_rect(x, y):
if self.child_widget_focused(x, y):
# Means the focus is on some sub-widget (e.g.: a button)
return False
# When panel is disabled, just ignore the click
if self._is_enabled:
height = self.get_area_height()
self.__is_drag = True
self.__drag_offset_x = x - self.x_screen
self.__drag_offset_y = y - self.y_screen
return True # <-- Perhaps should only return 'True' if self._is_enabled (TBD)
else:
return False
# Overrides base class function
def mouse_move(self, event, x, y):
if self.__is_drag:
# Recalculate and update the new position on the viewport
#new_x = x - self.__drag_offset_x
#new_y = y - self.__drag_offset_y
new_x = (x - self.__drag_offset_x) * 1 / self.over_scale(1)
new_y = (y - self.__drag_offset_y) * 1 / self.over_scale(1)
self.save_panel_coords(new_x, new_y)
self.update(new_x, new_y)
self.layout_widgets()
return False
# Overrides base class function
def mouse_up(self, event, x, y):
self.__is_drag = False
self.__drag_offset_x = 0
self.__drag_offset_y = 0
return False