IPanorama.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 __IPANORAMA__
#define __IPANORAMA__

#include "PMReal.h"
#include "PMRect.h"
#include "widgetid.h"


class PMMatrix;


class EdgeSpec
{
public:
 enum Edge { kLeft, kTop, kRight, kBottom, kNone };
 
 EdgeSpec(Edge horizontal = kNone, Edge vertical = kNone) :
 fHorizontal(horizontal),
 fVertical(vertical)
 {
 }

 Edge fHorizontal, fVertical;
};



//========================================================================================
// CLASS IPanorama
//========================================================================================

class IPanorama : public IPMUnknown
{
// ----- Message Ids
public:
 enum { kDefaultIID = IID_IPANORAMA };

public:
 virtual PMRect GetBounds() const = 0;


 virtual PMRect GetCentralBounds() const = 0;
 
 
 virtual PMReal GetCentralBorderWhiteSpace() const = 0;
 
 
 virtual void SetPrimaryPanorama(IPanorama* panorama) = 0;


 virtual IPanorama* GetPrimaryPanorama() const = 0;


 virtual void GetPanoramaDelta(PMPoint& delta) const = 0;


 virtual void GetPanoramaDeltaMultiple(PMPoint& delta) const = 0;


public:
 inline void ScrollContentLocationToFrameCenter( const PBPMPoint& contentLocation, bool16 bForceRedraw = kTrue)
 {
 ScrollViewCenterTo( contentLocation, bForceRedraw);
 }


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


 inline PBPMPoint ScrollContentLocationToFrameOrigin( const PBPMPoint& contentLocation, bool16 forceRedraw = kTrue, SysRgn InvalRgnCopy = nil)
 {
 return ScrollTo_neg( -contentLocation, forceRedraw, InvalRgnCopy);
 }


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


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


 virtual PMPoint GetAutoScrollDelta(const PBPMPoint& viewPoint) = 0;


 inline PMPoint GetContentLocationAtFrameOrigin()
 {
 return -GetScrollOffset_neg();
 }

 virtual PMPoint GetScrollOffset_neg() const = 0;


 inline PMPoint GetContentLocationAtFrameCenter()
 {
 return GetViewCenter();
 }

 
 virtual PMPoint GetViewCenter() const = 0;




public:

 virtual void ScalePanorama(const PMReal& xFactor, const PMReal& yFactor) = 0;


 virtual void ScalePanoramaBy(const PMReal& xBy, const PMReal& yBy) = 0;


 virtual PMReal GetXScaleFactor(bool32 actualZoomLevelInsteadOfUIZoomWidgetValue = kTrue) const = 0;
 
 virtual PMReal GetYScaleFactor(bool32 actualZoomLevelInsteadOfUIZoomWidgetValue = kTrue) const = 0;


 virtual PMReal GetPreviousScaleFactor() const = 0;


 virtual void SetPreviousScaleFactor(PMReal scaleFactor) = 0;


 virtual PMPoint GetPreviousViewCenter() const = 0;


 virtual PMReal GetMinScaleFactor() const = 0;


 virtual PMReal GetMaxScaleFactor() const = 0;




public:
 virtual void FitInView() = 0;

 virtual void FullView() = 0;


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



public:
 virtual void SavePerspective() const = 0;

 virtual void RestorePerspective() = 0;

 virtual void ScrollViewEdgeTo(const EdgeSpec& edgeSpec, const PBPMPoint& pt, bool16 bForceRedraw = kTrue) = 0;
};





//========================================================================================
// class PanoramaUpdateParams
//========================================================================================
class PanoramaUpdateParams
{
public:
 PanoramaUpdateParams(IPanorama* panorama, const PMPoint& offset) :
 fPanorama(panorama),
 fOffset(offset),
 fXScaleFactor(1.0),
 fYScaleFactor(1.0)
 {
 }
 
 PanoramaUpdateParams(IPanorama* panorama, const PMReal& xScaleFactor, const PMReal& yScaleFactor) :
 fPanorama(panorama),
 fXScaleFactor(xScaleFactor),
 fYScaleFactor(yScaleFactor)
 {
 }
 
 IPanorama* fPanorama;
 PMPoint fOffset;
 PMReal fXScaleFactor;
 PMReal fYScaleFactor;
};

#endif