IDOMTilingPatternBrush provides a way of representing a PS style tiling pattern. More...

#include <edl/idombrush.h>

Inheritance diagram for IDOMTilingPatternBrush:

Classes
class	Data
	Initialization data. More...

Public Member Functions
virtual uint8	getPatternType () const =0
	Retrieves the pattern type.
virtual const FBox &	getBBox () const =0
	Retrieves the bounding box for the pattern.
virtual void	setBBox (const FBox &bBox)=0
	Sets the bounding box for the pattern.
virtual void	getTilingStep (float &xstep, float &ystep) const =0
	Retrieves the tiling step for the pattern.
virtual void	setTilingStep (float xstep, float ystep)=0
	Sets the tiling step for the pattern.
virtual void	setPaintType (uint8 paintType)=0
	Sets the paint type for the pattern.
virtual uint8	getPaintType () const =0
	Gets the paint type for the pattern.
virtual void	setTilingType (uint8 tilingType)=0
	Sets the tiling type for the pattern.
virtual uint8	getTilingType () const =0
	Gets the tiling type for the pattern.
virtual void	setPatternColor (const IDOMColorPtr &color)=0
	Sets the pattern color for uncolored pattern (paint type is 2)
virtual IDOMColorPtr	getPatternColor () const =0
	Gets the pattern color for uncolored pattern (paint type is 2)
virtual IDOMNodePtr	getVisual () const =0
	Retrieves smart pointer to visual (path, glyphs, group, canvas) node.
virtual void	setVisual (const IDOMNodePtr &ptrVisual)=0
	Sets visual node.
virtual IDOMVisualBrushPtr	getEquivalentVisualBrush (IEDLClassFactory *pFactory)=0
	Gets an equivalent IDOMVisualBrush brush. If the brush has overlapping tiles, this cannot be done.
virtual IDOMTilingPatternBrushPtr	getColoredTilingPatternBrush (IEDLClassFactory *pFactory, bool overprint=false)=0
	Get a version of this tiling pattern brush that is always colored (paint type 1) If the brush is already colored, then this brush will be returned. Otherwise a new brush will be created where the pattern color is applied to the contents of the visual.
Public Member Functions inherited from IDOMTransformableBrush
virtual const FMatrix &	getRenderTransform () 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 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 IDOMTilingPatternBrushPtr	create (IEDLClassFactory *pFactory, const IDOMNodePtr &visual, const FRect &bBox, uint8 paintType, const IDOMColorPtr &color, float xStep, float yStep, uint8 tilingType=1, const FMatrix &renderTransform=FMatrix())
	Simplified creator for a tiling brush. Throws an IEDLError on failure.
static const CClassID &	classID ()
	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

IDOMTilingPatternBrush provides a way of representing a PS style tiling pattern.

Member Function Documentation

◆ classID()

const CClassID & IDOMTilingPatternBrush::classID ( )

inlinestatic

Retrieves class id of IDOM.

Returns: CClassID Class id of the element

◆ create()

EDL_API IDOMTilingPatternBrushPtr IDOMTilingPatternBrush::create	(	IEDLClassFactory *	pFactory,
		const IDOMNodePtr &	visual,
		const FRect &	bBox,
		uint8	paintType,
		const IDOMColorPtr &	color,
		float	xStep,
		float	yStep,
		uint8	tilingType = 1,
		const FMatrix &	renderTransform = FMatrix() )

static

Simplified creator for a tiling brush. Throws an IEDLError on failure.

Parameters

pFactory	The factory to use.
visual	The node or node tree representing the pattern's content.
bBox	the bounding box of the pattern's content.
paintType	The paint type, either 1 (colored) or 2 (uncolored)
color	The color to use. Must be NULL for paintType 1. For paintType 2, if NULL, A DeviceGray black will be used.
xStep	The tiling step in X
yStep	The tiling step in Y
tilingType	The tiling type; 1 for constant spacing, 2 for no distortion, 3 for constant spacing and faster tiling.
renderTransform	The desired render transform.

Returns: IDOMTilingPatternBrushPtr The new brush.

◆ getBBox()

virtual const FBox & IDOMTilingPatternBrush::getBBox ( ) const

pure virtual

Retrieves the bounding box for the pattern.

Returns: FBox The bounding box

◆ getColoredTilingPatternBrush()

virtual IDOMTilingPatternBrushPtr IDOMTilingPatternBrush::getColoredTilingPatternBrush	(	IEDLClassFactory *	pFactory,
		bool	overprint = false )

pure virtual

