spinetoolbox.spine_db_editor.graphics_items

Classes for drawing graphics items on graph view’s QGraphicsScene.

Module Contents

Classes

EntityItem	param spine_db_editor 'owner'
ArcItem	Connects two EntityItems.
CrossHairsItem	Creates new relationships directly in the graph.
CrossHairsEntityItem	Represents the relationship that's being created using the CrossHairsItem.
CrossHairsArcItem	Connects a CrossHairsEntityItem with the CrossHairsItem,
EntityLabelItem	Provides a label for EntityItem.
BgItem
_ResizableQGraphicsSvgItem
_Resizer

class spinetoolbox.spine_db_editor.graphics_items.EntityItem(spine_db_editor, x, y, extent, db_map_ids, offset=None)

Bases: PySide6.QtWidgets.QGraphicsRectItem

Parameters

• spine_db_editor (SpineDBEditor) – ‘owner’

• x (float) – x-coordinate of central point

• y (float) – y-coordinate of central point

• extent (int) – Preferred extent

• db_map_ids (tuple) – tuple of (db_map, id) tuples

property has_dimensions

property db_map_ids

property original_db_map_ids

property name

property first_entity_class_id

property entity_class_name

property dimension_id_list

property dimension_name_list

property byname

property element_name_list

property element_byname_list

property first_db_map_id

property first_id

property first_db_map

property display_data

property display_database

property db_maps

clone()

element_id_list(db_map)

entity_class_id(db_map)

entity_class_ids(db_map)

entity_id(db_map)

db_map_data(db_map)

db_map_id(db_map)

db_items(db_map)

boundingRect()

set_pos(x, y)

move_by(dx, dy)

_snap(x, y)

has_unique_key()

Returns whether or not the item still has a single key in all the databases it represents.

Returns

bool

_get_name()

_get_prop(getter, index)

_get_color(index=None)

_get_arc_width(index=None)

_get_vertex_radius(index=None)

_has_name()

set_up()

update_props(index)

_update_bg()

refresh_icon()

Refreshes the icon.

_update_renderer(color, resize=True)

_install_renderer(resize=True)

_make_tool_tip()

default_parameter_data()

Return data to put as default in a parameter table when this item is selected.

shape()

Returns a shape containing the entire bounding rect, to work better with icon transparency.

set_highlight_color(color)

paint(painter, option, widget=None)

Shows or hides the selection halo.

_paint_as_selected()

_paint_as_deselected()

add_arc_item(arc_item)

Adds an item to the list of arcs.

Parameters

arc_item (ArcItem) –

update_entity_pos()

do_update_entity_pos()

apply_zoom(factor)

Applies zoom.

Parameters

factor (float) – The zoom factor.

apply_rotation(angle, center)

Applies rotation.

Parameters

• angle (float) – The angle in degrees.

• center (QPointF) – Rotates around this point.

mouseMoveEvent(event)

Moves the item and all connected arcs.

Parameters

event (QGraphicsSceneMouseEvent) –

update_arcs_line()

Moves arc items.

_update_arcs(color, arc_width)

_update_circle(color, vertex_radius)

itemChange(change, value)

Keeps track of item’s movements on the scene. Rotates svg item if the relationship is 2D. This makes it possible to define e.g. an arow icon for relationships that express direction.

Parameters

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

• value – a value related to the change

Returns

the same value given as input

setVisible(on)

Sets visibility status for this item and all arc items.

Parameters

on (bool) –

_make_menu()

contextMenuEvent(e)

Shows context menu.

Parameters

e (QGraphicsSceneMouseEvent) – Mouse event

remove_db_map_ids(db_map_ids)

Removes db_map_ids.

add_db_map_ids(db_map_ids)

_rotate_svg_item()

mouseDoubleClickEvent(e)

_duplicate()

_refresh_db_map_entity_class_lists()

_populate_expand_collapse_menu(menu)

Populates the ‘Expand’ or ‘Collapse’ menu.

Parameters

menu (QMenu) –

_populate_connect_entities_menu(menu)

Populates the ‘Add relationships’ menu.

Parameters

menu (QMenu) –

_get_db_map_entity_ids_to_expand_or_collapse(action)

_expand(action)

_collapse(action)

_start_connecting_entities(action)

class spinetoolbox.spine_db_editor.graphics_items.ArcItem(ent_item, el_item, width)

Bases: PySide6.QtWidgets.QGraphicsPathItem

Connects two EntityItems.

Parameters

