IGraphicsPort.h

//========================================================================================
// 
// $File$
// 
// Owner: Jack Kirstein
// 
// $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.
// 
// 
// Purpose of interface
// IGraphicsPort is THE drawing API for Shuksan. It is a shell around
// the AGM API
// 
// The methods behave exactly, or very much like the equivalent PostScript operators.
// See the PostScript language reference manual for complete documentation
// 
// IMPORTANT: if you expect something to print, this is the ONLY interface you can use
// to do drawing
// 
//========================================================================================

#ifndef __IGRAPHICSPORT__
#define __IGRAPHICSPORT__

#include "GraphicsID.h"
//#include "GRConversions.h"
#include "PMMatrix.h"
#include "PMReal.h"
#include "PMRect.h"
#include "GraphicTypes.h"
#include "BravoForwardDecl.h"

class IFontInstance;
class IPMFont;
class IOPIInfo;
class IDrawMgr;
class PMRealGlyphPoint;

struct OneOTFeature;

#define __PORTSUPPORTSFIXED__ // The graphics port is moving from Fixed numbers to floats - this is here until we force it

class GPortAuxInfoParam
{
 public:
 enum AuxInfoObjectType
 {
 kNone,
 kImage,
 kTextFrame,
 kImageStream, // tagging only (no data)
 kText,
 kColor,
 kTextRun
 };

 inline GPortAuxInfoParam(): fObjType( kNone ), fOPIInfo(nil), fTextStart(0), fTextSpan(0), fTint(0.0) {}
 inline GPortAuxInfoParam( AuxInfoObjectType objType ) :
 fObjType(objType), fOPIInfo(nil), fTextStart(0), fTextSpan(0), fTint(0.0) {}

 inline void SetObjectType(AuxInfoObjectType bObjType) {fObjType = bObjType;}
 inline void GetObjectType(AuxInfoObjectType* bObjType) {*bObjType = fObjType;}
 inline AuxInfoObjectType GetObjectType() { return fObjType ; }

 inline void SetOPIInfo(IOPIInfo* bOPIInfo) {fOPIInfo = bOPIInfo;}
 inline void GetOPIInfo(IOPIInfo** bOPIInfo) {*bOPIInfo = fOPIInfo;}
 inline IOPIInfo* GetOPIInfo() { return fOPIInfo ; }

 inline void SetObjectRef( const UIDRef& obj ) { fObjRef = obj ; }
 inline const UIDRef& GetObjectRef() { return fObjRef ; }

 inline void SetTextStart( TextIndex start ) { fTextStart = start ; }
 inline TextIndex GetTextStart() { return fTextStart ; }

 inline void SetTextSpan( int32 span ) { fTextSpan = span ; }
 inline int32 GetTextSpan() { return fTextSpan ; }

 inline void SetTint( const PMReal& tint ) { fTint = tint ; }
 inline const PMReal& GetTint() { return fTint ; }

 private:
 AuxInfoObjectType fObjType;
 IOPIInfo* fOPIInfo;
 UIDRef fObjRef ;
 TextIndex fTextStart ;
 int32 fTextSpan ;
 PMReal fTint ;
};

