IPathEndStroker.h

//========================================================================================
// 
// $File$
// 
// Owner: jargast
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// Defines the interface for end cap drawing.
// 
//========================================================================================

#ifndef __IPathEndStroker__
#define __IPathEndStroker__

#include "IPMUnknown.h"
#include "GraphicsID.h"
#include "RequestContext.h"

class IGraphicsPort;
class PMRect;
class PMPoint;
class IGraphicStyleDescriptor;
class PMMatrix;
class PMString;
class PMPathPoint;

class IPathEndStroker : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPATHENDSTROKER };

 enum PathEndLocation
 {
 kPathEndAtNeitherEnd = 0, 
 kPathEndAtEnd = 1, 
 kPathEndAtStart = 2, 
 kPathEndAtBothEnds = 3
 }; 

 virtual void StrokeLineToPathEnd
 (
 IGraphicStyleDescriptor* styleDescriptor, 
 int32 endLocation,
 const PMPoint& startPt,
 const PMPoint& endPt,
 IGraphicsPort* gPort
 ) const = 0;
 
 virtual bool16 InLineToPathEnd
 (
 IGraphicStyleDescriptor* styleDescriptor, 
 int32 endLocation,
 const PMPoint& startPt,
 const PMPoint& endPt,
 const PMRect& r, 
 IGraphicsPort* gPort
 ) const = 0;

 virtual PMRect GetLineToPathEndBBox
 (
 IGraphicStyleDescriptor* styleDescriptor, 
 int32 endLocation,
 const PMPoint& startPt,
 const PMPoint& endPt,
 const PMMatrix& matrix
 ) const = 0;

 virtual void StrokeCurveToPathEnd
 (
 IGraphicStyleDescriptor* styleDescriptor, 
 int32 endLocation,
 const PMPoint& P0,
 const PMPoint& P1,
 const PMPoint& P2,
 const PMPoint& P3,
 IGraphicsPort* gPort
 ) const = 0;
 

 virtual bool16 InCurveToPathEnd
 (
 IGraphicStyleDescriptor* styleDescriptor, 
 int32 endLocation,
 const PMPoint& P0,
 const PMPoint& P1,
 const PMPoint& P2,
 const PMPoint& P3,
 const PMRect& r, 
 IGraphicsPort* gPort
 ) const = 0;

 virtual PMRect GetCurveToPathEndBBox
 (
 IGraphicStyleDescriptor* styleDescriptor, 
 int32 endLocation,
 const PMPoint& P0,
 const PMPoint& P1,
 const PMPoint& P2,
 const PMPoint& P3,
 const PMMatrix& matrix
 ) const = 0;

 virtual PMPathPoint StrokePathEndAdjust
 (
 const PMPathPoint& pt0, 
 const PMPathPoint& pt1, 
 IGraphicStyleDescriptor* styleDescriptor, 
 int32 endLocation
 ) const = 0;

 virtual void GetPathEndName
 (
 PMString* pathendName
 ) const = 0;

 virtual void StrokeLineToPathEndForUI
 (
 int32 endLocation,
 const PMPoint& startPt,
 const PMPoint& endPt,
 IGraphicsPort* gPort,
 const PMReal& strokeWidth,
 PMReal arrowHeadScale
 ) const = 0;

 virtual void CreateLineEndPath
 (
 int32 endLocation,
 const PMPoint& startPt,
 const PMPoint& endPt,
 IGraphicsPort* gPort,
 const PMReal& strokeWidth,
 PMReal arrowHeadScale
 ) const = 0;

 virtual ScriptID GetScriptID( const ScriptInfo::RequestContext& context ) const = 0;
};

#endif