• ent_item (spinetoolbox.widgets.graph_view_graphics_items.EntityItem) – entity item

• el_item (spinetoolbox.widgets.graph_view_graphics_items.EntityItem) – element item

• width (float) – Preferred line width

clone(entity_items)

_make_pen()

moveBy(dx, dy)

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

update_line()

update_color(color)

apply_value(factor, sign)

mousePressEvent(event)

Accepts the event so it’s not propagated.

other_item(item)

apply_zoom(factor)

Applies zoom.

Parameters

factor (float) – The zoom factor.

_update_width()

_move_gradient(factor, sign)

_do_move_gradient()

class spinetoolbox.spine_db_editor.graphics_items.CrossHairsItem(*args, **kwargs)

Bases: EntityItem

Creates new relationships directly in the graph.

Parameters

• spine_db_editor (SpineDBEditor) – ‘owner’

• x (float) – x-coordinate of central point

• y (float) – y-coordinate of central point

• extent (int) – Preferred extent

• db_map_ids (tuple) – tuple of (db_map, id) tuples

property entity_class_name

property name

property has_dimensions

_make_tool_tip()

_has_name()

refresh_icon()

Refreshes the icon.

set_plus_icon()

set_check_icon()

set_normal_icon()

set_ban_icon()

set_icon(unicode, color=0)

Refreshes the icon.

_snap(x, y)

mouseMoveEvent(event)

Moves the item and all connected arcs.

Parameters

event (QGraphicsSceneMouseEvent) –

contextMenuEvent(e)

Shows context menu.

Parameters

e (QGraphicsSceneMouseEvent) – Mouse event

class spinetoolbox.spine_db_editor.graphics_items.CrossHairsEntityItem(*args, **kwargs)

Bases: EntityItem

Represents the relationship that’s being created using the CrossHairsItem.

Parameters

• spine_db_editor (SpineDBEditor) – ‘owner’

• x (float) – x-coordinate of central point

• y (float) – y-coordinate of central point

• extent (int) – Preferred extent

• db_map_ids (tuple) – tuple of (db_map, id) tuples

property has_dimensions

_make_tool_tip()

_has_name()

refresh_icon()

Refreshes the icon.

contextMenuEvent(e)

Shows context menu.

Parameters

e (QGraphicsSceneMouseEvent) – Mouse event

class spinetoolbox.spine_db_editor.graphics_items.CrossHairsArcItem(ent_item, el_item, width)

Bases: ArcItem

Connects a CrossHairsEntityItem with the CrossHairsItem, and with all the EntityItem’s in the relationship so far.

Parameters

• ent_item (spinetoolbox.widgets.graph_view_graphics_items.EntityItem) – entity item

• el_item (spinetoolbox.widgets.graph_view_graphics_items.EntityItem) – element item

• width (float) – Preferred line width

_make_pen()

class spinetoolbox.spine_db_editor.graphics_items.EntityLabelItem(entity_item)

Bases: PySide6.QtWidgets.QGraphicsTextItem

Provides a label for EntityItem.

Initializes item.

Parameters

entity_item (spinetoolbox.widgets.graph_view_graphics_items.EntityItem) – The parent item.

entity_name_edited

boundingRect()

setPlainText(text)

Set texts and resets position.

Parameters

text (str) –

reset_position()

Adapts item geometry so text is always centered.

class spinetoolbox.spine_db_editor.graphics_items.BgItem(svg, parent=None)

Bases: PySide6.QtWidgets.QGraphicsRectItem

class Anchor

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

TL

TR

BL

BR

_getter_setter

_cursors

clone()

hoverEnterEvent(ev)

hoverLeaveEvent(ev)

apply_zoom(factor)

_place_resizers()

_resize(anchor, delta, strong)

_do_resize(rect, strong)

fit_rect(rect)

scene_rect()

class spinetoolbox.spine_db_editor.graphics_items._ResizableQGraphicsSvgItem(*args, **kwargs)

Bases: PySide6.QtSvgWidgets.QGraphicsSvgItem

resize(width, height)

setSharedRenderer(renderer)

boundingRect()

paint(painter, options, widget)

class spinetoolbox.spine_db_editor.graphics_items._Resizer(rect=QRectF(0, 0, 20, 20), parent=None)

Bases: PySide6.QtWidgets.QGraphicsRectItem

class SignalsProvider

Bases: PySide6.QtCore.QObject

resized

mousePressEvent(ev)

mouseMoveEvent(ev)

mouseReleaseEvent(ev)