spinetoolbox.link

Classes for drawing graphics items on QGraphicsScene.

authors

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

date

4.4.2018

Module Contents

Classes

LinkBase	Base class for Link and LinkDrawer.
_LinkIcon	An icon to show over a Link.
Link	A graphics item to represent the connection between two project items.
LinkDrawer	An item for drawing links between project items.

class spinetoolbox.link.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.

Parameters

toolbox (ToolboxUI) – main UI class instance

property magic_number(self)

property src_rect(self)

Returns the scene rectangle of the source connector.

property src_center(self)

Returns the center point of the source rectangle.

property dst_rect(self)

Returns the scene rectangle of the destination connector.

property dst_center(self)

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, curved_links=None)

Updates geometry.

do_update_geometry(self, guide_path)

Sets the path for this item.

Parameters

guide_path (QPainterPath) –

_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.link._LinkIcon(x, y, w, h, parent)

Bases: PySide2.QtWidgets.QGraphicsEllipseItem

An icon to show over a Link.

update_icon(self)

Sets the icon (filter, datapkg, or none), depending on Connection state.

class spinetoolbox.link.Link(toolbox, src_connector, dst_connector, connection)

Bases: LinkBase

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

• connection (spine_engine.project_item.Connection) – connection this link represents

refresh_resource_filter_model(self)

Makes resource filter mode fetch filter data from database.

set_connection_options(self, options)

property name(self)

property connection(self)

do_update_geometry(self, guide_path)

See base class.

make_execution_animation(self, excluded)

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

paint(self, painter, option, widget=None)

Sets a dashed pen if selected.

shape(self)

itemChange(self, change, value)

Brings selected link to top.

wipe_out(self)

Removes any trace of this item from the system.

class spinetoolbox.link.LinkDrawer(toolbox)

Bases: LinkBase

An item for drawing links between project items.

Parameters

toolbox (ToolboxUI) – main UI class instance

property src_rect(self)

Returns the scene rectangle of the source connector.

property dst_rect(self)

Returns the scene rectangle of the destination connector.

property dst_center(self)

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.