#include <ddtOverlayRendering.hpp>

Protected Attributes
DdtGraphicalOverlay *	graphics_overlay

DdtFileBasedOverlay *	file_based_overlay

QList< DdtGraphicalElement * >	selected_elements

float	current_scale

	DdtOverlayRendering ()

virtual	~DdtOverlayRendering ()

virtual void	RedrawOverlay (QGraphicsScene *scene, const QString timestamp="")

void	AddGraphicalElement (const DdtGraphicalElementProperties &element_properties, const double x1, const double y1, const double x2, const double y2, const QString draw_mode, const QString text="")

void	RemoveGraphicalElements (const QString selection)

bool	SelectGraphicalElements (const double x1, const double y1, const QGraphicsView *const view)

void	UnselectGraphicalElements ()

void	SetCurrentScale (const float scale)

void	ChangeElementOverlayProperties (const DdtGraphicalElementProperties &properties)

const DdtGraphicalElementProperties &	GetLastSelectedElementProperties ()

DdtGraphicalOverlay *	GetGraphicalOverlay ()

QStringList	GetListOfElementIDs () const

void	SetEditable (const bool editable)

bool	LoadOverlayFile (const QString overlay_file, const std::string image_widget_name, QString &error_msg)

void	HideStaticOverlay () const

void	ShowStaticOverlay () const

void	ShowOverlayByObject (const QString object_name) const

void	HideOverlayByObject (const QString object_name) const

void	ShowOverlayByElement (const QString element_name) const

void	HideOverlayByElement (const QString element_name) const

void	SetTransformation (QTransform const &transform)

Detailed Description

Class for the rendering of graphical overlays

Constructor & Destructor Documentation

◆ DdtOverlayRendering()

DdtOverlayRendering::DdtOverlayRendering ( )

explicit

Constructor

◆ ~DdtOverlayRendering()

DdtOverlayRendering::~DdtOverlayRendering ( )

virtual

Destructor

Member Function Documentation

◆ AddGraphicalElement()

void DdtOverlayRendering::AddGraphicalElement	(	const DdtGraphicalElementProperties &	element_properties,
		const double	x1,
		const double	y1,
		const double	x2,
		const double	y2,
		const QString	draw_mode,
		const QString	text = "" )

Add a graphical element to the overlay.

Parameters

element_properties	the graphical element properties
x1	mouse x coordinate of first position
y1	mouse y coordinate of first position
x2	mouse x coordinate of second position
y2	mouse y coordinate of second position
draw_mode	string identifying the graphical element
text	text of the graphical element text

◆ ChangeElementOverlayProperties()

void DdtOverlayRendering::ChangeElementOverlayProperties ( const DdtGraphicalElementProperties & properties )

Change overlay properties on respective selected elements

Parameters

properties Graphical Element properties

◆ GetGraphicalOverlay()

DdtGraphicalOverlay * DdtOverlayRendering::GetGraphicalOverlay ( )

Access to the graphical overlay

Returns: Pointer to used graphical overlay

◆ GetLastSelectedElementProperties()

const DdtGraphicalElementProperties & DdtOverlayRendering::GetLastSelectedElementProperties ( )

Get a map with all the last element properties with respective DialogIDs

Returns: properties Last Selected Graphical Element properties

◆ GetListOfElementIDs()

QStringList DdtOverlayRendering::GetListOfElementIDs ( ) const

Get a list of element IDs.

Returns: A QStringList containing all element IDs.

◆ HideOverlayByElement()

void DdtOverlayRendering::HideOverlayByElement ( const QString element_name ) const

Hides an element of the overlay specified by its name

Parameters

element_name Element name to hide

◆ HideOverlayByObject()

void DdtOverlayRendering::HideOverlayByObject ( const QString object_name ) const

Hides a specified object of the overlay

Parameters

object_name Name of the overlay object to hide

◆ HideStaticOverlay()

void DdtOverlayRendering::HideStaticOverlay ( ) const

Hide the static overlay elements

◆ LoadOverlayFile()

bool DdtOverlayRendering::LoadOverlayFile	(	const QString	overlay_file,
		const std::string	image_widget_name,
		QString &	error_msg )

Loads the json overlay file which contains graphics to be drawn at startup

Parameters

overlay_file	The overlay file to load
image_widget_name	The name of the image widget
error_msg	The error message

Returns: true if loading was successful, false otherwise

◆ RedrawOverlay()

void DdtOverlayRendering::RedrawOverlay	(	QGraphicsScene *	scene,
		const QString	timestamp = "" )

virtual

Function that draw all overlay elements into the scene of the view

◆ RemoveGraphicalElements()

void DdtOverlayRendering::RemoveGraphicalElements ( const QString selection )

Removes overlays of given type (selection)

Parameters

selection The type of overlay to delete

◆ SelectGraphicalElements()

bool DdtOverlayRendering::SelectGraphicalElements	(	const double	x1,
		const double	y1,
		const QGraphicsView *const	view )

Selects a graphical element at the current coordinates

Parameters

x1	First x coordinate
y1	First y coordinate
view	Active graphics view

Returns: result Indicate if any graphical element was selected

Check if a text item is placed at the selected position. As text items are handled differently (in order to have the text always readable (without rotation)), the bounding rectangle is not identical to the drawn text rectangle in case of rotation or zooming

◆ SetCurrentScale()

void DdtOverlayRendering::SetCurrentScale ( const float scale )

Set the current scale factor of the view

Parameters

scale The current scale

◆ SetEditable()

void DdtOverlayRendering::SetEditable ( const bool editable )

Loops through all graphical elements and enables / disables resizing and moving.

◆ SetTransformation()

void DdtOverlayRendering::SetTransformation ( QTransform const & transform )

Makes the views current transformation available to text elements

Parameters

transform The view's current transformation

◆ ShowOverlayByElement()

void DdtOverlayRendering::ShowOverlayByElement ( const QString element_name ) const

Shows an element of the overlay specified by its name

Parameters

element_name Element name to show

◆ ShowOverlayByObject()

void DdtOverlayRendering::ShowOverlayByObject ( const QString object_name ) const

Shows a specified object of the overlay

Parameters

object_name Name of the overlay object to show

◆ ShowStaticOverlay()

void DdtOverlayRendering::ShowStaticOverlay ( ) const

Show the static overlay elements

◆ UnselectGraphicalElements()

void DdtOverlayRendering::UnselectGraphicalElements ( )

Unselects all items. The select item button can be toggled in order to leave the selecting mode. If so, UnselectGraphicalElements() is called to unselect a selected item.

Member Data Documentation

◆ current_scale

float DdtOverlayRendering::current_scale

protected

The current scale factor.

◆ file_based_overlay

DdtFileBasedOverlay* DdtOverlayRendering::file_based_overlay

protected

The DDT graphical overlay object.

◆ graphics_overlay

DdtGraphicalOverlay* DdtOverlayRendering::graphics_overlay

protected

The DDT graphical overlay object.

◆ selected_elements

QList<DdtGraphicalElement*> DdtOverlayRendering::selected_elements

protected

A QList containing all selected elements.

The documentation for this class was generated from the following files:

datavisualisation/graphics/src/include/ddt/ddtOverlayRendering.hpp
datavisualisation/graphics/src/ddtOverlayRendering.cpp

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DdtOverlayRendering()

◆ ~DdtOverlayRendering()

Member Function Documentation

◆ AddGraphicalElement()

◆ ChangeElementOverlayProperties()

◆ GetGraphicalOverlay()

◆ GetLastSelectedElementProperties()

◆ GetListOfElementIDs()

◆ HideOverlayByElement()

◆ HideOverlayByObject()

◆ HideStaticOverlay()

◆ LoadOverlayFile()

◆ RedrawOverlay()

◆ RemoveGraphicalElements()

◆ SelectGraphicalElements()

◆ SetCurrentScale()

◆ SetEditable()

◆ SetTransformation()

◆ ShowOverlayByElement()

◆ ShowOverlayByObject()

◆ ShowStaticOverlay()

◆ UnselectGraphicalElements()

Member Data Documentation

◆ current_scale

◆ file_based_overlay

◆ graphics_overlay

◆ selected_elements