PolygonImageMask Class Reference

Represents an image mask defined by a polygonal shape. More...

#include <ImageMask.h>

Collaboration diagram for PolygonImageMask:

Public Member Functions
	PolygonImageMask (Polygon polygon, ImageMaskConfiguration config)
	Constructs a PolygonImageMask with a specified polygon and configuration.
	PolygonImageMask (Polygon polygon, ImageMaskConfiguration config, ImageBlurType blur)
	Constructs a PolygonImageMask with a specified polygon and configuration.
void	MaskWith (ImageMasker &masker) const override
	Applies the polygonal mask to an image using the provided ImageMasker.

Detailed Description

Represents an image mask defined by a polygonal shape.

It is a convenient class for masking and blurring polygon.

Constructor & Destructor Documentation

PolygonImageMask() [1/2]

PolygonImageMask ( Polygon polygon, ImageMaskConfiguration config )

inline

Constructs a PolygonImageMask with a specified polygon and configuration.

The polygon defines the shape and bounds of the mask, enabling masking of complex and irregular shapes. The configuration specifies additional parameters such as mask color and mask type, enhancing the flexibility and applicability of the mask.

Parameters

polygon	The Polygon object that defines the shape and bounds of the mask.
config	The ImageMaskConfiguration object that contains settings for how the mask should be applied, including blur and mask types.

PolygonImageMask() [2/2]

PolygonImageMask ( Polygon polygon, ImageMaskConfiguration config, ImageBlurType blur )

inline

Constructs a PolygonImageMask with a specified polygon and configuration.

The polygon defines the shape and bounds of the mask, enabling masking of complex and irregular shapes. The configuration specifies additional parameters such as mask color and mask type, enhancing the flexibility and applicability of the mask.

Parameters

polygon	The Polygon object that defines the shape and bounds of the mask.
blur	Type of blurring to by applied on mask-to-image transition.
config	The ImageMaskConfiguration object that contains settings for how the mask should be applied, including blur and mask types.

Member Function Documentation

MaskWith()

void MaskWith ( ImageMasker & masker ) const

inlineoverridevirtual

Applies the polygonal mask to an image using the provided ImageMasker.

Parameters

masker

The ImageMasker instance used to apply the mask to an image.

Implements ImageMask.

References ImageMasker::BlurPolygon(), ImageMasker::MaskPolygon(), and NO_BORDER_BLURRING.

Here is the call graph for this function:

---

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

• Image/ImageMask.h