IDrawMgr.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:
// This serves as a bottleneck interface for all drawing, both display and printing.
// For more information, see the DrawMgr paper
// 
//========================================================================================

#ifndef __IDrawMgr__
#define __IDrawMgr__

#include "GraphicsID.h"
#include "PMRect.h"
#include "PMMatrix.h"
#include "UIDList.h"
#include "HitTestDragConstants.h"
#include "IShape.h"

class IGraphicsContext;
class DrawInterrupter;
class DrawFilter;
class ICallback;
class IDVPlatformOffscreen;

#include "DVAForwardDeclarations.h"

class IDrawMgr: public IPMUnknown
{
 public:
 enum {kDefaultIID = IID_IDRAWMGR};

 virtual void BeginInterruptableDraw(DrawInterrupter* interruptChecker = nil) = 0;

 virtual void EndInterruptableDraw() = 0;

 virtual void EnableInterruptableDraw(bool16 enable = kTrue) = 0;

 virtual void DisableInterruptableDraw() = 0;

 virtual bool16 IsDrawingInterruptable() = 0;

 virtual void Abort() = 0;
 
 virtual bool16 DrawAtOnce(IGraphicsContext* gc, const UIDRef& thing, int32 flags) = 0; //perhaps name DrawNow
 
 virtual bool16 DrawIncrementallyUsingDrawbot(
 IGraphicsContext * gc, 
 const UIDRef & thing, 
 int32 flags,
 IDVPlatformOffscreen * srcOffscreen, 
 dvaui::drawbot::Drawbot * dstDrawbot,
 SysRect updateBounds, 
 int32 tickCount) = 0;
 
 virtual void BeginCullToViewRect(const PMRect& r) = 0;
 virtual void BeginCullToViewRegion(const SysRgn& rgn) = 0;

 virtual bool16 EndLatestViewSpaceCulling() = 0;

 virtual SysRgn GetViewCullRegion() const = 0;



 virtual uint32 GetSpreadFilterCount() const = 0;

 virtual uint32 BeginFilterToSpreadRect( const PMRect& r, const PMMatrix& m = PMMatrix(1.,0.,0.,1.,0.,0.), const PMMatrix& rest = PMMatrix(0.,0.,0.,0.,0.,0.)) = 0;
 virtual uint32 EndFilterToSpreadRect( PMRect* r = nil, PMMatrix* m = nil, PMMatrix* rest = nil) = 0;
 struct FilterInfo
 {
 FilterInfo( const PMRect& r, const PMMatrix& m, const PMMatrix& rest) : fFilterRect(r), fFilterMatrix(m), fRestMatrix(rest) {}
 PMRect fFilterRect;
 PMMatrix fFilterMatrix;
 PMMatrix fRestMatrix;
 };
 virtual FilterInfo GetNthSpreadFilter( uint32 which) const = 0;

 virtual bool16 IsDrawAborted() = 0;

 virtual bool16 IsDrawClipped( IPMUnknown *thing, const PMMatrix* pb2view) = 0; //IGraphicsContext* gc) = 0;

 virtual bool16 BeginShape(IPMUnknown *theShape) = 0;

 virtual void EndShape(IPMUnknown *theShape) = 0;

 virtual void FlushOffscreenIfNecessary() = 0;
 
 virtual void Disable (UID item, bool16 disable) = 0;

 virtual bool16 IsItemDisabled (UID item) const = 0;
 
 virtual bool16 WasDrawAborted() const = 0;

 virtual void ClearAborted() = 0;
 

 virtual void IterateDrawOrder_ (const PMMatrix *xform, const UIDRef &thing, ICallback *callbackInfo, int32 flags) = 0;
 
 void IterateDrawOrder( const UIDRef &thing, ICallback *callbackInfo, int32 flags)
 {
 PMMatrix identity;
 IterateDrawOrder_( &identity, thing, callbackInfo, flags);
 }
 
 virtual bool16 DisableClippingOrFiltering() = 0;

 virtual void EnableClippingOrFiltering() = 0;

 class ClippingOrFilteringDisabler
 {
 public:
 ClippingOrFilteringDisabler(IDrawMgr* drawMgr) :
 fDrawMgr(drawMgr),
 fWasEnabled(drawMgr && drawMgr->DisableClippingOrFiltering())
 { }

 ~ClippingOrFilteringDisabler()
 {
 if (fWasEnabled)
 fDrawMgr->EnableClippingOrFiltering();
 }

 private:
 IDrawMgr* fDrawMgr;
 const bool16 fWasEnabled;
 };

};
#endif