IDOMShadingBrush provides a way of representing a PS style shading pattern. More...

#include <edl/idombrush.h>

Inheritance diagram for IDOMShadingPatternBrush:

Public Member Functions
virtual uint8	getShadingType () const =0
	Retrieves the shading type.
virtual bool	getBBox (FBox &bBox) const =0
	Retrieves the bounding box for the shade.
virtual void	setBBox (const FBox &bBox)=0
	Sets the bounding box for the shade.
virtual void	setBackgroundColor (const IDOMColorPtr &color)=0
	Sets the background color to use before painting the shade.
virtual IDOMColorPtr	getBackgroundColor () const =0
	Gets the background color to use before painting the shade. If the return is NULL then the background is not painted before applying the shade.
virtual void	setColorSpace (const IDOMColorSpacePtr &colorSpace)=0
	Sets the colorspace to use for painting the shade.
virtual IDOMColorSpacePtr	getColorSpace () const =0
	Gets the colorspace object to be used when painting the shading.
virtual void	setColorSpace (IEDLClassFactory *pFactory, const IDOMColorSpacePtr &colorSpace, eRenderingIntent intent, eBlackPointCompensation bpc)=0
	Set the colorspace of the shading brush, performing color conversion to that target space. This will also convert the background color if present, whereas the alternate setColorSpace() above will not.
virtual void	deIndex (IEDLClassFactory *pFactory)=0
	If the shading brush uses an Indexed color space, reduce it to its base color space.
virtual void	setAntiAlias (bool antiAlias)=0
	Sets anti aliasing flag.
virtual bool	getAntiAlias () const =0
	Gets anti aliasing flag.
virtual void	setFunction (const IDOMFunctionPtr &function)=0
	Sets the shade function.
virtual IDOMFunctionPtr	getFunction () const =0
	Gets the shade function object.
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.

Additional Inherited Members
Public Types inherited from IDOMBrush
enum	eBrushType { eSolidColor , eLinearGradient , eRadialGradient , eImage , eMasked , eVisual , eSoftMask , eTilingPattern , eType1ShadingPattern , eType2ShadingPattern , eType3ShadingPattern , eType4567ShadingPattern , eNull }
	Brush type enumeration. More...
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

IDOMShadingBrush provides a way of representing a PS style shading pattern.

Member Function Documentation

◆ deIndex()

virtual void IDOMShadingPatternBrush::deIndex ( IEDLClassFactory * pFactory )

pure virtual

If the shading brush uses an Indexed color space, reduce it to its base color space.

Parameters

pFactory A pointer to an EDL class factory

◆ getAntiAlias()

virtual bool IDOMShadingPatternBrush::getAntiAlias ( ) const

pure virtual

Gets anti aliasing flag.

Returns: bool The antialiasing flag

◆ getBackgroundColor()

virtual IDOMColorPtr IDOMShadingPatternBrush::getBackgroundColor ( ) const

pure virtual

Gets the background color to use before painting the shade. If the return is NULL then the background is not painted before applying the shade.

Returns: IDOMColorPtr The background color, or NULL if not present

◆ getBBox()

virtual bool IDOMShadingPatternBrush::getBBox ( FBox & bBox ) const

pure virtual

Retrieves the bounding box for the shade.

Parameters

bBox	Reference to receive the bounding box

Returns: bool True if the brush has a bounding box, false otherwise.

◆ getColorSpace()

virtual IDOMColorSpacePtr IDOMShadingPatternBrush::getColorSpace ( ) const

pure virtual

Gets the colorspace object to be used when painting the shading.

Returns: IDOMColorSpacePtr The colorspace

◆ getFunction()

virtual IDOMFunctionPtr IDOMShadingPatternBrush::getFunction ( ) const

pure virtual

Gets the shade function object.

Returns: IDOMFunctionPtr The function, or NULL if no function is present.

◆ getShadingType()

virtual uint8 IDOMShadingPatternBrush::getShadingType ( ) const

pure virtual

Retrieves the shading type.

Returns: int Returns 1 to 7 for the different PS shading types

◆ setAntiAlias()

virtual void IDOMShadingPatternBrush::setAntiAlias ( bool antiAlias )

pure virtual

Sets anti aliasing flag.

Parameters

antiAlias New value of antialiasing flag

◆ setBackgroundColor()

virtual void IDOMShadingPatternBrush::setBackgroundColor ( const IDOMColorPtr & color )

pure virtual

Sets the background color to use before painting the shade.

Parameters

color The smart pointer to the color object.

◆ setBBox()

virtual void IDOMShadingPatternBrush::setBBox ( const FBox & bBox )

pure virtual

Sets the bounding box for the shade.

Parameters

bBox	The desired box

◆ setColorSpace() [1/2]

virtual void IDOMShadingPatternBrush::setColorSpace ( const IDOMColorSpacePtr & colorSpace )

pure virtual

Sets the colorspace to use for painting the shade.

Parameters

colorSpace The smart pointer to the colorspace object.

◆ setColorSpace() [2/2]

virtual void IDOMShadingPatternBrush::setColorSpace	(	IEDLClassFactory *	pFactory,
		const IDOMColorSpacePtr &	colorSpace,
		eRenderingIntent	intent,
		eBlackPointCompensation	bpc )

pure virtual

Set the colorspace of the shading brush, performing color conversion to that target space. This will also convert the background color if present, whereas the alternate setColorSpace() above will not.

Parameters

pFactory	A pointer to an EDL class factory
colorSpace	The smart pointer to the color space. Must not be a complex or composite color space such as Indexed or DeviceN.
intent	The rendering intent to use for conversion.
bpc	Black point compensation treatment. If in doubt, use eBPCDefault.

◆ setFunction()

virtual void IDOMShadingPatternBrush::setFunction ( const IDOMFunctionPtr & function )

pure virtual

Sets the shade function.

Parameters

function Smart pointer to a function object

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

edl/idombrush.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ deIndex()

◆ getAntiAlias()

◆ getBackgroundColor()

◆ getBBox()

◆ getColorSpace()

◆ getFunction()

◆ getShadingType()

◆ setAntiAlias()

◆ setBackgroundColor()

◆ setBBox()

◆ setColorSpace() [1/2]

◆ setColorSpace() [2/2]

◆ setFunction()