Creator of SVG image elements located in a SVG group with fixed structure. More...

#include <ImageSVG.h>

Collaboration diagram for ImagePanel:

[legend]

Public Member Functions
	ImagePanel (drain::image::TreeSVG &imagePanelGroup, const drain::image::Image &src, const drain::FilePath &filePath)
	Recommended constructor, if Image is defined: stores also METADATA.

	ImagePanel (drain::image::TreeSVG &imagePanelGroup, const drain::FilePath &filePath, const drain::Frame2D< drain::image::svg::coord_t > &geom={0, 0})

	ImagePanel (drain::image::TreeSVG &imagePanelGroup, const drain::Frame2D< int > &geom={0, 0})
	Retrieves the group defined last, or creates...

drain::image::TreeSVG &	getImage (const drain::FilePath &filePath=drain::FilePath(), const drain::Frame2D< drain::image::svg::coord_t > &geom={0, 0}) const

drain::image::TreeSVG &	getImage (const drain::image::Image &src, const drain::FilePath &filepath) const
	Recommended version, if image is defined.

drain::image::TreeSVG &	getMetadata () const

drain::image::TreeSVG &	getOverlayGroup () const

drain::image::TreeSVG &	getBackGround () const

drain::image::TreeSVG &	getImageBorder () const

drain::image::TreeSVG &	getVectorOverlayGroup (const std::string &key="", const drain::Frame2D< drain::image::svg::coord_t > &geom={0, 0}) const
	For vector graphics (grids, sectors)

drain::image::TreeSVG &	getMouseListenerElem () const

drain::image::TreeSVG &	getDataImage (const drain::FilePath &filepath=drain::FilePath(), const drain::Frame2D< drain::image::svg::coord_t > &geom={0, 0}) const

drain::image::TreeSVG &	getDescription ()
	Return a description element (of the image).

drain::image::TreeSVG &	getSelectionVisualisation ()
	Return a SELECTOR element or group.

Static Public Attributes
static const ClassXML	IMAGE_PANEL
	Group containing and image and, potentially, title TEXTs.

static const ClassXML	BACKGROUND
	RECT, by default invisible, used for aligning other objects, like titles.

static const ClassXML	OVERLAY
	Group for vector graphics.

static const ClassXML	SELECTOR

static const ClassXML	DATA_ARRAY
	Optional image serving as a data block.

static const ClassXML	IMAGE_BORDER
	Topmost layer, optionally with a visible border.

Protected Member Functions
drain::image::TreeSVG &	getUniqueElem (drain::image::TreeSVG &parent, const drain::ClassXML &cls, drain::image::svg::tag_t type=drain::image::svg::GROUP) const

drain::image::TreeSVG &	getUniqueElem (drain::image::TreeSVG &parent, drain::image::svg::tag_t type=drain::image::svg::GROUP) const

Protected Attributes
drain::image::TreeSVG &	imagePanelGroup

Detailed Description

Creator of SVG image elements located in a SVG group with fixed structure.

Preferred way to add images (and related vector overlays. Creates a structure accessible with methods.

The panel structure consists of a group (svg::GROUP.IMAGE_PANEL) with

one svg::IMAGE element, optionally removed (changed to DESC)
an overlay layer svg::GROUP.OVERLAY designed for vector graphics, initially containing a background svg::RECT.BACKGROUND_RECT applied for aligning subsequent elements.
image border (svg::RECT.IMAGE_BORDER), optionally with a visible outline style (.IMAGE_BORDER), and optionally with a mouse event listener
an extra overlay (svg::RECT.COVER) masking the image and vector elements

Member Function Documentation

◆ getImage()

drain::image::TreeSVG & getImage	(	const drain::image::Image &	src,
		const drain::FilePath &	filepath
	)		const

inline

Recommended version, if image is defined.

Note: current version does not store METADATA.

◆ getSelectionVisualisation()

drain::image::TreeSVG & getSelectionVisualisation ( )

inline

Return a SELECTOR element or group.

Notice: the element type is not set by this function.

◆ getVectorOverlayGroup()

drain::image::TreeSVG & getVectorOverlayGroup	(	const std::string &	key = `""`,
		const drain::Frame2D< drain::image::svg::coord_t > &	geom = `{0,0}`
	)		const

For vector graphics (grids, sectors)

For

Member Data Documentation

◆ DATA_ARRAY

const ClassXML DATA_ARRAY

static

Optional image serving as a data block.

See also: MouseXML

◆ IMAGE_BORDER

const ClassXML IMAGE_BORDER

static

Topmost layer, optionally with a visible border.

Optionally, this layer can be attached mouse event listener(s).

See also: MouseXML

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

src/drain/image/ImageSVG.h
src/drain/image/ImageSVG.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes