#include <IGraphicsUtils.h>

Inheritance diagram for IGraphicsUtils:

Public Types
enum	{ kDefaultIID = IID_IGRAPHICSUTILS }

Public Member Functions
virtual void	CopyPathToPort (const IPathData srcPath, IGraphicsPort gPort)=0

virtual PMReal	AlignUserCoordToDevicePixelCenter (IRasterPort *rPort, const PMReal &userCoord)=0

virtual void	CreateAnchorPointPath (IRasterPort rPort, IGraphicsPort gPort, const PMPoint &handleLocation, const PMReal &size=PMReal(4.0), bool16 doFloor=kTrue)=0

virtual void	CreateAnchorRectPaths (IRasterPort rPort, IGraphicsPort gPort, const PMRect &theRect, const PMReal &size, bool16 doFloor)=0

virtual void	CreateAnchorPointPath_UserCoords (IRasterPort rPort, IGraphicsPort gPort, const PMMatrix &sourceToUserMatrix, const PMPoint &handleLocation, const PMReal &size=PMReal(4.0), bool16 doFloor=kTrue)=0

virtual void	CreateAnchorRectPaths_UserCoords (IRasterPort rPort, IGraphicsPort gPort, const PMMatrix &sourceToUserMatrix, const PMRect &sourceRect, const PMReal &size, bool16 doFloor=kTrue)=0

virtual void	CreateDirectionPointPath (IRasterPort rPort, IGraphicsPort gPort, const PMPoint &handleLocation)=0

virtual void	CreateDirectionPointPath_UserCoords (IRasterPort rPort, IGraphicsPort gPort, const PMMatrix &sourceToUserMatrix, const PMPoint &handleLocation)=0

virtual void	CreateTextLinkPath (IRasterPort rPort, IGraphicsPort gPort, const PMPoint &handleLocation, bool16 bVerticalOrientation=kFalse, bool16 bRightToLeftOrientation=kFalse)=0

virtual void	CreateTextOversetPath (IRasterPort rPort, IGraphicsPort gPort, const PMPoint &handleLocation, bool16 drawSelected=kTrue)=0

virtual PMPoint	ComputeMitreAdjustPoint (const PMPoint &beforePt, const PMPoint &currentPt, const PMPoint &afterPt, const PMReal &strokeWeight, const PMReal &miterLimit)=0

virtual void	ComputeLineBounds (const PMPointList &B, const PMReal &strokeWeight, const PMMatrix &xForm, const PMReal &miterLimit, int32 joinType, int32 lineCap, bool16 leftIsOpen, bool16 rightIsOpen, PMPoint previousPt, PMReal xMin, PMReal xMax, PMReal yMin, PMReal *yMax)=0

virtual IColorSpaceMgr *	QueryDefaultColorSpaceMgr ()=0

virtual bool8	SetupRasterPort (IRasterPort *rPort)=0

virtual PMRect	GetUpdateClipRect (GraphicsData *gd)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

An utility interface for graphic related operations.

Member Function Documentation

virtual PMReal IGraphicsUtils::AlignUserCoordToDevicePixelCenter	(	IRasterPort *	rPort,
		const PMReal &	userCoord
	)

pure virtual

Align the given user coordinate in the port to the center of the nearest device pixel.

Parameters

rPort	specifies raster port device (used to determine the device scale factor).
userCoord	is the coordinate value to be aligned.

Returns: the pixel center aligned value

virtual void IGraphicsUtils::ComputeLineBounds	(	const PMPointList &	B,
		const PMReal &	strokeWeight,
		const PMMatrix &	xForm,
		const PMReal &	miterLimit,
		int32	joinType,
		int32	lineCap,
		bool16	leftIsOpen,
		bool16	rightIsOpen,
		PMPoint *	previousPt,
		PMReal *	xMin,
		PMReal *	xMax,
		PMReal *	yMin,
		PMReal *	yMax
	)

pure virtual

Compute the line's bounds taking into account its stroke weight, miter limit, join type, and line cap.

Parameters

B	is the line specified by two points.
strokeWeight	is the line weight.
xForm	is the transformation matrix.
miterLimit	is the miter limit.
joinType	is the join type
lineCap	is the line cap.
leftIsOpen	is true if left end point of line is open.
rightIsOpen	is true if right line end point is open.
previousPt	is used to compute the miter if left end point is not open.
xMin	is the minimum bound for the line along the x-axis.
xMax	is the maximum bound for the line along the x-axis.
yMin	is the minimum bound for the line along the y-axis.
yMax	is the maximum bound for the line along the y-axis.

virtual PMPoint IGraphicsUtils::ComputeMitreAdjustPoint	(	const PMPoint &	beforePt,
		const PMPoint &	currentPt,
		const PMPoint &	afterPt,
		const PMReal &	strokeWeight,
		const PMReal &	miterLimit
	)

pure virtual

Compute the miter adjusted point for current point.

Parameters

beforePt	specifies the point before the current point.
currentPt	is the current point.
afterPt	specifies the point after current point.
strokeWeight	is the line weight.
miterLimit	is the miter limit.

Returns: the miter adjusted point.

virtual void IGraphicsUtils::CopyPathToPort	(	const IPathData *	srcPath,
		IGraphicsPort *	gPort
	)

pure virtual

Copy the given path data into the graphics port.

Parameters

srcPath	specifies the path data to copy.
gPort	is the graphic port.