class IGraphicsPort : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IGRAPHICSPORT };

 // Call this to initialize or re-initialize the port
 virtual void Setup() = 0;

 virtual void newpath() = 0;
 virtual void moveto(const PMReal& x, const PMReal& y) = 0;
 virtual void rmoveto(const PMReal& x, const PMReal& y) = 0;
 virtual void lineto(const PMReal& x, const PMReal& y) = 0;
 virtual void curveto(const PMReal& x1, const PMReal& y1, const PMReal& x2, const PMReal& y2, const PMReal& x3, const PMReal& y3) = 0;
 virtual void curvetov(const PMReal& x2, const PMReal& y2, const PMReal& x3, const PMReal& y3) = 0;
 virtual void closepath() = 0;
 virtual void gsave() = 0;
 virtual void grestore() = 0;
 virtual void translate(const PMReal& x, const PMReal& y) = 0;
 virtual void scale(const PMReal& x, const PMReal& y) = 0;
 virtual void rotate(const PMReal& theta) = 0;
 virtual void concat(const PMMatrix &m) = 0; //this is a PreConcat in PMMatrix terms
 virtual void setlinewidth(const PMReal& width) = 0;
 virtual void setdash(int32 numDash, float* dashArray, float offset) = 0;

 virtual void setblendingmode (PMBlendingMode pmBlendingMode) = 0;

 virtual void starttransparencygroup(const PMRect& bounds, AGMColorSpace *cs, bool16 isolationgroup = kTrue, bool16 knockoutgroup = kFalse) = 0;
 virtual void endtransparencygroup() = 0;

 virtual void BeginGroup( const PMString name, const_AIMDictionaryContainer* attrib ) = 0;

 virtual void EndGroup( const PMString name ) = 0;

 virtual void setopacity (const PMReal& opacity, bool16 bIsAlphaShape) = 0; // from 0 to 1.0

 virtual void setlinecap(int32 type) = 0;
 virtual void setlinejoin(int32 type) = 0;

 virtual void setmiterlimit(const PMReal& limit) = 0;
 virtual void setstrokeadjust(bool16 strokeAdjust) = 0;
 virtual void setgray(const PMReal& gray) = 0;
 virtual void setrgbcolor(const PMReal& r, const PMReal& g, const PMReal& b) = 0;
 virtual void setcmykcolor(const PMReal& c, const PMReal& m, const PMReal& y, const PMReal& k) = 0;
 virtual void setlabcolor(const PMReal& l, const PMReal& a, const PMReal& b) = 0;
 virtual void setcolorspace(AGMColorSpace* colorSpace) = 0;
 virtual void setcolorvalues(const float* colorVals) = 0;

 virtual void setgradient(AGMGradient *agmGrad, const PMMatrix& grMatrix,
 const PMReal &xOrig, const PMReal &yOrig,
 const PMReal &len, const PMReal &ang,
 const PMReal &hiliteLen, const PMReal &hiliteAng) = 0;
 virtual void SetColorServer(AGMPaint* agmPaint, bool16 bIsAlphaShape, const PMMatrix& m) = 0;
 virtual void SetAlphaServer(AGMPaint* agmPaint, bool16 bIsAlphaShape, const PMMatrix& m) = 0;

 virtual void setoverprint(bool32 overprint) = 0;
 virtual void fill() = 0;
 virtual void eofill() = 0;
 virtual void stroke() = 0;
 virtual void image(_t_AGMImageRecord* imageRec, const PMMatrix& imMatrix, int32 flags) = 0;
 virtual void image(_t_AGMImageRecord* imageRec, AGMColorSpace* cs, const PMMatrix& m, int32 flags) = 0;
 // This replaces old version which took an IagmServer_Image
 virtual void image(AGMImage *image, const PMMatrix& imMatrix, int32 flags) = 0;

 // Use the following constants for show and xshow
 typedef enum
 {
 kFillText = 1,
 kStrokeText = 2,
 kClipText = 4
 } TextGraphicsFlags;

 virtual void show(const PMReal &x, const PMReal &y, uint32 numUTF16s, const textchar* text,
 TextGraphicsFlags graphicsflags = kFillText,
 bool16 verticalGlyphs = kFalse, bool16 wmodePositioning = kFalse) = 0;
#ifdef __PORTSUPPORTSFIXED__
 virtual void xshow(const PMReal &x, const PMReal &y, uint32 numGlyphs, const int32 *glyphArray,
 const Fixed* widths, const Fixed* yoffsets = nil,
 TextGraphicsFlags graphicsflags = kFillText,
 bool16 verticalGlyphs = kFalse, bool16 wmodePositioning = kFalse,
 uint32 numChars = 0, const textchar* text = nil,
 K2Vector<OneOTFeature>* otFeatureArray = nil) = 0;
