spinetoolbox.graphics_items

Classes for drawing graphics items on QGraphicsScene.

authors:

13. Marin (KTH), P. Savolainen (VTT)

date:

4.4.2018

Module Contents

Classes

ProjectItemIcon	Base class for project item icons drawn in Design View.
ConnectorButton	Connector button graphics item. Used for Link drawing between project items.
ExclamationIcon	Exclamation icon graphics item.
RankIcon	Rank icon graphics item.
LinkBase	Base class for Link and LinkDrawer.
Link	Base class for Link and LinkDrawer.
LinkDrawer	An item for drawing links between project items.

class spinetoolbox.graphics_items.ProjectItemIcon(toolbox, x, y, project_item, icon_file, icon_color, background_color)

Bases: PySide2.QtWidgets.QGraphicsRectItem

Base class for project item icons drawn in Design View.

Parameters:

• toolbox (ToolBoxUI) – QMainWindow instance
• x (float) – Icon x coordinate
• y (float) – Icon y coordinate
• project_item (ProjectItem) – Item
• icon_file (str) – Path to icon resource
• icon_color (QColor) – Icon’s color
• background_color (QColor) – Background color

ITEM_EXTENT = 64

activate(self)

Adds items to scene and setup graphics effect. Called in the constructor and when re-adding the item to the project in the context of undo/redo.

_setup(self, brush, svg, svg_color)

Setup item’s attributes.

Parameters:

• brush (QBrush) – Used in filling the background rectangle
• svg (str) – Path to SVG icon file
• svg_color (QColor) – Color of SVG icon

name(self)

Returns name of the item that is represented by this icon.

update_name_item(self, new_name)

Set a new text to name item. Used when a project item is renamed.

set_name_attributes(self)

Set name QGraphicsSimpleTextItem attributes (font, size, position, etc.)

conn_button(self, position='left')

Returns items connector button (QWidget).

outgoing_links(self)

incoming_links(self)

hoverEnterEvent(self, event)

Sets a drop shadow effect to icon when mouse enters its boundaries.

Parameters:event (QGraphicsSceneMouseEvent) – Event

hoverLeaveEvent(self, event)

Disables the drop shadow when mouse leaves icon boundaries.

Parameters:event (QGraphicsSceneMouseEvent) – Event

mousePressEvent(self, event)

mouseMoveEvent(self, event)

Moves icon(s) while the mouse button is pressed. Update links that are connected to selected icons.

Parameters:event (QGraphicsSceneMouseEvent) – Event

moveBy(self, dx, dy)

update_links_geometry(self)

Updates geometry of connected links to reflect this item’s most recent position.

mouseReleaseEvent(self, event)

notify_item_move(self)

contextMenuEvent(self, event)

Show item context menu.

Parameters:event (QGraphicsSceneMouseEvent) – Mouse event

keyPressEvent(self, event)

Handles deleting and rotating the selected item when dedicated keys are pressed.

Parameters:event (QKeyEvent) – Key event

itemChange(self, change, value)

Reacts to item removal and position changes.

In particular, destroys the drop shadow effect when the items is removed from a scene and keeps track of item’s movements on the scene.

Parameters:

• change (GraphicsItemChange) – a flag signalling the type of the change
• value – a value related to the change

Returns:

Whatever super() does with the value parameter

show_item_info(self)

Update GUI to show the details of the selected item.

class spinetoolbox.graphics_items.ConnectorButton(parent, toolbox, position='left')

Bases: PySide2.QtWidgets.QGraphicsRectItem

Connector button graphics item. Used for Link drawing between project items.

Parameters:

• parent (QGraphicsItem) – Project item bg rectangle
• toolbox (ToolBoxUI) – QMainWindow instance
• position (str) – Either “top”, “left”, “bottom”, or “right”

brush

hover_brush

outgoing_links(self)

incoming_links(self)

parent_name(self)

Returns project item name owning this connector button.

mousePressEvent(self, event)

Connector button mouse press event. Either starts or closes a link.

Parameters:event (QGraphicsSceneMouseEvent) – Event

set_friend_connectors_enabled(self, enabled)

Enables or disables all connectors in the parent. This is called by LinkDrawer to disable invalid connectors while drawing and reenabling them back when done.

mouseDoubleClickEvent(self, event)

Connector button mouse double click event. Makes sure the LinkDrawer is hidden.

Parameters:event (QGraphicsSceneMouseEvent) – Event

hoverEnterEvent(self, event)

Sets a darker shade to connector button when mouse enters its boundaries.

Parameters:event (QGraphicsSceneMouseEvent) – Event

hoverLeaveEvent(self, event)

Restore original brush when mouse leaves connector button boundaries.

Parameters:event (QGraphicsSceneMouseEvent) – Event

class spinetoolbox.graphics_items.ExclamationIcon(parent)

Bases: PySide2.QtSvg.QGraphicsSvgItem

Exclamation icon graphics item. Used to notify that a ProjectItem is missing some configuration.

Parameters:parent (ProjectItemIcon) – the parent item

clear_notifications(self)

Clear all notifications.

add_notification(self, text)

Add a notification.

hoverEnterEvent(self, event)

Shows notifications as tool tip.

Parameters:event (QGraphicsSceneMouseEvent) – Event

hoverLeaveEvent(self, event)

Hides tool tip.

Parameters:event (QGraphicsSceneMouseEvent) – Event

class spinetoolbox.graphics_items.RankIcon(parent)

Bases: PySide2.QtWidgets.QGraphicsTextItem

Rank icon graphics item. Used to show the rank of a ProjectItem within its DAG

Parameters:parent (ProjectItemIcon) – the parent item

set_rank(self, rank)

class spinetoolbox.graphics_items.LinkBase(toolbox)

Bases: PySide2.QtWidgets.QGraphicsPathItem

Base class for Link and LinkDrawer.

Mainly provides the update_geometry method for ‘drawing’ the link on the scene.

Initializes the instance.

Parameters:toolbox (ToolboxUI) – main UI class instance

magic_number

src_rect

Returns the scene rectangle of the source connector.

src_center

Returns the center point of the source rectangle.

dst_rect

Returns the scene rectangle of the destination connector.

dst_center

Returns the center point of the destination rectangle.

moveBy(self, _dx, _dy)

Does nothing. This item is not moved the regular way, but follows the ConnectorButtons it connects.

update_geometry(self)

Updates geometry.

do_update_geometry(self, curved_links)

Sets the path for this item.

Parameters:curved_links (bool) – Whether the path should follow a curvy line or a straight line

_make_ellipse_path(self)

Returns an ellipse path for the link’s base.

Returns:QPainterPath

_get_src_offset(self)

_get_dst_offset(self, c1)

_make_guide_path(self, curved_links)

Returns a ‘narrow’ path connecting this item’s source and destination.

Parameters:curved_links (bool) – Whether the path should follow a curved line or just a straight line Returns:QPainterPath

_points_and_angles_from_path(self, path)

Returns a list of representative points and angles from given path.

Parameters:path (QPainterPath) – Returns:points list(float): angles Return type:list(QPointF)

_make_connecting_path(self, guide_path)

Returns a ‘thick’ path connecting source and destination, by following the given ‘guide’ path.

Parameters:guide_path (QPainterPath) – Returns:QPainterPath

static _follow_points(curve_path, points)

_radius_from_point_and_angle(self, point, angle)

_make_arrow_path(self, guide_path)

Returns an arrow path for the link’s tip.

Parameters:guide_path (QPainterPath) – A narrow path connecting source and destination, used to determine the arrow orientation. Returns:QPainterPath

_get_joint_line(self, guide_path)

_get_joint_angle(self, guide_path)

class spinetoolbox.graphics_items.Link(toolbox, src_connector, dst_connector)

Bases: spinetoolbox.graphics_items.LinkBase

Base class for Link and LinkDrawer.

Mainly provides the update_geometry method for ‘drawing’ the link on the scene.

A graphics item to represent the connection between two project items.

Parameters:

• toolbox (ToolboxUI) – main UI class instance
• src_connector (ConnectorButton) – Source connector button
• dst_connector (ConnectorButton) – Destination connector button

make_execution_animation(self)

Returns an animation to play when execution ‘passes’ through this link.

Returns:QVariantAnimation

_handle_execution_animation_value_changed(self, step)

has_parallel_link(self)

Returns whether or not this link entirely overlaps another.

send_to_bottom(self)

Stacks this link before the parallel one if any.

mousePressEvent(self, e)

Ignores event if there’s a connector button underneath, to allow creation of new links.

Parameters:e (QGraphicsSceneMouseEvent) – Mouse event

contextMenuEvent(self, e)

Selects the link and shows context menu.

Parameters:e (QGraphicsSceneMouseEvent) – Mouse event

keyPressEvent(self, event)

Removes this link if delete is pressed.

paint(self, painter, option, widget)

Sets a dashed pen if selected.

itemChange(self, change, value)

Brings selected link to top.

wipe_out(self)

Removes any trace of this item from the system.

class spinetoolbox.graphics_items.LinkDrawer(toolbox)

Bases: spinetoolbox.graphics_items.LinkBase

An item for drawing links between project items.

Init class.

Parameters:toolbox (ToolboxUI) – main UI class instance

src_rect

Returns the scene rectangle of the source connector.

dst_rect

Returns the scene rectangle of the destination connector.

dst_center

Returns the center point of the destination rectangle.

add_link(self)

Makes link between source and destination connectors.

wake_up(self, src_connector)

Sets the source connector, shows this item and adds it to the scene. After calling this, the scene is in link drawing mode.

Parameters:src_connector (ConnectorButton) –

sleep(self)

Removes this drawer from the scene, clears its source and destination connectors, and hides it. After calling this, the scene is no longer in link drawing mode.