#include <ddtGraphicalOverlay.hpp>

	DdtGraphicalOverlay ()

virtual	~DdtGraphicalOverlay ()

void	AddGraphicalElement (DdtGraphicalElement *const element)

void	RemoveGraphicalElement (DdtGraphicalElement *const element)

QList< DdtGraphicalElement * > *	GetListOfGraphicalElements ()

QList< DdtGraphicalElement * >	GetElementByTag (const QString tag) const

QStringList	GetListOfElementIDs () const

void	ShowAllElements () const

void	HideAllElements () const

void	ShowElementsOfType (const DdtOverlayType type, const bool show_ids=false, const QString id_list="") const

void	HideElementsOfType (const DdtOverlayType type) const

void	ShowElementsOfTag (const QString tag) const

void	HideElementsOfTag (const QString tag) const

void	RemoveElementsOfType (const DdtOverlayType type)

void	SetShowHideFlags (DdtOverlayType ovltype, const bool show, const QString tag="", const bool show_ids=false, const QString id_list="") const

Detailed Description

Class for the graphical overlays

Constructor & Destructor Documentation

◆ DdtGraphicalOverlay()

DdtGraphicalOverlay::DdtGraphicalOverlay ( )

explicitdefault

Constructor

◆ ~DdtGraphicalOverlay()

DdtGraphicalOverlay::~DdtGraphicalOverlay ( )

virtualdefault

Destructor

Member Function Documentation

◆ AddGraphicalElement()

void DdtGraphicalOverlay::AddGraphicalElement ( DdtGraphicalElement *const element )

Adds a graphical element to the overlay

Parameters

element Pointer to the element object

◆ GetElementByTag()

QList< DdtGraphicalElement * > DdtGraphicalOverlay::GetElementByTag ( const QString tag ) const

Return a list of graphical elements with a given tag that are contained in the overlay

Returns: A list of graphical elements using this tag. The elements in the list are pointers that can be invalid, if an overlay element get removed

◆ GetListOfElementIDs()

QStringList DdtGraphicalOverlay::GetListOfElementIDs ( ) const

Return a list of IDs (tool tips) that have been set for the graphical elements that are contained in the overlay

Returns: A list of IDs (tool tips) for graphical elements.

◆ GetListOfGraphicalElements()

QList< DdtGraphicalElement * > * DdtGraphicalOverlay::GetListOfGraphicalElements ( )

Return a list of graphical elements that are contained in the overlay

Returns: A list of graphical elements

◆ HideAllElements()

void DdtGraphicalOverlay::HideAllElements ( ) const

Removes the show flag for all elements in the overlay

◆ HideElementsOfTag()

void DdtGraphicalOverlay::HideElementsOfTag ( const QString tag ) const

Removes the show flag for all elements of a given tag in the overlay

Parameters

tag	Overlay element tag

◆ HideElementsOfType()

void DdtGraphicalOverlay::HideElementsOfType ( const DdtOverlayType type ) const

Removes the show flag for all elements of a given type in the overlay

Parameters

type	Overlay element type

◆ RemoveElementsOfType()

void DdtGraphicalOverlay::RemoveElementsOfType ( const DdtOverlayType type )

Remove all elements of given type

Parameters

type	Overlay element type

◆ RemoveGraphicalElement()

void DdtGraphicalOverlay::RemoveGraphicalElement ( DdtGraphicalElement *const element )

Removes a graphical elemet from the overlay

Parameters

element Pointer to the element object

◆ SetShowHideFlags()

void DdtGraphicalOverlay::SetShowHideFlags	(	DdtOverlayType	ovltype,
		const bool	show,
		const QString	tag = "",
		const bool	show_ids = false,
		const QString	id_list = "" ) const

protected

Set show / hide flags for different elements selected by type, tag etc. Optional argument tag can be used to filer by tag

Parameters

ovltype	Type of overlay element
show	Show or hide flag
tag	Tag of elements to show or hide
showIds	Flag to show or hide IDs
id_list	List of IDs

◆ ShowAllElements()

void DdtGraphicalOverlay::ShowAllElements ( ) const

Sets the show flag for all elements in the overlay

◆ ShowElementsOfTag()

void DdtGraphicalOverlay::ShowElementsOfTag ( const QString tag ) const

Sets the show flag for all elements of a given tag in the overlay

Parameters

tag	Overlay element tag

◆ ShowElementsOfType()

void DdtGraphicalOverlay::ShowElementsOfType	(	const DdtOverlayType	type,
		const bool	show_ids = false,
		const QString	id_list = "" ) const

Sets the show flag for all elements of a given type in the overlay

Parameters

type	Overlay element type
showIds	Specifies to show IDs or not
id_list	List of IDs

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

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