spinetoolbox.widgets.graph_view_graphics_items

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

authors:

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

date:

4.4.2018

Module Contents

class spinetoolbox.widgets.graph_view_graphics_items.EntityItem(graph_view_form, x, y, extent, entity_id=None, entity_class_id=None)

Bases: PySide2.QtWidgets.QGraphicsPixmapItem

Initializes item

Parameters:

• graph_view_form (GraphViewForm) – ‘owner’
• x (float) – x-coordinate of central point
• y (float) – y-coordinate of central point
• extent (int) – Preferred extent
• entity_id (int, optional) – The entity id in case of a non-wip item
• entity_class_id (int, optional) – The entity class id in case of a wip item

entity_type

entity_name

entity_class_type

entity_class_id

entity_class_name

boundingRect(self)

_init_bg(self)

refresh_icon(self)

Refreshes the icon.

shape(self)

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

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

Shows or hides the selection halo.

_paint_as_selected(self)

_paint_as_deselected(self)

add_arc_item(self, arc_item)

Adds an item to the list of arcs.

Parameters:arc_item (ArcItem) –

become_wip(self)

Turns this item into a work-in-progress.

_make_wip_tool_tip(self)

become_whole(self)

Removes the wip status from this item.

adjust_to_zoom(self, transform)

Saves the view’s transform to determine collisions later on.

Parameters:transform (QTransform) – The view’s transformation matrix after the zoom.

device_rect(self)

Returns the item’s rect in devices’s coordinates. Used to accurately determine collisions.

_find_merge_target(self)

Returns a suitable merge target if any.

Returns:spinetoolbox.widgets.graph_view_graphics_items.EntityItem, NoneType

_is_target_valid(self)

Whether or not the registered merge target is valid.

Returns:bool

merge_into_target(self, force=False)

Merges this item into the registered target if valid.

Returns:True if merged, False if not. Return type:bool

mousePressEvent(self, event)

Saves original position for bouncing purposes.

Parameters:event (QGraphicsSceneMouseEvent) –

mouseMoveEvent(self, event)

Moves the item and all connected arcs. Also checks for a merge target and sets an appropriate mouse cursor.

Parameters:event (QGraphicsSceneMouseEvent) –

move_arc_items(self, pos_diff)

Moves arc items.

Parameters:pos_diff (QPoint) –

mouseReleaseEvent(self, event)

Merges the item into the registered target if any. Bounces it if not possible. Shrinks the scene if needed.

Parameters:event (QGraphicsSceneMouseEvent) –

_bounce_back(self, current_pos)

Bounces the item back from given position to its original position.

Parameters:current_pos (QPoint) –

itemChange(self, change, value)

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:

the same value given as input

set_all_visible(self, on)

Sets visibility status for this item and all arc items.

Parameters:on (bool) –

wipe_out(self)

Removes this item and all its arc items from the scene.

contextMenuEvent(self, e)

Shows context menu.

Parameters:e (QGraphicsSceneMouseEvent) – Mouse event

_show_item_context_menu_in_parent(self, pos)

class spinetoolbox.widgets.graph_view_graphics_items.RelationshipItem

Bases: spinetoolbox.widgets.graph_view_graphics_items.EntityItem

Relationship item to use with GraphViewForm.

entity_type

object_class_id_list

object_name_list

object_id_list

db_representation

_init_bg(self)

validate_member_objects(self)

Goes through connected object items and tries to complete the relationship.

move_arc_items(self, pos_diff)

Moves arc items.

Parameters:pos_diff (QPoint) –

_make_wip_tool_tip(self)

become_whole(self)

_show_item_context_menu_in_parent(self, pos)

class spinetoolbox.widgets.graph_view_graphics_items.ObjectItem(graph_view_form, x, y, extent, entity_id=None, entity_class_id=None)

Bases: spinetoolbox.widgets.graph_view_graphics_items.EntityItem

Initializes the item.

Parameters:

• graph_view_form (GraphViewForm) – ‘owner’
• x (float) – x-coordinate of central point
• y (float) – y-coordinate of central point
• extent (int) – preferred extent
• entity_id (int, optional) – object id, if not given the item becomes a template
• entity_class_id (int, optional) – object class id, for template items

Raises:

ValueError – in case object_id and object_class_id are both not provided

entity_type

db_representation

refresh_name(self)

Refreshes the name.

_paint_as_selected(self)

_make_wip_tool_tip(self)

become_whole(self)

refresh_description(self)

edit_name(self)

Starts editing the object name.

finish_name_editing(self, text)

Runs when the user finishes editing the name. Adds or updates the object in the database.

Parameters:text (str) – The new name.

move_arc_items(self, pos_diff)

Moves arc items.

Parameters:pos_diff (QPoint) –

keyPressEvent(self, event)

Starts editing the name if F2 is pressed.

Parameters:event (QKeyEvent) –

mouseDoubleClickEvent(self, event)

Starts editing the name.

Parameters:event (QGraphicsSceneMouseEvent) –

_is_in_wip_relationship(self)

_is_target_valid(self)

Whether or not the registered merge target is valid.

Returns:bool

merge_into_target(self, force=False)

Merges this item into the registered target if valid.

Parameters:force (bool) – Returns:True if merged, False if not. Return type:bool

_show_item_context_menu_in_parent(self, pos)

class spinetoolbox.widgets.graph_view_graphics_items.EntityLabelItem(entity_item)

Bases: PySide2.QtWidgets.QGraphicsTextItem

Label item for items in GraphViewForm.

Initializes item.

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

entity_name_edited

setPlainText(self, text)

Set texts and resets position.

Parameters:text (str) –

reset_position(self)

Adapts item geometry so text is always centered.

set_bg_color(self, bg_color)

Sets background color.

Parameters:bg_color (QColor) –

start_editing(self)

Starts editing.

keyPressEvent(self, event)

Keeps text centered as the user types. Gives up focus when the user presses Enter or Return.

Parameters:event (QKeyEvent) –

focusOutEvent(self, event)

Ends editing and sends entity_name_edited signal.

mouseDoubleClickEvent(self, event)

Starts editing the name.

Parameters:event (QGraphicsSceneMouseEvent) –

class spinetoolbox.widgets.graph_view_graphics_items.ArcItem(rel_item, obj_item, width, is_wip=False)

Bases: PySide2.QtWidgets.QGraphicsLineItem

Arc item to use with GraphViewForm. Connects a RelationshipItem to an ObjectItem.

Initializes item.

Parameters:

• rel_item (spinetoolbox.widgets.graph_view_graphics_items.RelationshipItem) – relationship item
• obj_item (spinetoolbox.widgets.graph_view_graphics_items.ObjectItem) – object item
• width (float) – Preferred line width

mousePressEvent(self, event)

Accepts the event so it’s not propagated.

other_item(self, item)

become_wip(self)

Turns this arc into a work-in-progress.

become_whole(self)

Removes the wip status from this arc.

move_rel_item_by(self, pos_diff)

Moves source point.

Parameters:pos_diff (QPoint) –

move_obj_item_by(self, pos_diff)

Moves destination point.

Parameters:pos_diff (QPoint) –

adjust_to_zoom(self, transform)

Adjusts the item’s geometry so it stays the same size after performing a zoom.

Parameters:transform (QTransform) – The view’s transformation matrix after the zoom.

wipe_out(self)

class spinetoolbox.widgets.graph_view_graphics_items.OutlinedTextItem(text, parent, font=QFont(), brush=QBrush(Qt.white), outline_pen=QPen(Qt.black, 3, Qt.SolidLine))

Bases: PySide2.QtWidgets.QGraphicsSimpleTextItem

Outlined text item.

Initializes item.

Parameters:

• text (str) – text to show
• font (QFont, optional) – font to display the text
• brush (QBrush, optional) –
• outline_pen (QPen, optional) –