DdtGraphicalOverlay Class Reference

#include <ddtGraphicalOverlay.hpp>

Public Member Functions
	DdtGraphicalOverlay ()
virtual	~DdtGraphicalOverlay ()
void	AddGraphicalElement (DdtGraphicalElement *element)
void	RemoveGraphicalElement (DdtGraphicalElement *element)
QList< DdtGraphicalElement * > *	GetListOfGraphicalElements ()
QList< DdtGraphicalElement * >	GetElementByTag (QString tag)
void	ShowAllElements ()
void	HideAllElements ()
void	ShowElementsOfType (DdtOverlayType type)
void	HideElementsOfType (DdtOverlayType type)
void	ShowElementsOfTag (QString tag)
void	HideElementsOfTag (QString tag)
void	RemoveElementsOfType (DdtOverlayType type)

Protected Member Functions
void	SetShowHideFlags (DdtOverlayType type, bool show, QString tag="")

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 *

element

)

Adds a graphical element to the overlay

Parameters

element

Pointer to the element object

GetElementByTag()

QList< DdtGraphicalElement * > DdtGraphicalOverlay::GetElementByTag

(

QString

tag

)

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

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

(

)

Removes the show flag for all elements in the overlay

HideElementsOfTag()

void DdtGraphicalOverlay::HideElementsOfTag

(

QString

tag

)

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

Parameters

tag	Overlay element tag

HideElementsOfType()

void DdtGraphicalOverlay::HideElementsOfType

(

DdtOverlayType

type

)

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

Parameters

type	Overlay element type

RemoveElementsOfType()

void DdtGraphicalOverlay::RemoveElementsOfType

(

DdtOverlayType

type

)

Remove all elements of given type

Parameters

type	Overlay element type

RemoveGraphicalElement()

void DdtGraphicalOverlay::RemoveGraphicalElement

(

DdtGraphicalElement *

element

)

Removes a graphical elemet from the overlay

Parameters

element

Pointer to the element object

SetShowHideFlags()

void DdtGraphicalOverlay::SetShowHideFlags ( DdtOverlayType  type, bool  show, QString  tag = ""  )

protected

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

Parameters

type	Type of overlay element
show	Show or hide flag
tag	Tag of elements to show or hide

ShowAllElements()

void DdtGraphicalOverlay::ShowAllElements

(

)

Sets the show flag for all elements in the overlay

ShowElementsOfTag()

void DdtGraphicalOverlay::ShowElementsOfTag

(

QString

tag

)

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

Parameters

tag	Overlay element tag

ShowElementsOfType()

void DdtGraphicalOverlay::ShowElementsOfType

(

DdtOverlayType

type

)

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

Parameters

type	Overlay element type

---

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

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