Mako 7.5.0 API
Loading...
Searching...
No Matches
IDOMShadingPatternType3Brush Class Referenceabstract

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

#include <idombrush.h>

Inheritance diagram for IDOMShadingPatternType3Brush:

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 setStartCircleCenter (const FPoint &point)=0
 Sets the center of the starting circle.
 
virtual const FPointgetStartCircleCenter () const =0
 Get the center of the starting circle.
 
virtual void setStartCircleRadius (float radius)=0
 Set the radius of the starting circle.
 
virtual float getStartCircleRadius () const =0
 Get the radius of the starting circle.
 
virtual void setEndCircleCenter (const FPoint &point)=0
 Sets the center of the ending circle.
 
virtual const FPointgetEndCircleCenter () const =0
 Get the center of the ending circle.
 
virtual void setEndCircleRadius (float radius)=0
 Set the radius of the ending circle.
 
virtual float getEndCircleRadius () const =0
 Get the radius of the ending circle.
 
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 circles.
 
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 Radial 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. This is not possible for all Type 3 shading brushes.
 
- 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 FMatrixgetRenderTransform () 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 CClassIDgetClassID () 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 IDOMShadingPatternType3BrushPtr create (IEDLClassFactory *pFactory, const FPoint &startCircleCenter, float startCircleRadius, const FPoint &endCircleCenter, float endCircleRadius, 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 3 shading pattern brush Throws an IEDLError on failure.
 
static const CClassIDclassID ()
 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

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

Member Function Documentation

◆ classID()

static const CClassID & IDOMShadingPatternType3Brush::classID ( )
inlinestatic

Retrieves class id of IDOM.

Returns
CClassID Class id of the element

◆ create()

static EDL_API IDOMShadingPatternType3BrushPtr IDOMShadingPatternType3Brush::create ( IEDLClassFactory * pFactory,
const FPoint & startCircleCenter,
float startCircleRadius,
const FPoint & endCircleCenter,
float endCircleRadius,
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 3 shading pattern brush Throws an IEDLError on failure.

Parameters
pFactoryThe factory to use.
startCircleCenterThe center of the starting circle for the shade
startCircleRadiusThe radius of the starting circle for the shade
endCircleCenterThe center of the starting circle for the shade
endCircleRadiusThe radius of the starting circle for the shade
colorSpaceThe color space for the shading pattern
domainThe domain of the shading variable
functionThe function describing the color of the shade over the range of the domain
extendStartTrue if the shade should be extended before the starting circle
extendEndTrue if the shade should be extended beyond the endinc circle
hasBBoxtrue if the bBox parameter should be used
bBoxThe shading bounding box
backgroundThe background color to use, or NULL for no background
renderTransformThe desired render transform.
antiAliasWhether anti-aliasing should be used for this shade or not
opacityThe opacity to use
Returns
IDOMVisualBrushPtr The new visual brush.

◆ getDomain()

virtual const float * IDOMShadingPatternType3Brush::getDomain ( ) const
pure virtual

Get the domain range.

Returns
Pointer to an array of two floats representing the domain

◆ getEndCircleCenter()

virtual const FPoint & IDOMShadingPatternType3Brush::getEndCircleCenter ( ) const
pure virtual

Get the center of the ending circle.

Returns
FPoint The ending circle center

◆ getEndCircleRadius()

virtual float IDOMShadingPatternType3Brush::getEndCircleRadius ( ) const
pure virtual

Get the radius of the ending circle.

Returns
float The ending circle radius

◆ getEquivalentSimpleBrush()

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

Gets an equivalent Radial 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. This is not possible for all Type 3 shading brushes.

Parameters
pFactoryA pointer to an EDL class factory
maxSamplesThe maximum number of samples that should be taken from the function to generate gradient stops.
Returns
IDOMBrushPtr The simplified brush, or NULL if this brush cannot be represented as a simpler brush. This brush will be cached, so do not edit; make a clone if the returned brush needs to be changed.

◆ getExtend()

virtual void IDOMShadingPatternType3Brush::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
extendStartReference to boolean parameter representing the flags for the starting circle
extendEndReference to boolean parameter representing the flags for the ending circle

◆ getStartCircleCenter()

virtual const FPoint & IDOMShadingPatternType3Brush::getStartCircleCenter ( ) const
pure virtual

Get the center of the starting circle.

Returns
FPoint The starting circle center

◆ getStartCircleRadius()

virtual float IDOMShadingPatternType3Brush::getStartCircleRadius ( ) const
pure virtual

Get the radius of the starting circle.

Returns
float The staring circle radius

◆ setDomain()

virtual void IDOMShadingPatternType3Brush::setDomain ( float domain[2])
pure virtual

Sets the domain range.

Parameters
domainArray of 2 floats

◆ setEndCircleCenter()

virtual void IDOMShadingPatternType3Brush::setEndCircleCenter ( const FPoint & point)
pure virtual

Sets the center of the ending circle.

Parameters
pointThe ending circle center

◆ setEndCircleRadius()

virtual void IDOMShadingPatternType3Brush::setEndCircleRadius ( float radius)
pure virtual

Set the radius of the ending circle.

Parameters
radiusThe ending circle radius

◆ setExtend()

virtual void IDOMShadingPatternType3Brush::setExtend ( bool extendStart,
bool extendEnd )
pure virtual

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

Parameters
extendStartBoolean parameter representing the flags for the starting circle
extendEndBoolean parameter representing the flags for the ending circle

◆ setStartCircleCenter()

virtual void IDOMShadingPatternType3Brush::setStartCircleCenter ( const FPoint & point)
pure virtual

Sets the center of the starting circle.

Parameters
pointThe starting circle center

◆ setStartCircleRadius()

virtual void IDOMShadingPatternType3Brush::setStartCircleRadius ( float radius)
pure virtual

Set the radius of the starting circle.

Parameters
radiusThe staring circle radius

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