Mako 7.3.0 API
IDOMGradientBrush Class Referenceabstract

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. More...
 
virtual void setColorInterpolationMode (eColorInterpolationMode cim)=0
 Sets the color interpolation mode value of the radial gradient brush. More...
 
virtual eSpreadMethod getSpreadMethod () const =0
 Retrieves the spread method value of the RadialGradientBrush element. More...
 
virtual void setSpreadMethod (eSpreadMethod sm)=0
 Sets spread method value of the RadialGradientBrush element. More...
 
virtual void setGradientStops (const CDOMGradientStopVect &stops)=0
 Set the vector of stops in this gradient. Must not be empty. More...
 
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. More...
 
virtual void addGradientStop (const IDOMGradientStopPtr &ptrGradientStop)=0
 Append a gradient stop. More...
 
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. More...
 
- Public Member Functions inherited from IDOMTransformableBrush
virtual const FMatrixgetRenderTransform () const =0
 Retrieves the render transform matrix. More...
 
virtual void setRenderTransform (const FMatrix &matrix)=0
 Sets the render transform matrix. More...
 
- Public Member Functions inherited from IDOMBrush
virtual eBrushType getBrushType () const =0
 Retrieves the type of the brush. More...
 
virtual float getOpacity () const =0
 Retrieves the opacity value of the brush element. More...
 
virtual void setOpacity (float opc)=0
 Sets the opacity value of a brush element. More...
 
virtual IDOMBrushPtr getAdjustedForUseInTransformedNode (IEDLClassFactory *pFactory, const FMatrix &nodeTransform)
 Get a version of this brush adjusted for use inside a node with the given transform. More...
 
- Public Member Functions inherited from IEDLObject
virtual const CClassIDgetClassID () const =0
 Returns class ID of IEDLObject. More...
 
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. More...
 
virtual bool clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
 Create a copy of EDLObject. More...
 
- 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. More...
 
virtual int32 getRefCount () const =0
 Retrieve the current reference count of the actual object pointed to. More...
 

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
ptrGradientStopThe 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
pFactoryThe EDL class factory
ptrColorSpaceThe desired colors pace. Pass NULL to use the color space of the first brush.
intentThe desired conversion intent if color conversion is required.
bpcThe 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
cimThe 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
stopsThe 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
smThe new spread method value.

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