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 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
|
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# PatchBay Canvas engine using QGraphicsView/Scene
# Copyright (C) 2010-2019 Filipe Coelho <falktx@falktx.com>
# Copyright (C) 2019-2024 Mathieu Picot <picotmathieu@gmail.com>
#
# 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 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.
#
# For a full copy of the GNU General Public License see the doc/GPL.txt file.
from typing import TYPE_CHECKING, Optional, Iterator
from qtpy.QtCore import Qt
from qtpy.QtGui import (QColor, QLinearGradient,
QPainterPath, QPen, QBrush)
from qtpy.QtWidgets import QGraphicsPathItem
from patshared import PortType, PortMode
from .init_values import (
ConnectionThemeState,
BoxHidding,
canvas,
options,
CanvasItemType,
Zv)
if TYPE_CHECKING:
from .box_widget import BoxWidget
_groups_to_check = set[tuple[int, int]]()
_all_lines_widgets = {}
if TYPE_CHECKING:
_all_lines_widgets: dict[
tuple[int, int],
dict[PortType, dict[ConnectionThemeState,
'GroupedLinesWidget']]]
class GroupOutInsDict(dict):
def __init__(self):
dict.__init__(self)
def add_group_ids(self, group_out_id: int, group_in_id: int):
gp_set: Optional[set] = self.get(group_out_id)
if gp_set is None:
self[group_out_id] = gp_set = set()
gp_set.add(group_in_id)
def send_changes(self):
for group_out_id, group_in_ids in self.items():
for group_in_id in group_in_ids:
GroupedLinesWidget.connections_changed(
group_out_id, group_in_id)
class _ThemeAttributes:
base_pen: QPen
color_main: QColor
color_alter: Optional[QColor]
base_width: float
class GroupedLinesWidget(QGraphicsPathItem):
def __init__(self, group_out_id: int, group_in_id: int,
port_type: PortType,
theme_state: ConnectionThemeState):
''' Class for connection line widget '''
canvas.ensure_init()
QGraphicsPathItem.__init__(self)
self._group_out_id = group_out_id
self._group_in_id = group_in_id
self._port_type = port_type
self._group_out_x = 0.0
self._group_in_x = 0.0
self._group_out_mid_y = 0.0
self._group_in_mid_y = 0.0
self._semi_hidden = False
'''is True when the two connected ports are on semi-hidden boxes.
The lines opacity becomes lighter.'''
self._th_attribs: Optional[_ThemeAttributes] = None
self._theme_state = theme_state
self.update_theme()
if theme_state is ConnectionThemeState.SELECTED:
self.setZValue(Zv.SEL_LINE.value)
else:
self.setZValue(Zv.LINE.value)
# get box_out and box_in
group_out = canvas.get_group(group_out_id)
group_in = canvas.get_group(group_in_id)
if group_out is None or group_in is None:
return
for box_out in group_out.widgets:
if PortMode.OUTPUT in box_out.get_port_mode():
break
else:
return
for box_in in group_in.widgets:
if PortMode.INPUT in box_in.get_port_mode():
break
else:
return
self._box_hidding_out = BoxHidding.NONE
self._box_hidding_in = BoxHidding.NONE
move_box_out = canvas.scene.move_boxes.get(box_out)
if move_box_out is not None:
self._box_hidding_out = move_box_out.hidding_state
move_box_in = canvas.scene.move_boxes.get(box_in)
if move_box_in is not None:
self._box_hidding_in = move_box_in.hidding_state
self.update_lines_pos(fast_move=True)
if (self._box_hidding_out is not BoxHidding.NONE
or self._box_hidding_in is not BoxHidding.NONE):
self.animate_hidding(0.0)
else:
self.update_line_gradient()
def __repr__(self) -> str:
return f'GroupedLines ({self._group_out_id} -> {self._group_in_id})'
@staticmethod
def clear_all_widgets():
'does not remove widgets from scene, it has to be down elsewhere.'
_all_lines_widgets.clear()
@staticmethod
def prepare_conn_changes(group_out_id: int, group_in_id: int):
_groups_to_check.add((group_out_id, group_in_id))
@staticmethod
def change_all_prepared_conns():
for gp_outin in _groups_to_check:
GroupedLinesWidget.connections_changed(*gp_outin)
_groups_to_check.clear()
@staticmethod
def connections_changed(group_out_id: int, group_in_id: int):
gp_dict = _all_lines_widgets.get((group_out_id, group_in_id))
if gp_dict is None:
gp_dict = {}
_all_lines_widgets[(group_out_id, group_in_id)] = gp_dict
to_update = dict[PortType, set[ConnectionThemeState]]()
new_widgets = set[GroupedLinesWidget]()
for conn in canvas.list_connections(
group_out_id=group_out_id, group_in_id=group_in_id):
theme_state = conn.theme_state()
to_update_type = to_update.get(conn.port_type)
if to_update_type is None:
to_update_type = set()
to_update[conn.port_type] = to_update_type
to_update_type.add(theme_state)
pt_dict = gp_dict.get(conn.port_type)
if pt_dict is None:
pt_dict = {}
gp_dict[conn.port_type] = pt_dict
widget = pt_dict.get(theme_state)
if widget is None:
pt_dict[theme_state] = GroupedLinesWidget(
group_out_id, group_in_id, conn.port_type,
theme_state)
canvas.scene.addItem(pt_dict[theme_state])
new_widgets.add(pt_dict[theme_state])
for port_type in gp_dict.keys():
pt_dict = gp_dict.get(port_type)
if pt_dict is None:
continue
if port_type not in to_update.keys():
if pt_dict is not None:
for widget in pt_dict.values():
canvas.scene.removeItem(widget)
pt_dict.clear()
continue
attrs_to_del = set[ConnectionThemeState]()
for theme_state, widget in pt_dict.items():
if theme_state not in to_update[port_type]:
canvas.scene.removeItem(widget)
attrs_to_del.add(theme_state)
elif widget not in new_widgets:
widget.update_theme()
widget.update_lines_pos()
for attr_to_del in attrs_to_del:
pt_dict.__delitem__(attr_to_del)
@staticmethod
def widgets_for_box(
group_id: int,
port_mode: PortMode) -> Iterator['GroupedLinesWidget']:
if port_mode is PortMode.OUTPUT:
gp_keys = [g for g in _all_lines_widgets if g[0] is group_id]
elif port_mode is PortMode.INPUT:
gp_keys = [g for g in _all_lines_widgets if g[1] is group_id]
elif port_mode is PortMode.BOTH:
gp_keys = [g for g in _all_lines_widgets if group_id in g]
else:
return
for gp_key in gp_keys:
for pt_dict in _all_lines_widgets[gp_key].values():
for widget in pt_dict.values():
yield widget
@staticmethod
def groups_semi_hidden(group_ids: set[int]):
for gp_dict, pt_dict in _all_lines_widgets.items():
gp_out_id, gp_in_id = gp_dict
semi_hidden = (gp_out_id in group_ids and gp_in_id in group_ids)
for tstate_dict in pt_dict.values():
for widget in tstate_dict.values():
if widget._semi_hidden is not semi_hidden:
widget.semi_hide(semi_hidden)
@staticmethod
def reset_z_values_with_selection(selected_boxes: 'list[BoxWidget]'):
selected_outs = set()
selected_ins = set()
for box in selected_boxes:
if box._port_mode & PortMode.OUTPUT:
selected_outs.add(box._group_id)
if box._port_mode & PortMode.INPUT:
selected_ins.add(box._group_id)
for gp_dict, pt_dict in _all_lines_widgets.items():
gp_out_id, gp_in_id = gp_dict
if gp_out_id in selected_outs or gp_in_id in selected_ins:
for tstate_dict in pt_dict.values():
for widget in tstate_dict.values():
widget.setZValue(Zv.SEL_BOX_LINE.value)
else:
for tstate_dict in pt_dict.values():
for widget in tstate_dict.values():
widget.setZValue(Zv.LINE.value)
@staticmethod
def update_opacity():
for pt_dict in _all_lines_widgets.values():
for tstate_dict in pt_dict.values():
for widget in tstate_dict.values():
if widget._semi_hidden:
widget.update_line_gradient()
@staticmethod
def animation_finished():
for pt_dict in _all_lines_widgets.values():
for tstate_dict in pt_dict.values():
for widget in tstate_dict.values():
widget.finish_animation()
def semi_hide(self, yesno: bool):
if self._semi_hidden is yesno:
return
self._semi_hidden = yesno
self.update_line_gradient()
if yesno:
self.setZValue(Zv.OPAC_LINE.value)
else:
self.setZValue(Zv.LINE.value)
def update_lines_pos(self, fast_move=False):
paths = dict[tuple[float, float], QPainterPath]()
groups_x_done = False
group_out_min_y = float('inf')
group_out_max_y = float('-inf')
group_in_min_y = float('inf')
group_in_max_y = float('-inf')
for conn in canvas.list_connections(
group_out_id=self._group_out_id,
group_in_id=self._group_in_id):
if conn.port_type is not self._port_type:
continue
if conn.theme_state() is not self._theme_state:
continue
port_out = canvas.get_port(self._group_out_id, conn.port_out_id)
port_in = canvas.get_port(self._group_in_id, conn.port_in_id)
if port_out is None or port_in is None:
continue
port_out_con_pos = port_out.widget.connect_pos()
port_in_con_pos = port_in.widget.connect_pos()
item1_x = port_out_con_pos.x()
item1_y = port_out_con_pos.y()
item2_x = port_in_con_pos.x()
item2_y = port_in_con_pos.y()
if not groups_x_done:
self._group_out_x = item1_x
self._group_in_x = item2_x
if (item1_y, item2_y) in paths.keys():
# same coords, do not draw 2 times the same path.
# (both boxes are very probably wrapped).
continue
group_out_min_y = min(group_out_min_y, item1_y)
group_out_max_y = max(group_out_max_y, item1_y)
group_in_min_y = min(group_in_min_y, item2_y)
group_in_max_y = max(group_in_max_y, item2_y)
existing_path = False
for key, value in paths.items():
y1, y2 = key
if item1_y - y1 == item2_y - y2:
paths[(item1_y, item2_y)] = value.translated(
0.0, item1_y - y1)
existing_path = True
break
if existing_path:
continue
x_diff = item2_x - item1_x
mid_x = abs(x_diff) / 2
diffxy = abs(item1_y - item2_y) - abs(x_diff)
if diffxy > 0:
mid_x += diffxy
mid_x = min(mid_x, max(200.0, x_diff / 2))
path = QPainterPath(port_out_con_pos)
path.cubicTo(item1_x + mid_x, item1_y,
item2_x - mid_x, item2_y,
item2_x, item2_y)
paths[(item1_y, item2_y)] = path
main_path = QPainterPath()
for path in paths.values():
main_path.addPath(path)
self.setPath(main_path)
self._group_out_mid_y = (group_out_max_y + group_out_min_y) * 0.5
self._group_in_mid_y = (group_in_max_y + group_in_min_y) * 0.5
if not fast_move:
# line gradient is not updated at mouse move event or when box
# is moved by animation. It makes win few time and so avoid some
# graphic jerks.
self.update_line_gradient()
def type(self) -> CanvasItemType:
return CanvasItemType.BEZIER_LINE
def update_theme(self):
theme = canvas.theme.line
if self._theme_state is ConnectionThemeState.DISCONNECTING:
theme = theme.disconnecting
else:
match self._port_type:
case PortType.AUDIO_JACK:
theme = theme.audio
case PortType.MIDI_JACK:
theme = theme.midi
case PortType.MIDI_ALSA:
theme = theme.alsa
case PortType.VIDEO:
theme = theme.video
if self._theme_state is ConnectionThemeState.SELECTED:
theme = theme.selected
tha = _ThemeAttributes()
tha.base_pen = theme.fill_pen
tha.color_main = theme.background_color
tha.color_alter = theme.background2_color
if tha.color_alter is None:
tha.color_alter = tha.color_main
tha.base_width = tha.base_pen.widthF()
self._th_attribs = tha
def update_line_gradient(self):
if (self._box_hidding_out is not BoxHidding.NONE
or self._box_hidding_in is not BoxHidding.NONE):
return
pos_top = self.boundingRect().top()
pos_bot = self.boundingRect().bottom()
tha = self._th_attribs
if tha is None:
return
has_gradient = bool(tha.color_main != tha.color_alter)
if has_gradient:
if tha.color_alter is None:
return
port_gradient = QLinearGradient(0, pos_top, 0, pos_bot)
if self._semi_hidden:
shd = options.semi_hide_opacity
bgcolor = canvas.theme.scene_background_color
color_main = QColor(
int(tha.color_main.red() * shd
+ bgcolor.red() * (1.0 - shd) + 0.5),
int(tha.color_main.green() * shd
+ bgcolor.green() * (1.0 - shd)+ 0.5),
int(tha.color_main.blue() * shd
+ bgcolor.blue() * (1.0 - shd) + 0.5),
tha.color_main.alpha())
color_alter = QColor(
int(tha.color_alter.red() * shd
+ bgcolor.red() * (1.0 - shd) + 0.5),
int(tha.color_alter.green() * shd
+ bgcolor.green() * (1.0 - shd)+ 0.5),
int(tha.color_alter.blue() * shd
+ bgcolor.blue() * (1.0 - shd) + 0.5),
tha.color_alter.alpha())
else:
color_main, color_alter = tha.color_main, tha.color_alter
port_gradient.setColorAt(0.0, color_main)
port_gradient.setColorAt(0.5, color_alter)
port_gradient.setColorAt(1.0, color_main)
self.setPen(
QPen(port_gradient, tha.base_width,
Qt.PenStyle.SolidLine, Qt.PenCapStyle.FlatCap))
else:
if self._semi_hidden:
shd = options.semi_hide_opacity
bgcolor = canvas.theme.scene_background_color
color_main = QColor(
int(tha.color_main.red() * shd
+ bgcolor.red() * (1.0 - shd) + 0.5),
int(tha.color_main.green() * shd
+ bgcolor.green() * (1.0 - shd)+ 0.5),
int(tha.color_main.blue() * shd
+ bgcolor.blue() * (1.0 - shd) + 0.5),
tha.color_main.alpha())
else:
color_main = tha.color_main
self.setPen(
QPen(QBrush(color_main), tha.base_width,
Qt.PenStyle.SolidLine, Qt.PenCapStyle.FlatCap))
def animate_hidding(self, ratio: float):
'''animate hidding or restoring of connections.
'ratio' goes from 0.0 (animation start) to 1.0 (animation end).'''
if (self._box_hidding_out is BoxHidding.NONE
and self._box_hidding_in is BoxHidding.NONE):
self.update_line_gradient()
return
if ratio >= 1.0:
# Animation finished
if (self._box_hidding_out is BoxHidding.HIDDING
or self._box_hidding_in is BoxHidding.HIDDING):
# if one of the 2 boxes is hidding,
# the lines widget must be invisible at end of animation.
# Lines widget will be removed very soon.
return
self._box_hidding_out = BoxHidding.NONE
self._box_hidding_in = BoxHidding.NONE
# the lines have now to be drawn normally
self.update_line_gradient()
return
if self._th_attribs is None:
return
epsy = 0.001
ratio = max(min(ratio, 1.0 - epsy * 2), epsy * 2)
gradient = QLinearGradient(self._group_out_x, self._group_out_mid_y,
self._group_in_x, self._group_in_mid_y)
transparent = QColor(0, 0, 0, 0)
color_main = self._th_attribs.color_main
# OUT | IN | TRANSPARENT STARTS ON | REVERSE
# ----------|-----------|-----------------------|--------
# NONE | NONE | not here |
# NONE | HIDDING | right | X
# NONE | RESTORING | right |
# HIDDING | NONE | left |
# HIDDING | HIDDING | middle |
# HIDDING | RESTORING | left (special) |
# RESTORING | NONE | left | X
# RESTORING | HIDDING | right (special) | X
# RESTORING | RESTORING | middle | X
if ((self._box_hidding_out is BoxHidding.NONE
and self._box_hidding_in is BoxHidding.HIDDING)
or self._box_hidding_out is BoxHidding.RESTORING):
ratio = 1.0 - ratio
if self._box_hidding_out is self._box_hidding_in:
# transparent starts in the middle
gradient.setColorAt(0.0, color_main)
gradient.setColorAt(0.5 - ratio * 0.5 - epsy, color_main)
gradient.setColorAt(0.5 - ratio * 0.5 + epsy, transparent)
gradient.setColorAt(0.5 + ratio * 0.5 - epsy, transparent)
gradient.setColorAt(0.5 + ratio * 0.5 + epsy, color_main)
gradient.setColorAt(1.0, color_main)
elif (self._box_hidding_out is not BoxHidding.NONE
and self._box_hidding_in is not BoxHidding.NONE):
# transparent starts on the left
# line is full at 0.5
if 0.5 - epsy < ratio < 0.5 + epsy:
gradient.setColorAt(0.0, color_main)
gradient.setColorAt(1.0, color_main)
elif ratio < 0.5:
gradient.setColorAt(0.0, color_main)
gradient.setColorAt(ratio * 2.0 - epsy, color_main)
gradient.setColorAt(ratio * 2.0 + epsy, transparent)
gradient.setColorAt(1.0, transparent)
else:
gradient.setColorAt(0.0, transparent)
gradient.setColorAt(((ratio - 0.5) * 2) - epsy, transparent)
gradient.setColorAt(((ratio - 0.5) * 2) + epsy, color_main)
gradient.setColorAt(1.0, color_main)
elif self._box_hidding_out is BoxHidding.NONE:
# transparent starts on the right
gradient.setColorAt(0.0, color_main)
gradient.setColorAt(ratio - epsy, color_main)
gradient.setColorAt(ratio + epsy, transparent)
gradient.setColorAt(1.0, transparent)
else:
# transparent starts on the left
gradient.setColorAt(0.0, transparent)
gradient.setColorAt(ratio - epsy, transparent)
gradient.setColorAt(ratio + epsy, color_main)
gradient.setColorAt(1.0, color_main)
self.setPen(QPen(gradient, self._th_attribs.base_width,
Qt.PenStyle.SolidLine, Qt.PenCapStyle.FlatCap))
def set_mode_hidding(self, port_mode: PortMode, box_hidding: BoxHidding):
if port_mode & PortMode.OUTPUT:
self._box_hidding_out = box_hidding
if port_mode & PortMode.INPUT:
self._box_hidding_in = box_hidding
def finish_animation(self):
'''Set attributes to ensure the next gradient will be correct
after animation.'''
# keep BoxHidding.HIDDING if it is the case
# because, in this case, the connection will be removed,
# we don't want to see it anymore.
if self._box_hidding_out is not BoxHidding.HIDDING:
self._box_hidding_out = BoxHidding.NONE
if self._box_hidding_in is not BoxHidding.HIDDING:
self._box_hidding_in = BoxHidding.NONE
|