IDOMSoftMaskBrush provides a way of representing a PDF style soft mask in it's entirity. The soft mask brush contains a suitable IDOMTransparency group, as well as the necessary soft mask details. See section 7.5.4 of the PDF 1.7 specification. These are only allowed for OpacityMask entries. More...

#include <idombrush.h>

Inheritance diagram for IDOMSoftMaskBrush:

[legend]

Classes
class	Data
	Initialization data. More...

Public Types
enum	eSoftMaskType
	Enum for soft mask interpretation.

Public Types inherited from IDOMBrush
enum	eBrushType { eSolidColor , eLinearGradient , eRadialGradient , eImage , eMasked , eVisual , eSoftMask , eTilingPattern , eType1ShadingPattern , eType2ShadingPattern , eType3ShadingPattern , eType4567ShadingPattern , eNull }
	Brush type enumeration. More...

Public Member Functions
virtual eSoftMaskType	getSoftMaskType () const =0
	Retrieves the soft mask type.

virtual IDOMTransparencyGroupPtr	getGroup () const =0
	Retrieves the transparency group used for the mask.

virtual IDOMColorPtr	getBackdropColor () const =0
	Retrieves the color used for luminosity backdrop composition.

virtual IDOMFunctionPtr	getTransferFunction () const =0
	Retrieves the function used for luminosity used for deriving mask values.

Public Member Functions inherited from IDOMTransformableBrush
virtual const FMatrix &	getRenderTransform () const =0
	Retrieves the render transform matrix.

virtual void	setRenderTransform (const FMatrix &matrix)=0
	Sets the render transform matrix.

Public Member Functions inherited from IDOMBrush
virtual eBrushType	getBrushType () const =0
	Retrieves the type of the brush.

virtual float	getOpacity () const =0
	Retrieves the opacity value of the brush element.

virtual void	setOpacity (float opc)=0
	Sets the opacity value of a brush element.

virtual IDOMBrushPtr	getAdjustedForUseInTransformedNode (IEDLClassFactory *pFactory, const FMatrix &nodeTransform)
	Get a version of this brush adjusted for use inside a node with the given transform.

Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject.

virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory.

virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject.

Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.

virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.

virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Static Public Member Functions
static EDL_API IDOMSoftMaskBrushPtr	create (IEDLClassFactory *pFactory, const IDOMTransparencyGroupPtr &group, eSoftMaskType type, const FMatrix &renderTransform=FMatrix(), const IDOMColorPtr &backdropColor=IDOMColorPtr(), const IDOMFunctionPtr &transfer=IDOMFunctionPtr())
	Simplified creator for a soft mask brush. Throws an IEDLError on failure.

static const CClassID &	classID ()
	Retrieves class id of IDOM.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

IDOMSoftMaskBrush provides a way of representing a PDF style soft mask in it's entirity. The soft mask brush contains a suitable IDOMTransparency group, as well as the necessary soft mask details. See section 7.5.4 of the PDF 1.7 specification. These are only allowed for OpacityMask entries.

Member Function Documentation

◆ classID()

static const CClassID & IDOMSoftMaskBrush::classID ( )

inlinestatic

Retrieves class id of IDOM.

Returns: CClassID Class id of the element

◆ create()

static EDL_API IDOMSoftMaskBrushPtr IDOMSoftMaskBrush::create	(	IEDLClassFactory *	pFactory,
		const IDOMTransparencyGroupPtr &	group,
		eSoftMaskType	type,
		const FMatrix &	renderTransform = FMatrix(),
		const IDOMColorPtr &	backdropColor = IDOMColorPtr(),
		const IDOMFunctionPtr &	transfer = IDOMFunctionPtr() )

static

Simplified creator for a soft mask brush. Throws an IEDLError on failure.

Parameters

pFactory	The factory to use.
group	The group to form the content of the soft mask.
type	The type of the soft mask.
renderTransform	The desired render transform.
backdropColor	The backdrop color (must have the same color space as the group). Optional.
transfer	The soft mask transfer function. Optional.

Returns: IDOMSoftMaskBrushPtr The new brush.

◆ getBackdropColor()

virtual IDOMColorPtr IDOMSoftMaskBrush::getBackdropColor ( ) const

pure virtual

Retrieves the color used for luminosity backdrop composition.

Parameters

b IDOMColorPtr The backdrop color, or NULL if no backdrop color is present.

◆ getGroup()

virtual IDOMTransparencyGroupPtr IDOMSoftMaskBrush::getGroup ( ) const

pure virtual

Retrieves the transparency group used for the mask.

Returns: IDOMTransparencyGroupPtr The group

◆ getSoftMaskType()

virtual eSoftMaskType IDOMSoftMaskBrush::getSoftMaskType ( ) const

pure virtual

Retrieves the soft mask type.

Returns: eSoftMaskType The soft mask type.

◆ getTransferFunction()

virtual IDOMFunctionPtr IDOMSoftMaskBrush::getTransferFunction ( ) const

pure virtual

Retrieves the function used for luminosity used for deriving mask values.

Returns: IDOMFunctionPtr The transform function, or NULL if there is no transfer function

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

idombrush.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classID()

◆ create()

◆ getBackdropColor()

◆ getGroup()

◆ getSoftMaskType()

◆ getTransferFunction()