#include <ddtFileBasedOverlay.hpp>

	DdtFileBasedOverlay ()

virtual	~DdtFileBasedOverlay ()

void	AddGraphicalElement (DdtGraphicalElement *const element)

void	RemoveGraphicalElements ()

QList< DdtGraphicalElement * > *	GetListOfGraphicalElements ()

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

void	ShowOverlay () const

void	HideOverlay () 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

std::string	ParseElementType (pt::ptree &elem_type)

Detailed Description

Class for the file based overlays

Constructor & Destructor Documentation

◆ DdtFileBasedOverlay()

DdtFileBasedOverlay::DdtFileBasedOverlay ( )

explicitdefault

Constructor

◆ ~DdtFileBasedOverlay()

DdtFileBasedOverlay::~DdtFileBasedOverlay ( )

virtualdefault

Destructor

Member Function Documentation

◆ AddGraphicalElement()

void DdtFileBasedOverlay::AddGraphicalElement ( DdtGraphicalElement *const element )

Adds a graphical element to the overlay

Parameters

element Pointer to the element object

◆ GetListOfGraphicalElements()

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

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

Returns: A list of graphical elements

◆ HideOverlay()

void DdtFileBasedOverlay::HideOverlay ( ) const

Hides the whole overlay

◆ HideOverlayByElement()

void DdtFileBasedOverlay::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 DdtFileBasedOverlay::HideOverlayByObject ( const QString object_name ) const

Hides a specified object of the overlay

Parameters

object_name Name of the overlay object to hide

◆ LoadOverlayFile()

bool DdtFileBasedOverlay::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

◆ ParseElementType()

std::string DdtFileBasedOverlay::ParseElementType ( pt::ptree & elem_type )

Parses the element type

Parameters

elem_type Type node of the element

Returns: Type of the element

◆ RemoveGraphicalElements()

void DdtFileBasedOverlay::RemoveGraphicalElements ( )

Removes all graphical elements from the overlay

◆ ShowOverlay()

void DdtFileBasedOverlay::ShowOverlay ( ) const

Shows the whole overlay

◆ ShowOverlayByElement()

void DdtFileBasedOverlay::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 DdtFileBasedOverlay::ShowOverlayByObject ( const QString object_name ) const

Shows a specified object of the overlay

Parameters

object_name Name of the overlay object to show

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

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