Tools for creating masks for graphic objects based on their contours. More...

#include <TreeUtilsSVG.h>

Inheritance diagram for MaskerSVG:

Collaboration diagram for MaskerSVG:

[legend]

Public Types
enum	MaskPosition { NONE =0 , TOP =1 , BOTTOM =2 }

Public Member Functions
	MaskerSVG (const MaskerSVG &masker)

int	visitPrefix (TreeSVG &tree, const TreeSVG::path_t &path) override
	Ensures a clipping path o f type RECT of given size.

int	visitPostfix (TreeSVG &tree, const TreeSVG::path_t &path) override

Public Member Functions inherited from TreeVisitor< TreeSVG >
virtual int	visitPrefix (TreeSVG &tree, const typename T::path_t &path)
	Tasks to be executed before traversing child nodes.

virtual int	visitPostfix (TreeSVG &tree, const typename T::path_t &path)
	Tasks to be executed after traversing child nodes.

Static Public Member Functions
static const drain::FlexibleVariable &	ensureMaskId (TreeSVG &group)
	Mark an overlay group "masked", meaning that at least one of its objects (also) creates a mask for that group.

static TreeSVG &	getMask (TreeSVG &root, const std::string &maskId)
	From global document definitions (DEFS), retrieve the mask designed for this group.

static drain::image::TreeSVG &	updateMask (TreeSVG &mask, int width, int height, const NodeSVG &contourNode)
	Method for an object to copy its contour.

static TreeSVG &	createMask (TreeSVG &root, TreeSVG &group, int width=0, int height=0, const NodeSVG &node=NodeSVG(svg::UNDEFINED), MaskerSVG::MaskPosition pos=MaskerSVG::MaskPosition::BOTTOM)
	Calls createMaskId(), getMask() and updateMask().

static void	addCoverRect (const TreeSVG &mask, TreeSVG &group, MaskPosition pos=TOP)
	Finally, associate the object with a mask by assigning MASK elements ID to the mask attribute of object. Disabled; see addCoverRect() below.

Static Public Attributes
static const std::string	MASK_ID = "data-mask"

static const std::string	MASK_POS = "data-mask-pos"

static const ClassXML	COVER

Detailed Description

Tools for creating masks for graphic objects based on their contours.

Member Function Documentation

◆ addCoverRect()

void addCoverRect	(	const TreeSVG &	mask,
		TreeSVG &	group,
		MaskPosition	pos = `TOP`
	)

static

Finally, associate the object with a mask by assigning MASK elements ID to the mask attribute of object. Disabled; see addCoverRect() below.

Finally, associate the object with a mask by assigning MASK elements ID to the mask attribute of object. The mask parameter with be assigned value "url(" + maskId + ")".

Parameters

mask	- SVG object of type MASK.
group	- SVG group containing graphics, appended by a RECT of class COVER.

◆ createMask()

TreeSVG & createMask	(	TreeSVG &	root,
		TreeSVG &	group,
		int	width = `0`,
		int	height = `0`,
		const NodeSVG &	node = `NodeSVG(svg::UNDEFINED)`,
		MaskerSVG::MaskPosition	pos = `MaskerSVG::MaskPosition::BOTTOM`
	)

static

Calls createMaskId(), getMask() and updateMask().

Saves the following attributes to group

data-mask-id
data-mask-pos

◆ ensureMaskId()

const drain::FlexibleVariable & ensureMaskId ( TreeSVG & group )

static

Mark an overlay group "masked", meaning that at least one of its objects (also) creates a mask for that group.

Later, a RECT will be appended, serving as a masking element.

◆ updateMask()

drain::image::TreeSVG & updateMask	(	TreeSVG &	mask,
		int	width,
		int	height,
		const NodeSVG &	contourNode
	)

static

Method for an object to copy its contour.

Parameters

mask	- SVG object of type MASK.
width	- width of the originating object
height	- height of the originating object
contourNode	- (closed) SVG element, typically of type PATH, to be copied to the mask.