IDOMShadingPatternType4567Brush provides a way of representing a PS style type 4 shading pattern. More...

#include <idombrush.h>

Inheritance diagram for IDOMShadingPatternType4567Brush:

[legend]

Classes
class	CMeshEntry
	A entry in the shading pattern's mesh. The interpretation of each entry depends on the shading type, and potentially on per-entry flags. Please see the PDF specification for details. More...

class	Data
	Initialization data. More...

Public Member Functions
virtual void	setShadingType (uint8 shadingType)=0
	Sets the shading type. More...

virtual void	setDataSource (const JawsMako::IPDFStringPtr &dataSource)=0
	Sets the data source property. More...

virtual JawsMako::IPDFStringPtr	getDataSource () const =0
	Gets the data source property. More...

virtual void	setBitsPerCoordinate (uint8 bitsPerCoordinate)=0
	Sets the bits per coordinate. More...

virtual uint8	getBitsPerCoordinate () const =0
	Gets the bits per coordinate parameter. More...

virtual void	setBitsPerComponent (uint8 bitsPerComponent)=0
	Sets the bits per component. More...

virtual uint8	getBitsPerComponent () const =0
	Gets the bits per component parameter. More...

virtual void	setBitsPerFlag (uint8 bitsPerFlag)=0
	Sets the bits per flag. More...

virtual uint8	getBitsPerFlag () const =0
	Gets the bits per flag parameter. More...

virtual void	setVerticesPerRow (int32 verticesPerRow)=0
	Sets the vertices per row flag. More...

virtual int32	getVerticesPerRow () const =0
	Gets the vertices per row parameter. More...

virtual void	setDecode (const CEDLVector< float > &decode)=0
	Sets the decode array. More...

virtual const CEDLVector< float > &	getDecode () const =0
	Gets the decode array. More...

virtual CMeshEntryVect	getMeshEntries () const =0
	Get the vector of mesh entries that describe the appearance of this shading pattern. This will return a copy that may be edited freely. More...

virtual void	setMeshEntries (const CMeshEntryVect &meshEntries)=0
	Set the vector of mesh entries that describe the appearance of this shading pattern. More...

Public Member Functions inherited from IDOMShadingPatternBrush
virtual uint8	getShadingType () const =0
	Retrieves the shading type. More...

virtual bool	getBBox (FBox &bBox) const =0
	Retrieves the bounding box for the shade. More...

virtual void	setBBox (const FBox &bBox)=0
	Sets the bounding box for the shade. More...

virtual void	setBackgroundColor (const IDOMColorPtr &color)=0
	Sets the background color to use before painting the shade. More...

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. More...

virtual void	setColorSpace (const IDOMColorSpacePtr &colorSpace)=0
	Sets the colorspace to use for painting the shade. More...

virtual IDOMColorSpacePtr	getColorSpace () const =0
	Gets the colorspace object to be used when painting the shading. More...

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. More...

virtual void	deIndex (IEDLClassFactory *pFactory)=0
	If the shading brush uses an Indexed color space, reduce it to its base color space. More...

virtual void	setAntiAlias (bool antiAlias)=0
	Sets anti aliasing flag. More...

virtual bool	getAntiAlias () const =0
	Gets anti aliasing flag. More...

virtual void	setFunction (const IDOMFunctionPtr &function)=0
	Sets the shade function. More...

virtual IDOMFunctionPtr	getFunction () const =0
	Gets the shade function object. More...

Public Member Functions inherited from IDOMTransformableBrush
virtual const FMatrix &	getRenderTransform () 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 CClassID &	getClassID () 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...

Public Member Functions inherited from IDOMHashable
virtual	~IDOMHashable ()
	Virtual destructor.

virtual bool	hash (uint64 &hash)=0
	Retrieve a hash for this object. More...

virtual uint64	hashE ()
	As hash(), but throws an exception if the operation fails. More...

