spinetoolbox.link

Classes for drawing graphics items on QGraphicsScene.

Module Contents

Classes

LinkBase	Base class for Link and LinkDrawer.
_IconBase	Base class for icons to show over a Link.
_SvgIcon	An SVG icon to show over a Link.
_TextIcon	A font awesome icon to show over a Link.
_WarningTextIcon	A font awesome icon to show over a Link.
JumpOrLink	Base class for Jump and Link.
Link	A graphics item to represent the connection between two project items.
JumpLink	A graphics icon to represent a jump connection between items.
LinkDrawerBase	A base class for items intended for drawing links between project items.
ConnectionLinkDrawer	An item for drawing connection links between project items.
JumpLinkDrawer	An item for drawing jump connections between project items.

Functions

_regular_polygon_points(n, side[, initial_angle])

Attributes

LINK_COLOR
JUMP_COLOR

spinetoolbox.link.LINK_COLOR

spinetoolbox.link.JUMP_COLOR

class spinetoolbox.link.LinkBase(toolbox, src_connector, dst_connector)

Bases: PySide6.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

• src_connector (ConnectorButton, optional) – Source connector button

• dst_connector (ConnectorButton) – Destination connector button

property outline_color

property magic_number

property src_rect

Returns the scene rectangle of the source connector.

property src_center

Returns the center point of the source rectangle.

property dst_rect

Returns the scene rectangle of the destination connector.

property dst_center

Returns the center point of the destination rectangle.

_COLOR

shape()

moveBy(_dx, _dy)

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

update_geometry(curved_links=None)

Updates geometry.

guide_path()

For tests.

_do_update_geometry()

Sets the path for this item.

_add_ellipse_path(path)

Adds an ellipse for the link’s base.

Parameters

QPainterPath –

_get_joint_angle()

_add_arrow_path(path)

Returns an arrow path for the link’s tip.

Parameters

QPainterPath –

static _get_offset(button)

_get_src_offset()

_get_dst_offset()

_find_new_point(points, target)

Finds a new point that approximates points to target in a smooth trajectory. Returns the new point, or None if no need for approximation.

Parameters

• points (list(QPointF)) –

• target (QPointF) –

Returns

QPointF or None

_close_enough(p1, p2)

_make_guide_path(curved_links=False)

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

itemChange(change, value)

Wipes out the link when removed from scene.

wipe_out()

Removes any trace of this item from the system.

class spinetoolbox.link._IconBase(x, y, w, h, parent, tooltip=None, active=True)

Bases: PySide6.QtWidgets.QGraphicsEllipseItem

Base class for icons to show over a Link.

hoverEnterEvent(event)

hoverLeaveEvent(event)

class spinetoolbox.link._SvgIcon(parent, extent, path, tooltip=None, active=False)

Bases: _IconBase

An SVG icon to show over a Link.

wipe_out()

Cleans up icon’s resources.

class spinetoolbox.link._TextIcon(parent, extent, char, tooltip=None, active=False)

Bases: _IconBase

A font awesome icon to show over a Link.

wipe_out()

Cleans up icon’s resources.

class spinetoolbox.link._WarningTextIcon(parent, extent, char, tooltip)

Bases: _TextIcon

A font awesome icon to show over a Link.

class spinetoolbox.link.JumpOrLink(toolbox, src_connector, dst_connector)

Bases: LinkBase

Base class for Jump and Link.

Parameters

• toolbox (ToolboxUI) – main UI class instance

• src_connector (ConnectorButton, optional) – Source connector button

• dst_connector (ConnectorButton) – Destination connector button

abstract property item

_do_update_geometry()

See base class.

_place_icons()

mousePressEvent(e)

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

Parameters

e (QGraphicsSceneMouseEvent) – Mouse event

contextMenuEvent(e)

Selects the link and shows context menu.

Parameters

e (QGraphicsSceneMouseEvent) – Mouse event

paint(painter, option, widget=None)

Sets a dashed pen if selected.

shape()

wipe_out()

Removes any trace of this item from the system.

_make_execution_animation()

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

Returns

QVariantAnimation

run_execution_animation()

Runs execution animation.

_handle_execution_animation_value_changed(step)

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

Bases: JumpOrLink

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 (LoggingConnection) – connection this link represents

property name

property connection

property item

_COLOR

_MEMORY = '\uf538'

_FILTERS = '\uf0b0'

_PURGE = '\uf0e7'

_WARNING = '\uf06a'

_DATAPACKAGE = ':/icons/datapkg.svg'

update_icons()

itemChange(change, value)

Brings selected link to top.

class spinetoolbox.link.JumpLink(toolbox, src_connector, dst_connector, jump)

Bases: JumpOrLink

A graphics icon to represent a jump connection between items.

Parameters

• toolbox (ToolboxUI) – main UI class instance

• src_connector (ConnectorButton) – Source connector button

• dst_connector (ConnectorButton) – Destination connector button

• jump (spine_engine.project_item.connection.Jump) – connection this link represents

property jump

property item

property name

_COLOR

_ISSUE = '\uf071'

issues()

Checks if jump is well-defined.

Returns

issues regarding the jump

Return type

list of str

update_icons()

class spinetoolbox.link.LinkDrawerBase(toolbox)

Bases: LinkBase

A base class for items intended for drawing links between project items.

Parameters

toolbox (ToolboxUI) – main UI class instance

property src_rect

Returns the scene rectangle of the source connector.

property dst_rect

Returns the scene rectangle of the destination connector.

property dst_center

Returns the center point of the destination rectangle.

_get_dst_offset()

abstract add_link()

Makes link between source and destination connectors.

wake_up(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) – source connector

sleep()

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.

class spinetoolbox.link.ConnectionLinkDrawer(toolbox)

Bases: LinkDrawerBase

An item for drawing connection links between project items.

Parameters

toolbox (ToolboxUI) – main UI class instance

_COLOR

add_link()

Makes link between source and destination connectors.

wake_up(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) – source connector

sleep()

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.

class spinetoolbox.link.JumpLinkDrawer(toolbox)

Bases: LinkDrawerBase

An item for drawing jump connections between project items.

Parameters

toolbox (ToolboxUI) – main UI class instance

_COLOR

add_link()

Makes link between source and destination connectors.

spinetoolbox.link._regular_polygon_points(n, side, initial_angle=0)