IDOMGradientStop Class Reference

IDOMGradientStop defines the ramp of colors to use on a gradient. More...

#include <idombrush.h>

Inheritance diagram for IDOMGradientStop:

Classes
class	Data
	Initialization data. More...

Public Member Functions
virtual IDOMColorPtr	getColor () const =0
	Retrieves the color value of the gradient stop. Never returns NULL.
virtual void	setColor (const IDOMColorPtr &color)=0
	Sets the color value of the gradient stop.
virtual double	getOffset () const =0
	Retrieves the offset value of the gradient stop.
virtual void	setOffset (double offset)=0
	Sets the offset value of the gradient stop.
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 IDOMGradientStopPtr	create (IEDLClassFactory *pFactory, const IDOMColorPtr &color, double offset)
	Simplified gradient stop creation. Throws an IEDLError on failure.
static const CClassID &	classID ()
	Retrieves class id of IDOMGradientStop.

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

Detailed Description

IDOMGradientStop defines the ramp of colors to use on a gradient.

A gradient is a smooth transition from one color to the next. The color range for a gradient can be composed of two or more colors. Each color used in a gradient requires at least one gradient stop. A gradient stop has two attributes: color and offset. The offset defines a line along which all points have the same color value; it determines the distance from the base line (for linear gradients) or the radial distance from the starting point of the gradient (for radial gradients), relative to the total distance the gradient covers. The color value determines the color of all points on the line specified by the offset. Between two adjacent gradient stops, the color shades smoothly from the color specified at the first offset to that specified at the second.

Member Function Documentation

classID()

static const CClassID & IDOMGradientStop::classID ( )

inlinestatic

Retrieves class id of IDOMGradientStop.

Returns

CClassID Class id of the element

create()

static EDL_API IDOMGradientStopPtr IDOMGradientStop::create ( IEDLClassFactory * pFactory, const IDOMColorPtr & color, double offset )

static

Simplified gradient stop creation. Throws an IEDLError on failure.

Parameters

pFactory	The EDL Class factory to use.
color	The color to use.
offset	The stop offset

Returns

IDOMGradientStopPtr The new gradient stop

getColor()

virtual IDOMColorPtr IDOMGradientStop::getColor ( ) const

pure virtual

Retrieves the color value of the gradient stop. Never returns NULL.

Returns

IDOMGradientStop the color of the stop

getOffset()

virtual double IDOMGradientStop::getOffset ( ) const

pure virtual

Retrieves the offset value of the gradient stop.

Returns

double Returns the offset value.

setColor()

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

pure virtual

Sets the color value of the gradient stop.

Parameters

color

The new color value.

setOffset()

virtual void IDOMGradientStop::setOffset ( double offset )

pure virtual

Sets the offset value of the gradient stop.

Parameters

offset

The new offset value.

---

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

• idombrush.h