#endif
 virtual void xshow(const PMReal &x, const PMReal &y, uint32 numGlyphs, const int32 *glyphArray,
 const float* widths, const float* yoffsets = nil,
 TextGraphicsFlags graphicsflags = kFillText,
 bool16 verticalGlyphs = kFalse, bool16 wmodePositioning = kFalse,
 uint32 numChars = 0, const textchar* text = nil,
 K2Vector<OneOTFeature>* otFeatureArray = nil) = 0;

 virtual void ctshow(IFontInstance *fontInstance,
 PMRealGlyphPoint *glyphPoints, uint32 numGlyphPoints,
 TextGraphicsFlags graphicsflags = kFillText,
 bool16 verticalGlyphs = kFalse) = 0;

 // xshow() and ctshow() take the optional parameters of numChars and text. These
 // are needed to include searchable text in Export PDF. They are ignored by most
 // other implementations.
 // verticalGlyphs = kTrue means to use the vertical variants even if the CMap is -H.
 // verticalGlyphs = kFalse means to use the horizontal variants.
 // wmodePositioning = kTrue means vertical text with the implication that the supplied character
 //positions are based on PostScript's vertical WMode; that is, vertical text with origin at
 //the top center of the glyph. Set this to kTrue if your text will be imaged vertically by
 //AGM or PostScript AND if the text positioning was determined by something other than
 //InDesign's composition engine. Examples of proper uses of wmodePosition = kTrue:
 //Vertical text in the UI or a placed EPS.
 // wmodePositioning = kFalse means that the supplied character positions are referred to the Roman
 //baseline. Set wmodePositioning to kFalse if InDesign's text composition engine layed out your
 //text, whether the text is intended to be vertical or horizontal.
 virtual void selectfont(IPMFont *font, const PMMatrix& m) = 0;
 virtual void selectfont(IPMFont *font, const PMReal& ptSize) = 0;
 virtual void clip() = 0;
 virtual void eoclip() = 0;
 virtual void strokepath_clip() = 0;
 virtual void rectclip(const PMReal& x, const PMReal& y, const PMReal& width, const PMReal& height) = 0;
 virtual void rectclip(const PMRect &r) = 0;
 virtual void rectfill(const PMReal& x, const PMReal& y, const PMReal& width, const PMReal& height) = 0;
 virtual void rectfill(const PMRect &r) = 0;
 virtual void rectstroke(const PMReal& x, const PMReal& y, const PMReal& width, const PMReal& height) = 0;
 virtual void rectstroke(const PMRect &r) = 0;
 virtual void rectpath(const PMReal& x, const PMReal& y, const PMReal& width, const PMReal& height) = 0;
 virtual void rectpath(const PMRect &r) = 0;
 virtual void shadingfill(AGMPaint* paint) = 0;

 virtual void AddComment(int32 comment, void *commentData, int32 length) = 0;

 // Return a reference to the port's draw manager instance.
 // Subclasses typically will have a draw manager concrete class as a data member, though details of
 // its construction and deployment are up to the class.
 virtual IDrawMgr *PortDrawMgr() = 0;

 // The following is only meant to pass auxiliary information, for a group of identical
 // graphical entities. It has a paired methods, for Begin/End context.
 // If a port does not support these methods, it should provide an empty stub.
 // A client of a port could take advantage of these methods to pass additional information
 // onto the port, where the port could simply punt the information, or use it to create
 // a more advanced representations of the graphical objects.
 virtual void BeginAuxInfoContext(GPortAuxInfoParam* auxInfoParam) = 0;
 virtual void EndAuxInfoContext(GPortAuxInfoParam* auxInfoParam) = 0;

 // Show method to match AGM. This is used to include searchable text in Export PDF.
 virtual void show( const CCTTextList& textList, int32 flags, const PMMatrix* matrix = 0 ) const = 0;

 typedef enum { kPerceptual, kSaturation, kRelative, kAbsolute } RenderingIntent;

 virtual void SetRenderingIntent(RenderingIntent intent) = 0;

 virtual void SetOverPrintMode(bool32 mode) = 0;
 
 virtual void FillPath(AGMPath *path) = 0;
 
 virtual void StrokePath(AGMPath *path) = 0;

 virtual void ClipPath(AGMPath *path) = 0;
};

#endif