Static Public Member Functions
static EDL_API IDOMShadingPatternType4567BrushPtr	create (IEDLClassFactory *pFactory, uint8 shadingType, const IDOMColorSpacePtr &colorSpace, const JawsMako::IPDFStringPtr &dataSource, const uint8 bitsPerCoordinate=0, const uint8 bitsPerComponent=0, const uint8 bitsPerFlag=0, const int32 verticesPerRow=0, const CEDLVector< float > &decode=CEDLVector< float >(), const IDOMFunctionPtr &function=IDOMFunctionPtr(), 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 4,5,6 or 7 shading pattern brush Throws an IEDLError on failure. More...

static EDL_API IDOMShadingPatternType4567BrushPtr	create (IEDLClassFactory *pFactory, uint8 shadingType, const IDOMColorSpacePtr &colorSpace, const IDOMFunctionPtr &function, const CMeshEntryVect &meshEntries, const uint8 bitsPerCoordinate=16, const uint8 bitsPerComponent=8, const uint8 bitsPerFlag=8, const int32 verticesPerRow=0, const CEDLVector< float > &decode=CEDLVector< float >(), 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 4,5,6 or 7 shading pattern brush, providing a mesh as data source Throws an IEDLError on failure. When using a mesh source, the bitsPerComponent is locked to 8. More...

static const CClassID &	classID ()
	Retrieves class id of IDOM. 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

IDOMShadingPatternType4567Brush provides a way of representing a PS style type 4 shading pattern.

Member Function Documentation

◆ classID()

static const CClassID& IDOMShadingPatternType4567Brush::classID ( )

inlinestatic

Retrieves class id of IDOM.

Returns: CClassID class id of the element

◆ create() [1/2]

static EDL_API IDOMShadingPatternType4567BrushPtr IDOMShadingPatternType4567Brush::create	(	IEDLClassFactory *	pFactory,
		uint8	shadingType,
		const IDOMColorSpacePtr &	colorSpace,
		const IDOMFunctionPtr &	function,
		const CMeshEntryVect &	meshEntries,
		const uint8	bitsPerCoordinate = `16`,
		const uint8	bitsPerComponent = `8`,
		const uint8	bitsPerFlag = `8`,
		const int32	verticesPerRow = `0`,
		const CEDLVector< float > &	decode = `CEDLVector< float >()`,
		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 4,5,6 or 7 shading pattern brush, providing a mesh as data source Throws an IEDLError on failure. When using a mesh source, the bitsPerComponent is locked to 8.

Parameters

pFactory	The factory to use.
shadingType	The shading pattern type.
colorSpace	The color space for the shading pattern.
function	If the mesh entries specify a parametric value instead of a color, the function that produces the final output color. If the mesh specifies actual colors, this should be null.
meshEntries	The mesh entries to use to construct the shade.
bitsPerCoordinate	The number of bits used to represent each coordinate.
bitsPerComponent	The number of bits used to the function or color samples at each coordinate. If the color space is indexed, and the colors are stored in the mesh, then this is ignored and the depth will be forced to 8 bits per component.
bitsPerFlag	The number of bits used to represent the edge flag for each patch or vertex (depends on shade type). Not used for all shade types.
verticesPerRow	The vertices per row parameter. Not used for all shade types.
decode	A vector representing the decode array of the shade. if the data source provides vertex color information.
hasBBox	true if the bBox parameter should be used
bBox	The shading bounding box
background	The background color to use, or NULL for no background
renderTransform	The desired render transform.
antiAlias	Whether anti-aliasing should be used for this shade or not
opacity	The opacity to use

Returns: IDOMVisualBrushPtr The new visual brush.

◆ create() [2/2]

static EDL_API IDOMShadingPatternType4567BrushPtr IDOMShadingPatternType4567Brush::create	(	IEDLClassFactory *	pFactory,
		uint8	shadingType,
		const IDOMColorSpacePtr &	colorSpace,
		const JawsMako::IPDFStringPtr &	dataSource,
		const uint8	bitsPerCoordinate = `0`,
		const uint8	bitsPerComponent = `0`,
		const uint8	bitsPerFlag = `0`,
		const int32	verticesPerRow = `0`,
		const CEDLVector< float > &	decode = `CEDLVector< float >()`,
		const IDOMFunctionPtr &	function = `IDOMFunctionPtr()`,
		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 4,5,6 or 7 shading pattern brush Throws an IEDLError on failure.

Parameters

pFactory	The factory to use.
shadingType	The shading pattern type.
colorSpace	The color space for the shading pattern.
dataSource	The data source used for vertex/patch data.
bitsPerCoordinate	The number of bits used to represent each coordinate.
bitsPerComponent	The number of bits used to represent each color component.
bitsPerFlag	The number of bits used to represent the edge flag for each patch or vertex (depends on shade type). Not used for all shade types.
verticesPerRow	The vertices per row parameter. Not used for all shade types.
decode	A vector representing the decode array of the shade.
function	The optional shading function describing the color depending on the parametric shade variable. Must be NULL if the data source provides vertex color information.
hasBBox	true if the bBox parameter should be used.
bBox	The shading bounding box.
background	The background color to use, or NULL for no background.
renderTransform	The desired render transform.
antiAlias	Whether anti-aliasing should be used for this shade or not.
opacity	The opacity to use.

Returns: IDOMVisualBrushPtr The new visual brush.

◆ getBitsPerComponent()

virtual uint8 IDOMShadingPatternType4567Brush::getBitsPerComponent ( ) const

pure virtual

Gets the bits per component parameter.

Returns: uint8 The bits per component parameter

◆ getBitsPerCoordinate()

virtual uint8 IDOMShadingPatternType4567Brush::getBitsPerCoordinate ( ) const

pure virtual

Gets the bits per coordinate parameter.

Returns: uint8 The bits per coordinate parameter

◆ getBitsPerFlag()

virtual uint8 IDOMShadingPatternType4567Brush::getBitsPerFlag ( ) const

pure virtual

Gets the bits per flag parameter.

Returns: uint8 The bits per flag

◆ getDataSource()

virtual JawsMako::IPDFStringPtr IDOMShadingPatternType4567Brush::getDataSource ( ) const

pure virtual

Gets the data source property.

Returns: IPDFStringPtr The data source

◆ getDecode()

virtual const CEDLVector<float>& IDOMShadingPatternType4567Brush::getDecode ( ) const

pure virtual

Gets the decode array.

Returns: CEDLVector<float> The decode array

◆ getMeshEntries()

virtual CMeshEntryVect IDOMShadingPatternType4567Brush::getMeshEntries ( ) const

pure virtual

Get the vector of mesh entries that describe the appearance of this shading pattern. This will return a copy that may be edited freely.

Returns: CMeshEntryVect The mesh entries.

◆ getVerticesPerRow()

virtual int32 IDOMShadingPatternType4567Brush::getVerticesPerRow ( ) const

pure virtual

Gets the vertices per row parameter.

Returns: int32 The vertices per row parameter

◆ setBitsPerComponent()

virtual void IDOMShadingPatternType4567Brush::setBitsPerComponent ( uint8 bitsPerComponent )

pure virtual

Sets the bits per component.

Parameters

bitsPerComponent Bits per component value to set

◆ setBitsPerCoordinate()

virtual void IDOMShadingPatternType4567Brush::setBitsPerCoordinate ( uint8 bitsPerCoordinate )

pure virtual

Sets the bits per coordinate.

Parameters

bitsPerCoordinate Bits per coordinate value to set

◆ setBitsPerFlag()

virtual void IDOMShadingPatternType4567Brush::setBitsPerFlag ( uint8 bitsPerFlag )

pure virtual

Sets the bits per flag.

Parameters

bitsPerFlag Bits per flag value to set

◆ setDataSource()

virtual void IDOMShadingPatternType4567Brush::setDataSource ( const JawsMako::IPDFStringPtr & dataSource )

pure virtual

Sets the data source property.

Parameters

dataSource A reference to the data source encoded as a PDF string object

◆ setDecode()

virtual void IDOMShadingPatternType4567Brush::setDecode ( const CEDLVector< float > & decode )

pure virtual

Sets the decode array.

Parameters

decode The decode array

◆ setMeshEntries()

virtual void IDOMShadingPatternType4567Brush::setMeshEntries ( const CMeshEntryVect & meshEntries )

pure virtual

Set the vector of mesh entries that describe the appearance of this shading pattern.

Parameters

meshEntries The mesh entries.

◆ setShadingType()

virtual void IDOMShadingPatternType4567Brush::setShadingType ( uint8 shadingType )

pure virtual

Sets the shading type.

Parameters

shadingType An integer which represents the PS style shading type (one of 4, 5, 6 or 7)

◆ setVerticesPerRow()

virtual void IDOMShadingPatternType4567Brush::setVerticesPerRow ( int32 verticesPerRow )

pure virtual

Sets the vertices per row flag.

Parameters

verticesPerRow Vertices per row value to set. Must be greater than two.

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

idombrush.h

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classID()

◆ create() [1/2]

◆ create() [2/2]

◆ getBitsPerComponent()

◆ getBitsPerCoordinate()

◆ getBitsPerFlag()

◆ getDataSource()

◆ getDecode()

◆ getMeshEntries()

◆ getVerticesPerRow()

◆ setBitsPerComponent()

◆ setBitsPerCoordinate()

◆ setBitsPerFlag()

◆ setDataSource()

◆ setDecode()

◆ setMeshEntries()

◆ setShadingType()

◆ setVerticesPerRow()