Get a version of this tiling pattern brush that is always colored (paint type 1) If the brush is already colored, then this brush will be returned. Otherwise a new brush will be created where the pattern color is applied to the contents of the visual.

Parameters

pFactory	A pointer to an EDL class factory, which must be an IJawsMako instance.
overprint	If true, overprint will be set on all objects that will use the color.

Returns: IDOMTilingPatternBrushPtr A colored version of the brush, or the original brush if the brush is already coloured. The returned brush may be cached, so do not edit; make a clone if the returned brush needs to be changed.

◆ getEquivalentVisualBrush()

virtual IDOMVisualBrushPtr IDOMTilingPatternBrush::getEquivalentVisualBrush ( IEDLClassFactory * pFactory )

pure virtual

Gets an equivalent IDOMVisualBrush brush. If the brush has overlapping tiles, this cannot be done.

Parameters

pFactory A pointer to an EDL class factory

Returns: IDOMVisualBrushPtr The resulting visual brush, or NULL if this brush cannot be expressed as a visual brush. This brush may be cached, so do not edit; make a clone if the returned brush needs to be changed.

◆ getPaintType()

virtual uint8 IDOMTilingPatternBrush::getPaintType ( ) const

pure virtual

Gets the paint type for the pattern.

Returns: int32 The paint type (1 for colored tiling pattern, 2 for uncolored)

◆ getPatternColor()

virtual IDOMColorPtr IDOMTilingPatternBrush::getPatternColor ( ) const

pure virtual

Gets the pattern color for uncolored pattern (paint type is 2)

Returns: IDOMColorPtr The color, or NULL for paint type 1

◆ getPatternType()

virtual uint8 IDOMTilingPatternBrush::getPatternType ( ) const

pure virtual

Retrieves the pattern type.

Returns: int Returns pattern type, 1 for tiling pattern

◆ getTilingStep()

virtual void IDOMTilingPatternBrush::getTilingStep	(	float &	xstep,
		float &	ystep ) const

pure virtual

Retrieves the tiling step for the pattern.

Parameters

xstep	Reference to xstep
ystep	Reference to ystep

◆ getTilingType()

virtual uint8 IDOMTilingPatternBrush::getTilingType ( ) const

pure virtual

Gets the tiling type for the pattern.

Returns: int32 The tiling type (1 for constant spacing, 2 for no distortion, 3 for constant spacing and faster tiling)

◆ getVisual()

virtual IDOMNodePtr IDOMTilingPatternBrush::getVisual ( ) const

pure virtual

Retrieves smart pointer to visual (path, glyphs, group, canvas) node.

Returns: IDOMNodePtr The visual

◆ setBBox()

virtual void IDOMTilingPatternBrush::setBBox ( const FBox & bBox )

pure virtual

Sets the bounding box for the pattern.

Parameters

bBox	The box to use

◆ setPaintType()

virtual void IDOMTilingPatternBrush::setPaintType ( uint8 paintType )

pure virtual

Sets the paint type for the pattern.

Parameters

paintType The paint type (1 for colored tiling pattern, 2 for uncolored)

◆ setPatternColor()

virtual void IDOMTilingPatternBrush::setPatternColor ( const IDOMColorPtr & color )

pure virtual

Sets the pattern color for uncolored pattern (paint type is 2)

Parameters

color Reference to the desired color to use.

◆ setTilingStep()

virtual void IDOMTilingPatternBrush::setTilingStep	(	float	xstep,
		float	ystep )

pure virtual

Sets the tiling step for the pattern.

Parameters

xstep	Reference to xstep
ystep	Reference to ystep

◆ setTilingType()

virtual void IDOMTilingPatternBrush::setTilingType ( uint8 tilingType )

pure virtual

Sets the tiling type for the pattern.

Parameters

tilingType The tiling type (1 for constant spacing, 2 for no distortion, 3 for constant spacing and faster tiling)

◆ setVisual()

virtual void IDOMTilingPatternBrush::setVisual ( const IDOMNodePtr & ptrVisual )

pure virtual

Sets visual node.

Parameters

ptrVisual Smart pointer to the visual node

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()

◆ getBBox()

◆ getColoredTilingPatternBrush()

◆ getEquivalentVisualBrush()

◆ getPaintType()

◆ getPatternColor()

◆ getPatternType()

◆ getTilingStep()

◆ getTilingType()

◆ getVisual()

◆ setBBox()

◆ setPaintType()

◆ setPatternColor()

◆ setTilingStep()

◆ setTilingType()

◆ setVisual()