AGMGraphicsContextWith.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael Burbidge
// 
// $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.
// 
//========================================================================================

#ifndef __AGMGraphicsContextWith__
#define __AGMGraphicsContextWith__

#include "IGraphicsContext.h"
#include "AcquireViewPort.h"
#include "K2Assert.h"
#include "IDVOffscreenPortData.h"

class IControlView;
class IViewPort;
class ITransform;
class IGraphicsContext;
class PMMatrix;

template <class AcquireCoordSys, class AcquireClip>
class AGMGraphicsContextWith : public IGraphicsContext
{
public:

 // ----- Initialization -----

#if 0 // OBSOLETE

 AGMGraphicsContextWith(IControlView *controlView, SysRgn clipRgn = nil);
#endif

 AGMGraphicsContextWith(IViewPort* viewPort, IControlView *controlView, SysRgn clipRgn = nil);

 AGMGraphicsContextWith(IViewPort* viewPort, ITransform* xform = nil, SysRgn clipRgn = nil);
 
 AGMGraphicsContextWith(IViewPort* viewPort, const PMMatrix& theMatrix, SysRgn clipRgn = nil);

 AGMGraphicsContextWith(IViewPort* viewPort, const PMMatrix& theMatrix, IControlView *controlView, SysRgn clipRgn = nil);

 AGMGraphicsContextWith(IViewPort* viewPort, ITransform* xform, IControlView *controlView, SysRgn clipRgn = nil);
 
 virtual ~AGMGraphicsContextWith();

 // ----- Clipping -----
 
 virtual SysRgn GetClip() const;
 
 virtual SysRgn GetOriginAdjustedClip() const;

 // ----- Accessors -----
 
 virtual SysPort GetSysPort() const;
 
 virtual IViewPort* GetViewPort() const;
 
 virtual const PMMatrix& GetContentToViewTransform() const;

 virtual const PMMatrix& GetViewToContentTransform() const;
 
 virtual IControlView* GetView() const;

 bool16 IsCurrent() const;

 virtual dvaui::drawbot::Drawbot* GetDrawbot() const
 {
 InterfacePtr<IDVOffscreenPortData> offscreenPortData(this->GetViewPort(), IID_IDVOFFSCREENPORTDATA);
 if(offscreenPortData)
 {
 return offscreenPortData->GetDrawbot();
 }
 return NULL;
 }

private:

 // ----- Data fields -----
 
 // ----- Order is important. We need to acquire the view port, followed by the coordinate
 // system followed by the clip. [amb]
 
 InterfacePtr<IViewPort> fVP;
 AcquireViewPort fAcquireVP;
 AcquireCoordSys fAcquireCoordSys;
 AcquireClip fAcquireClip;
};

template <class AcquireCoordSys, class AcquireClip>
inline SysRgn AGMGraphicsContextWith<AcquireCoordSys, AcquireClip>::GetClip() const
{
 return fAcquireClip.GetClip();
}

template <class AcquireCoordSys, class AcquireClip>
inline SysRgn AGMGraphicsContextWith<AcquireCoordSys, AcquireClip>::GetOriginAdjustedClip() const
{
 return fAcquireClip.GetOriginAdjustedClip();
}

template <class AcquireCoordSys, class AcquireClip>
inline SysPort AGMGraphicsContextWith<AcquireCoordSys, AcquireClip>::GetSysPort() const
{
 return nil;
}

template <class AcquireCoordSys, class AcquireClip>
inline IViewPort* AGMGraphicsContextWith<AcquireCoordSys, AcquireClip>::GetViewPort() const
{
 return fAcquireCoordSys.GetViewPort();
}

template <class AcquireCoordSys, class AcquireClip>
inline const PMMatrix& AGMGraphicsContextWith<AcquireCoordSys, AcquireClip>::GetContentToViewTransform() const
{
 return fAcquireCoordSys.GetTransform();
}

template <class AcquireCoordSys, class AcquireClip>
inline const PMMatrix& AGMGraphicsContextWith<AcquireCoordSys, AcquireClip>::GetViewToContentTransform() const
{
 return fAcquireCoordSys.GetInverseTransform();
}

template <class AcquireCoordSys, class AcquireClip>
inline IControlView* AGMGraphicsContextWith<AcquireCoordSys, AcquireClip>::GetView() const
{
 return fAcquireCoordSys.GetView();
}

#ifdef _INCLUDE_TPP_IN_H_
 #include "AGMGraphicsContextWith.tpp"
#endif //_INCLUDE_TPP_IN_H_
#ifdef WASM
 #include "AGMGraphicsContextWith.tpp"
#endif // WASM
#endif