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

#include <idombrush.h>

Inheritance diagram for IDOMShadingPatternType2Brush:

[legend]

Classes
class	Data
	Initialization data. More...

Public Member Functions
virtual void	setDomain (float domain[2])=0
	Sets the domain range.

virtual const float *	getDomain () const =0
	Get the domain range.

virtual void	setStartPoint (const FPoint &point)=0
	Sets the start point.

virtual const FPoint &	getStartPoint () const =0
	Get the start point.

virtual void	setEndPoint (const FPoint &point)=0
	Set the end point.

virtual const FPoint &	getEndPoint () const =0
	Get the end point.

virtual void	setExtend (bool extendStart, bool extendEnd)=0
	Sets the shading Extend flag to represent whether or not to extend beyond the start and end points.

virtual void	getExtend (bool &extendStart, bool &extendEnd) const =0
	Gets the shading Extend flag to represent whether or not to extend beyond the start and end points for each axis.

virtual IDOMBrushPtr	getEquivalentSimpleBrush (IEDLClassFactory *pFactory, uint32 maxSamples=255)=0
	Gets an equivalent Linear gradient or Visual brush, which may involve sampling the functions. A Visual brush is required if the shading pattern has a bounding box, in order to apply a clip. This is intended to be used to generate a brush that can be expressed directly in XPS.

Public Member Functions inherited from IDOMShadingPatternBrush
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.

Public Member Functions inherited from IDOMHashable
virtual	~IDOMHashable ()
	Virtual destructor.

virtual bool	hash (uint64 &hash)=0
	Retrieve a hash for this object.

virtual uint64	hashE ()
	As hash(), but throws an exception if the operation fails.

Static Public Member Functions
static EDL_API IDOMShadingPatternType2BrushPtr	create (IEDLClassFactory *pFactory, const FPoint &startPoint, const FPoint &endPoint, const IDOMColorSpacePtr &colorSpace, float domain[2], const IDOMFunctionPtr &function, bool extendStart=false, bool extendEnd=false, bool hasBBox=false, const FBox &bBox=FBox(), const IDOMColorPtr &background=IDOMColorPtr(), const FMatrix &renderTransform=FMatrix(), bool antiAlias=false, float opacity=1.0f)
	Simplified creator for a type 2 shading pattern brush Throws an IEDLError on failure.

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

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 type 2 shading pattern.

Member Function Documentation

◆ classID()

static const CClassID & IDOMShadingPatternType2Brush::classID ( )

inlinestatic

Retrieves class id of IDOM.

Returns: CClassID Class id of the element

◆ create()

static EDL_API IDOMShadingPatternType2BrushPtr IDOMShadingPatternType2Brush::create	(	IEDLClassFactory *	pFactory,
		const FPoint &	startPoint,
		const FPoint &	endPoint,
		const IDOMColorSpacePtr &	colorSpace,
		float	domain[2],
		const IDOMFunctionPtr &	function,
		bool	extendStart = false,
		bool	extendEnd = false,
		bool	hasBBox = false,
		const FBox &	bBox = FBox(),
		const IDOMColorPtr &	background = IDOMColorPtr(),
		const FMatrix &	renderTransform = FMatrix(),
		bool	antiAlias = false,
		float	opacity = 1.0f )

static

Simplified creator for a type 2 shading pattern brush Throws an IEDLError on failure.

Parameters

pFactory	The factory to use.
startPoint	The starting point for the shade
endPoint	The end point for the shade
colorSpace	The color space for the shading pattern
domain	The domain of the shading variable
function	The function describing the color of the shade over the range of the domain
extendStart	True if the shade should be extended before the start point (as per linear gradient pad mode)
extendEnd	True if the shade should be extended beyond the end point (as per linear gradient pad mode)
hasBBox	true if the bBox parameter should be used
bBox	The shading bounding box
background	The background color to use, or NULL for no background
renderTransform	The desired render transform.
antiAlias	Whether anti-aliasing should be used for this shade or not
opacity	The opacity to use

Returns: IDOMVisualBrushPtr The new visual brush.

◆ getDomain()

virtual const float * IDOMShadingPatternType2Brush::getDomain ( ) const

pure virtual

Get the domain range.

Returns: Pointer to an array of two floats representing the domain

◆ getEndPoint()

virtual const FPoint & IDOMShadingPatternType2Brush::getEndPoint ( ) const

pure virtual

Get the end point.

Returns: FPoint The end point

◆ getEquivalentSimpleBrush()

virtual IDOMBrushPtr IDOMShadingPatternType2Brush::getEquivalentSimpleBrush	(	IEDLClassFactory *	pFactory,
		uint32	maxSamples = 255 )

pure virtual

Gets an equivalent Linear gradient or Visual brush, which may involve sampling the functions. A Visual brush is required if the shading pattern has a bounding box, in order to apply a clip. This is intended to be used to generate a brush that can be expressed directly in XPS.

Parameters

pFactory	A pointer to an EDL class factory
maxSamples	The maximum number of samples that should be taken from the function to generate gradient stops.

Returns: IDOMBrushPtr The simplified brush. This brush will be cached, so do not edit; make a clone if the returned brush needs to be changed.

◆ getExtend()

virtual void IDOMShadingPatternType2Brush::getExtend	(	bool &	extendStart,
		bool &	extendEnd ) const

pure virtual

Gets the shading Extend flag to represent whether or not to extend beyond the start and end points for each axis.

Parameters

extendStart	Reference to bool parameter representing the flags for the start point
extendEnd	Reference to bool parameter representing the flags for the end point

◆ getStartPoint()

virtual const FPoint & IDOMShadingPatternType2Brush::getStartPoint ( ) const

pure virtual

Get the start point.

Returns: FPoint The start point

◆ setDomain()

virtual void IDOMShadingPatternType2Brush::setDomain ( float domain[2] )

pure virtual

Sets the domain range.

Parameters

domain Array of 2 floats

◆ setEndPoint()

virtual void IDOMShadingPatternType2Brush::setEndPoint ( const FPoint & point )

pure virtual

Set the end point.

Parameters

point The end point

◆ setExtend()

virtual void IDOMShadingPatternType2Brush::setExtend	(	bool	extendStart,
		bool	extendEnd )

pure virtual

Sets the shading Extend flag to represent whether or not to extend beyond the start and end points.

Parameters

extendStart	parameter representing the flags for the start point
extendEnd	parameter representing the flags for the end point

◆ setStartPoint()

virtual void IDOMShadingPatternType2Brush::setStartPoint ( const FPoint & point )

pure virtual

Sets the start point.

Parameters

point The start point

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

idombrush.h

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classID()

◆ create()

◆ getDomain()

◆ getEndPoint()

◆ getEquivalentSimpleBrush()

◆ getExtend()

◆ getStartPoint()

◆ setDomain()

◆ setEndPoint()

◆ setExtend()

◆ setStartPoint()