TranFxMatteFactory Class Reference

#include <TranFxMatteFactory.h>

Public Member Functions
	TranFxMatteFactory ()
virtual	~TranFxMatteFactory ()
const AGMImageAccessor *	MakeMatte (IShape *iShape, const PMReal &resolution, const DrawOptionsSet &drawOptionsSet, const bool16 enableCaching)
PBPMRect	GetBoundingBox (IShape *iShape) const
bool16	GetPaintedBBoxWithoutMatte (IShape *iShape, PBPMRect &bounds) const
void	PurgeImageCache (const UIDList &itemList)
void	PurgeWholeCache (const UIDRef &documentUIDRef)

Detailed Description

Helps with the creation and caching of this plug-in's effect images.

See Also

TranFxConvolutionFilter

SnapshotUtils

IImageCacheMgr

IImageCache

Constructor & Destructor Documentation

TranFxMatteFactory::TranFxMatteFactory

(

)

Constructor.

TranFxMatteFactory::~TranFxMatteFactory ( )

virtual

Destructor.

Member Function Documentation

PMRect TranFxMatteFactory::GetBoundingBox

(

IShape *

iShape

)

const

Return the bounds of the matte in pasteboard co-ordinates.

Parameters

iShape

IN the object whose matte bounds are desired.

Returns

the bounds of the matte image.

bool16 TranFxMatteFactory::GetPaintedBBoxWithoutMatte	(	IShape *	iShape,
		PBPMRect &	bounds
	)		const

Get the painted bounds of the given shape not including the area that would be drawn by the matte effect. This uses IShape::GetPaintedBBox so if the given shape draws outside of its bounds (e.g. text on a path) bounds returned will reflect this. Since this IShape call will result in our adornment's TranFxAdornment::GetPaintedBBox being called, the implementation checks and blocks recursive calls.

Parameters

iShape	IN the object whose painted bounds are desired.
bounds	IN/OUT the painted bounding box (caller must check the return value is kTrue before relying on this value).

Returns

kTrue if the painted bounds are available, kFalse if a recursive call has been detected and the bounds are not being returned.

const AGMImageAccessor * TranFxMatteFactory::MakeMatte	(	IShape *	iShape,
		const PMReal &	resolution,
		const DrawOptionsSet &	drawOptionsSet,
		const bool16	enableCaching
	)

Generate a grey level matte image based on the current effect control flags.

Parameters

iShape	IN the object for which matte is to be generated.
resolution	IN desired resolution of the matte.
drawOptionsSet	IN draw options controlling matte quality.
enableCaching	IN kTrue to enable caching or matte via IImageCacheMgr, kFalse otherwise

Returns

pointer to AGMImageAccessor containing the matte image (the caller should not delete this memory).

void TranFxMatteFactory::PurgeImageCache

(

const UIDList &

itemList

)

Purge cached images for the given itemList.

Parameters

itemList

IN objects whose cached images are to be purged.

void TranFxMatteFactory::PurgeWholeCache

(

const UIDRef &

documentUIDRef

)

Purge all images this plug-in has cached for the given document.

Parameters

documentUIDRef

IN document containing objects whose cached images are to be purged.