IDOMGradientBrush Class Reference

A common interface for both IDOMLinearGradient and IDOMRadialGradient. Provides straightforward access to common attributes. More...

#include <idombrush.h>

Inheritance diagram for IDOMGradientBrush:

Public Member Functions
virtual eColorInterpolationMode	getColorInterpolationMode () const =0
	Retrieves the color interpolation mode value of the radial gradient brush.
virtual void	setColorInterpolationMode (eColorInterpolationMode cim)=0
	Sets the color interpolation mode value of the radial gradient brush.
virtual eSpreadMethod	getSpreadMethod () const =0
	Retrieves the spread method value of the RadialGradientBrush element.
virtual void	setSpreadMethod (eSpreadMethod sm)=0
	Sets spread method value of the RadialGradientBrush element.
virtual void	setGradientStops (const CDOMGradientStopVect &stops)=0
	Set the vector of stops in this gradient. Must not be empty.
virtual const CDOMGradientStopVect &	getGradientStops () const =0
	Retrieves the vector of stops in this gradient. An exception will be thrown if the gradient has no stops.
virtual void	addGradientStop (const IDOMGradientStopPtr &ptrGradientStop)=0
	Append a gradient stop.
virtual void	normalizeStops (IEDLClassFactory *pFactory, const IDOMColorSpacePtr &ptrColorSpace=IDOMColorSpacePtr(), eRenderingIntent intent=eRelativeColorimetric, eBlackPointCompensation bpc=eBPCDefault)=0
	Normalize the gradient stops to a single color space, sort them and ensure there are stops at 0.0 and 1.0.
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

A common interface for both IDOMLinearGradient and IDOMRadialGradient. Provides straightforward access to common attributes.

Member Function Documentation

addGradientStop()

virtual void IDOMGradientBrush::addGradientStop ( const IDOMGradientStopPtr & ptrGradientStop )

pure virtual

Append a gradient stop.

Parameters

ptrGradientStop

The smart pointer to the gradient stop interface

See also

IDOMGradientStop

getColorInterpolationMode()

virtual eColorInterpolationMode IDOMGradientBrush::getColorInterpolationMode ( ) const

pure virtual

Retrieves the color interpolation mode value of the radial gradient brush.

This is the gamma function for color interpolation for sRGB colors. The gamma adjustment should not be applied to the alpha component, if specified.

See also

eColorInterpolationMode

Returns

eColorInterpolationMode The color interpolation mode.

getGradientStops()

virtual const CDOMGradientStopVect & IDOMGradientBrush::getGradientStops ( ) const

pure virtual

Retrieves the vector of stops in this gradient. An exception will be thrown if the gradient has no stops.

See also

IDOMGradientStop

Returns

CDOMGradientStopVect The gradient stops

getSpreadMethod()

virtual eSpreadMethod IDOMGradientBrush::getSpreadMethod ( ) const

pure virtual

Retrieves the spread method value of the RadialGradientBrush element.

The spread method describes how the brush should fill the content area outside of the primary gradient area.

See also

eSpreadMethod

Returns

SpreadMethod The spread method value.

normalizeStops()

virtual void IDOMGradientBrush::normalizeStops ( IEDLClassFactory * pFactory, const IDOMColorSpacePtr & ptrColorSpace = IDOMColorSpacePtr(), eRenderingIntent intent = eRelativeColorimetric, eBlackPointCompensation bpc = eBPCDefault )

pure virtual

Normalize the gradient stops to a single color space, sort them and ensure there are stops at 0.0 and 1.0.

Parameters

pFactory	The EDL class factory
ptrColorSpace	The desired colors pace. Pass NULL to use the color space of the first brush.
intent	The desired conversion intent if color conversion is required.
bpc	The desired black point compensation treatment if color conversion is required.

setColorInterpolationMode()

virtual void IDOMGradientBrush::setColorInterpolationMode ( eColorInterpolationMode cim )

pure virtual

Sets the color interpolation mode value of the radial gradient brush.

This is the gamma function for color interpolation for sRGB colors. The gamma adjustment should not be applied to the alpha component, if specified.

Parameters

cim	The color interpolation mode value

See also

eColorInterpolationMode

setGradientStops()

virtual void IDOMGradientBrush::setGradientStops ( const CDOMGradientStopVect & stops )

pure virtual

Set the vector of stops in this gradient. Must not be empty.

See also

IDOMGradientStop

Parameters

stops

The gradient stops.

setSpreadMethod()

virtual void IDOMGradientBrush::setSpreadMethod ( eSpreadMethod sm )

pure virtual

Sets spread method value of the RadialGradientBrush element.

The spread method describes how the brush should fill the content area outside of the primary gradient area.

Parameters

sm	The new spread method value.

---

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

• idombrush.h