virtual void IGraphicsUtils::CreateAnchorPointPath	(	IRasterPort *	rPort,
		IGraphicsPort *	gPort,
		const PMPoint &	handleLocation,
		const PMReal &	size = `PMReal(4.0)`,
		bool16	doFloor = `kTrue`
	)

pure virtual

Create an anchor point path marker in the port. The function converts to destination coords using rPort.

Parameters

rPort	specifies target raster port.
gPort	is the target graphic port.
handleLocation	is the location of the marker in source coordinates.
size	is the pixel size of the marker.
doFloor	is true if fractional pixel is clipped.

virtual void IGraphicsUtils::CreateAnchorPointPath_UserCoords	(	IRasterPort *	rPort,
		IGraphicsPort *	gPort,
		const PMMatrix &	sourceToUserMatrix,
		const PMPoint &	handleLocation,
		const PMReal &	size = `PMReal(4.0)`,
		bool16	doFloor = `kTrue`
	)

pure virtual

Create an anchor point path marker in the port.

The function assumes rPort coords have already been set to it's native user coords (identity CTM), and will be reset by the caller. This allows more complex paths to built from a series of calls to methods like this one.

Parameters

rPort	specifies target raster port.
gPort	is the target graphic port.
sourceToUserMatrix
handleLocation	is the location of the marker in source coordinates.
size	is the pixel size of the marker.
doFloor	is true if fractional pixel is clipped.

virtual void IGraphicsUtils::CreateAnchorRectPaths	(	IRasterPort *	rPort,
		IGraphicsPort *	gPort,
		const PMRect &	theRect,
		const PMReal &	size,
		bool16	doFloor
	)

pure virtual

Create a path for a rectangle's 8 anchor points in the port. The function converts to destination coords using rPort and draws the path using gPort.

Parameters

rPort	specifies target raster port.
gPort	is the target graphic port.
theRect	is the rectangle for which the anchor points are to be generated.
size	is the pixel size of the marker.
doFloor	is true if fractional pixel is clipped.

virtual void IGraphicsUtils::CreateAnchorRectPaths_UserCoords	(	IRasterPort *	rPort,
		IGraphicsPort *	gPort,
		const PMMatrix &	sourceToUserMatrix,
		const PMRect &	sourceRect,
		const PMReal &	size,
		bool16	doFloor = `kTrue`
	)

pure virtual

Create a path for a rectangle's 8 anchor points in the port. The function assumes rPort coords have already been set to it's native user coords (identity CTM), and will be reset by the caller. This allows more complex paths to built from a series of calls to methods like this one.

Parameters

rPort	specifies target raster port.
gPort	is the target graphic port.
sourceRect	is the rectangle, in source coordinates, for which the anchor points are to be generated.
size	is the pixel size of the marker.
doFloor	is true if fractional pixel is clipped.

virtual void IGraphicsUtils::CreateDirectionPointPath	(	IRasterPort *	rPort,
		IGraphicsPort *	gPort,
		const PMPoint &	handleLocation
	)

pure virtual

Create a direction point path marker in the port.

The function converts to destination coords using rPort and draws the path using gPort.

Parameters

rPort	specifies target raster port.
gPort	is the target graphic port.
handleLocation	is the location of the marker in source coordinates.

virtual void IGraphicsUtils::CreateDirectionPointPath_UserCoords	(	IRasterPort *	rPort,
		IGraphicsPort *	gPort,
		const PMMatrix &	sourceToUserMatrix,
		const PMPoint &	handleLocation
	)

pure virtual

Create a direction point path marker in the port.

The function assumes rPort coords have already been set to it's native user coords (identity CTM), and will be reset by the caller. This allows more complex paths to built from a series of calls to methods like this one.

Parameters

rPort	specifies target raster port.
gPort	is the target graphic port.
handleLocation	is the location of the marker in source coordinates.

virtual void IGraphicsUtils::CreateTextLinkPath	(	IRasterPort *	rPort,
		IGraphicsPort *	gPort,
		const PMPoint &	handleLocation,
		bool16	bVerticalOrientation = `kFalse`,
		bool16	bRightToLeftOrientation = `kFalse`
	)

pure virtual

Create a text link triangle marker. The function converts to destination coords using rPort and draws the path using gPort.

Parameters

rPort	specifies target raster port.
gPort	is the target graphic port.
handleLocation	is the location of the link marker in source coordinates.
bVerticalOrientation	is true if drawn vertically.

virtual void IGraphicsUtils::CreateTextOversetPath	(	IRasterPort *	rPort,
		IGraphicsPort *	gPort,
		const PMPoint &	handleLocation,
		bool16	drawSelected = `kTrue`
	)

pure virtual

Create an overset "plus" marker. The function converts to destination coords using rPort and draws the path using gPort.

Parameters

rPort	specifies target raster port.
gPort	is the target graphic port.
handleLocation	is the location of the overset marker in source coordiate.
drawSelected	is true if the overset marker is to be drawn.

virtual PMRect IGraphicsUtils::GetUpdateClipRect ( GraphicsData * gd )

pure virtual

Return the bounding box of the clip/update rect for the specified GraphicsData.

Parameters

gd	is the graphics data.

Returns: the bounding box of the clip or update rect.

virtual IColorSpaceMgr* IGraphicsUtils::QueryDefaultColorSpaceMgr ( )

pure virtual

Return the default color space manager servic.

virtual bool8 IGraphicsUtils::SetupRasterPort ( IRasterPort * rPort )

pure virtual

Setup the rasterport by calling all RasterSetup service providers.

Parameters

rPort is the raster to setup.

Returns: kTrue is rasterport is setup successfully.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation