A solid color brush is used to fill defined geometric regions with a solid color. If there is an alpha component of the color, it is combined in a multiplicative way with the corresponding opacity attribute. More...

#include <edl/idombrush.h>

Inheritance diagram for IDOMSolidColorBrush:

[legend]

Classes
class	Data
	Initialization data. More...

Public Member Functions
virtual IDOMColorPtr	getColor () const =0
	Retrieves the color value of the solid color brush.
virtual void	setColor (const IDOMColorPtr &color)=0
	Sets color value of the solid color brush.
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 IDOMSolidColorBrushPtr	create (IEDLClassFactory *pFactory, const IDOMColorPtr &color, float opacity=1.0f)
	Simplified solid color brush creation. Throws an IEDLError on failure.
static IDOMSolidColorBrushPtr	createSolidGray (IEDLClassFactory *pFactory, float gray=0.0f)
	Simplified solid color brush creation for DeviceGray colors. Default parameters will yield an opaque DeviceGray black.
static IDOMSolidColorBrushPtr	createSolidRgb (IEDLClassFactory *pFactory, float r=0.0f, float g=0.0f, float b=0.0f)
	Simplified solid color brush creation for DeviceRGB colors. Default parameters will yield an opaque DeviceRGB black.
static IDOMSolidColorBrushPtr	createSolidCmyk (IEDLClassFactory *pFactory, float c=0.0f, float m=0.0f, float y=0.0f, float k=0.0f)
	Simplified solid color brush creation for DeviceCMYK colors. Default parameters will yield an opaque DeviceCMYK white.
static EDL_API IDOMSolidColorBrushPtr	createWithSpaceAndComponents (IEDLClassFactory *pFactory, const IDOMColorSpacePtr &space, double opacity, double component1, double component2=0.0, double component3=0.0, double component4=0.0, double component5=0.0, double component6=0.0, double component7=0.0, double component8=0.0, double component9=0.0, double component10=0.0, double component11=0.0, double component12=0.0, double component13=0.0, double component14=0.0, double component15=0.0, double component16=0.0, double component17=0.0, double component18=0.0, double component19=0.0, double component20=0.0, double component21=0.0, double component22=0.0, double component23=0.0, double component24=0.0, double component25=0.0, double component26=0.0, double component27=0.0, double component28=0.0, double component29=0.0, double component30=0.0, double component31=0.0, double component32=0.0)
	Simplified solid color brush creation routine which takes a color space and components directly. Throws an IEDLError on failure.
static EDL_API IDOMSolidColorBrushPtr	createWithSpaceAndComponentsFromVect (IEDLClassFactory *pFactory, const IDOMColorSpacePtr &space, float opacity, const CEDLVector< float > &components)
	Simplified solid color brush creation routine which takes a color space and components directly. Throws an IEDLError on failure.
static EDL_API IDOMSolidColorBrushPtr	createWithSpaceAndComponentsFromArray (IEDLClassFactory pFactory, const IDOMColorSpacePtr &space, float opacity, const float components)
	Simplified solid color brush creation routine which takes a color space and components directly. Throws an IEDLError on failure.
static const CClassID &	classID ()
	Retrieves class id of IDOMIDOMSolidColorBrush.

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 solid color brush is used to fill defined geometric regions with a solid color. If there is an alpha component of the color, it is combined in a multiplicative way with the corresponding opacity attribute.

Member Function Documentation

◆ classID()

const CClassID & IDOMSolidColorBrush::classID ( )

inlinestatic

Retrieves class id of IDOMIDOMSolidColorBrush.

Returns: CClassID Class id of the element

◆ create()

EDL_API IDOMSolidColorBrushPtr IDOMSolidColorBrush::create	(	IEDLClassFactory *	pFactory,
		const IDOMColorPtr &	color,
		float	opacity = 1.0f )

static

Simplified solid color brush creation. Throws an IEDLError on failure.

Parameters

pFactory	The EDL Class factory to use.
color	The color to use.
opacity	The alpha to use.

Returns: IDOMSolidColorBrushPtr The new brush.

◆ createSolidCmyk()

IDOMSolidColorBrushPtr IDOMSolidColorBrush::createSolidCmyk	(	IEDLClassFactory *	pFactory,
		float	c = 0.0f,
		float	m = 0.0f,
		float	y = 0.0f,
		float	k = 0.0f )

inlinestatic

Simplified solid color brush creation for DeviceCMYK colors. Default parameters will yield an opaque DeviceCMYK white.

Parameters

pFactory	The EDL Class factory to use.
c	The cyan level to use.
m	The magenta level to use.
y	The yellow level to use.
k	The black level to use.

Returns: IDOMSolidColorBrushPtr The new brush.

◆ createSolidGray()

IDOMSolidColorBrushPtr IDOMSolidColorBrush::createSolidGray	(	IEDLClassFactory *	pFactory,
		float	gray = 0.0f )

inlinestatic

Simplified solid color brush creation for DeviceGray colors. Default parameters will yield an opaque DeviceGray black.

Parameters

pFactory	The EDL Class factory to use.
gray	The gray level to use (0 is black).

Returns: IDOMSolidColorBrushPtr The new brush.

◆ createSolidRgb()

IDOMSolidColorBrushPtr IDOMSolidColorBrush::createSolidRgb	(	IEDLClassFactory *	pFactory,
		float	r = 0.0f,
		float	g = 0.0f,
		float	b = 0.0f )

inlinestatic

Simplified solid color brush creation for DeviceRGB colors. Default parameters will yield an opaque DeviceRGB black.

Parameters

pFactory	The EDL Class factory to use.
r	The red level to use.
g	The green level to use.
b	The blue level to use.

Returns: IDOMSolidColorBrushPtr The new brush.

◆ createWithSpaceAndComponents()

EDL_API IDOMSolidColorBrushPtr IDOMSolidColorBrush::createWithSpaceAndComponents	(	IEDLClassFactory *	pFactory,
		const IDOMColorSpacePtr &	space,
		double	opacity,
		double	component1,
		double	component2 = 0.0,
		double	component3 = 0.0,
		double	component4 = 0.0,
		double	component5 = 0.0,
		double	component6 = 0.0,
		double	component7 = 0.0,
		double	component8 = 0.0,
		double	component9 = 0.0,
		double	component10 = 0.0,
		double	component11 = 0.0,
		double	component12 = 0.0,
		double	component13 = 0.0,
		double	component14 = 0.0,
		double	component15 = 0.0,
		double	component16 = 0.0,
		double	component17 = 0.0,
		double	component18 = 0.0,
		double	component19 = 0.0,
		double	component20 = 0.0,
		double	component21 = 0.0,
		double	component22 = 0.0,
		double	component23 = 0.0,
		double	component24 = 0.0,
		double	component25 = 0.0,
		double	component26 = 0.0,
		double	component27 = 0.0,
		double	component28 = 0.0,
		double	component29 = 0.0,
		double	component30 = 0.0,
		double	component31 = 0.0,
		double	component32 = 0.0 )

static

Simplified solid color brush creation routine which takes a color space and components directly. Throws an IEDLError on failure.

Parameters

pFactory	The EDL Class factory to use.
space	The color space to use.
opacity	The opacity to use (assigned to the brush, not the color)
component1	The first color component to use.
component2	The second color component to use (if applicable).
component3	The third color component to use (if applicable).
component4	The fourth color component to use. (if applicable)
component5	The fifth color component to use (if applicable).
component6	The sixth color component to use (if applicable).
component7	The seventh color component to use.
component8	The eighth color component to use (if applicable).
component9	The ninth color component to use (if applicable).
component10	The tenth color component to use (if applicable).
component11	The eleventh color component to use (if applicable).
component12	The twelfth color component to use (if applicable).
component13	The thirteenth color component to use (if applicable).
component14	The fourteenth color component to use (if applicable).
component15	The fifteenth color component to use (if applicable).
component16	The sixteenth color component to use (if applicable).
component17	The seventeenth color component to use (if applicable).
component18	The eighteenth color component to use (if applicable).
component19	The nineteenth color component to use (if applicable).
component20	The twentieth color component to use (if applicable).
component21	The twenty-first color component to use (if applicable).
component22	The twenty-second color component to use (if applicable).
component23	The twenty-third color component to use (if applicable).
component24	The twenty-fourth color component to use (if applicable).
component25	The twenty-fifth color component to use (if applicable).
component26	The twenty-sixth color component to use (if applicable).
component27	The twenty-seventh color component to use (if applicable).
component28	The twenty-eighth color component to use (if applicable).
component29	The twenty-ninth color component to use (if applicable).
component30	The thirtieth color component to use (if applicable).
component31	The thirty-first color component to use (if applicable).
component32	The thirty-second color component to use (if applicable).

Returns: IDOMColorPtr The new color.; IDOMColorPtr The new color.

◆ createWithSpaceAndComponentsFromArray()

EDL_API IDOMSolidColorBrushPtr IDOMSolidColorBrush::createWithSpaceAndComponentsFromArray	(	IEDLClassFactory *	pFactory,
		const IDOMColorSpacePtr &	space,
		float	opacity,
		const float *	components )

static

Simplified solid color brush creation routine which takes a color space and components directly. Throws an IEDLError on failure.

Parameters

pFactory	The EDL Class factory to use.
space	The color space to use.
opacity	The opacity to use (assigned to the brush, not the color)
components	An array of color components to use, as floats. The number of components MUST match the number of components expected of the color space.

Returns: IDOMColorPtr The new color.

◆ createWithSpaceAndComponentsFromVect()

EDL_API IDOMSolidColorBrushPtr IDOMSolidColorBrush::createWithSpaceAndComponentsFromVect	(	IEDLClassFactory *	pFactory,
		const IDOMColorSpacePtr &	space,
		float	opacity,
		const CEDLVector< float > &	components )

static

Simplified solid color brush creation routine which takes a color space and components directly. Throws an IEDLError on failure.

Parameters

pFactory	The EDL Class factory to use.
space	The color space to use.
opacity	The opacity to use (assigned to the brush, not the color)
components	A vector of color components to use, as floats. The number of components MUST match the number of components expected of the color space.

Returns: IDOMColorPtr The new color.

◆ getColor()

virtual IDOMColorPtr IDOMSolidColorBrush::getColor ( ) const

pure virtual

Retrieves the color value of the solid color brush.

Returns: IDOMColorPtr The color

◆ setColor()

virtual void IDOMSolidColorBrush::setColor ( const IDOMColorPtr & color )

pure virtual

Sets color value of the solid color brush.

Parameters

color The color value

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

edl/idombrush.h

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classID()

◆ create()

◆ createSolidCmyk()

◆ createSolidGray()

◆ createSolidRgb()

◆ createWithSpaceAndComponents()

◆ createWithSpaceAndComponentsFromArray()

◆ createWithSpaceAndComponentsFromVect()

◆ getColor()

◆ setColor()