CPanorama.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 __CPANORAMA__
#define __CPANORAMA__

#include "IPanorama.h"
#include "HelperInterface.h"

#ifdef WIDGET_BUILD
#endif



class CTransform;

class CPanorama : public IPanorama
{
// ----- Constructors/destructors
public:
 CPanorama( IPMUnknown *boss, bool16 push_changes_into_drover = kFalse);
 virtual ~CPanorama();

public:

 //virtual PMRect GetBounds() const = 0;


 virtual PMRect GetCentralBounds() const;


 virtual PMReal GetCentralBorderWhiteSpace() const;


 virtual void SetPrimaryPanorama(IPanorama* panorama);


 virtual IPanorama* GetPrimaryPanorama() const;


 virtual void GetPanoramaDelta(PMPoint& delta) const;


 virtual void GetPanoramaDeltaMultiple(PMPoint& delta) const;
 

public:
 virtual void ScrollViewCenterTo(const PBPMPoint& newCenter, bool16 bForceRedraw = kTrue);


 virtual PBPMPoint ScrollTo_neg(const PBPMPoint& to, bool16 forceRedraw = kTrue, SysRgn InvalRgnCopy = nil);


 virtual PBPMPoint ScrollBy(const PBPMPoint& by, bool16 bForceRedraw = kTrue, SysRgn InvalRgnCopy = nil);


 virtual PMPoint GetAutoScrollDelta(const PBPMPoint& viewPoint);


 virtual PMPoint GetViewCenter() const;


 virtual PMPoint GetScrollOffset_neg() const;



public:
 
 virtual void ScalePanorama(const PMReal& xFactor, const PMReal& yFactor);

 virtual void ScalePanoramaBy(const PMReal& xBy, const PMReal& yBy);
 
 virtual PMReal GetXScaleFactor(bool32 actualZoomLevelInsteadOfUIZoomWidgetValue = kTrue) const;

 virtual PMReal GetYScaleFactor(bool32 actualZoomLevelInsteadOfUIZoomWidgetValue = kTrue) const;
 
 virtual PMReal GetPreviousScaleFactor() const;

 virtual void SetPreviousScaleFactor(PMReal scaleFactor);

 virtual PMPoint GetPreviousViewCenter() const;
 
 virtual PMReal GetMinScaleFactor() const;

 virtual PMReal GetMaxScaleFactor() const;

 virtual PMPoint GetViewScrollOffset() const;

 virtual void SetScrollOffset_neg(PMPoint scrollBy);



public:
 virtual void FitInView();

 virtual void FullView();


public:
 virtual void UpdatePanoramaTransform(PMMatrix* transform) const;





public:
 virtual void SavePerspective() const;

 virtual void RestorePerspective();

 virtual void ScrollViewEdgeTo(const EdgeSpec& edgeSpec, const PBPMPoint& newCenter, bool16 bForceRedraw);

protected:


 virtual PMReal GetScaleToShowRect(const PMRect& r, const PMReal& whiteSpace) const;

 virtual void DoNotify(ClassID messageID, const PanoramaUpdateParams& params) const;

 virtual void GetBoundsForAutoScroll(PMRect&) const;
 
 virtual PBPMPoint ConstrainTo(const PBPMPoint& value) const;

 virtual PBPMPoint ConstrainBy(const PBPMPoint& delta) const;

 virtual SysRgn SystemScroll(const SysPoint& sysDelta, bool16 bDoInval, GSysRect *bbox);


// ----- Object state
private:
 PMReal fXScaleFactor; //zooming in increases these scale factors. That is, fXScaleFactor > 1 <==> 1 unit in content coordinates takes up more that 1 unit in frame coordinates 
 PMReal fYScaleFactor;
 PMReal fPreviousScaleFactor;
 PMPoint fPreviousViewCenter;
 PMReal fMinScaleFactor; // Min and max allowable scale factor
 PMReal fMaxScaleFactor;
 PMPoint fScrollOffset; //fScrollOffset is the location of the content origin in frame coordinates
 bool16 fPushPanoramaChangesIntoDrover;
 
 IPanorama* fPrimaryPanorama;

 void DroverPreScroll();
 void DroverPostScroll();

 virtual PBPMPoint ScrollTo_(const PBPMPoint& to, bool16 forceRedraw, SysRgn InvalRgnCopy);
 virtual PBPMPoint ScrollBy_(const PBPMPoint& by, bool16 bForceRedraw, SysRgn InvalRgnCopy);
 virtual void SetScrollOffset_( PMPoint scrollBy);
 virtual void ScalePanorama_( const PMReal& xFactor, const PMReal& yFactor);

protected:
 PMPoint GetNearestValueBasedOnScaleFactor(PMPoint scrollDelta);


};


#endif