CSprite.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.
// 
//========================================================================================

#ifndef __CSprite__
#define __CSprite__

#include "ISprite.h"
#include "ICallback.h"

#include "PMPoint.h"
#include "PMRect.h"
#include "HelperInterface.h"
#include "PMMatrix.h"
#include "IColorData.h"

class IDVOffscreenPortData;
class IGraphicsPort;
class IHandleShape;
class ISpread;
class SpriteAGMStream;
class UIDList;
class ILayoutRenderer;

//---------------------------------------------------------------
// static functions
//---------------------------------------------------------------

inline bool16 IsPatientUser (int32 flags);
inline bool16 IsPatientUser (int32 flags)
{
 return flags & IShape::kPatientUser;
}

//---------------------------------------------------------------
// static functions
//---------------------------------------------------------------

inline bool16 IsDynamicPause (int32 flags);
inline bool16 IsDynamicPause (int32 flags)
{
 return (flags & IShape::kPatientUser && flags & IShape::kDynamicPause);
}

class CSprite : public ISprite
{
public:
 CSprite(IPMUnknown *boss);

 virtual ~CSprite();

 virtual bool16 CreateSprite(IGraphicsContext* gc, UIDList* itemList, const PMPoint& startPt, bool16 bDrawItemList);
 
 virtual void DestroySprite(IGraphicsContext* gc);

 virtual bool16 Show(IGraphicsContext* gc, const PMPoint& where, int32 flags, PMMatrix* xForm);

 virtual bool16 Scroll(IGraphicsContext* gc, const PMPoint& delta, int32 flags, PMMatrix* xForm);

 virtual void Erase(IGraphicsContext* gc, const PMPoint& where, int32 flags, PMMatrix* xForm);

 virtual void Hide(IGraphicsContext* gc, bool16 bForceRedraw, PMMatrix* extraXform);

 virtual void InvalidateBBox();

 virtual void DisableShapes (IGraphicsContext *gc, bool16 disable);

 virtual SysRect GetDeviceBounds (IGraphicsContext* gc, int32 flags, PMMatrix* xForm);

 virtual bool16 ValidSprite() const
 {
 return fValidSprite;
 };

 virtual bool16 NeedsUpdate(const PMPoint& where, int32 flags) const
 {
 // #2910574 - we added a timer to DrawSprite to limit recomposition frequency.
 // However if mouse moves before timer elapses this will return true and we'll
 // continually redraw with no further movement until the timer elapses. This is
 // a major hit on drag performance. So we don't signal we need to update until the mouse moves.
 // #3112261 - we now allow the sprite to recompose and update one extra time when the
 // composition interval is reached.
 return (IsPatientUser (flags) &&
 ((where != fCurrentPoint) ||
 (where != fLastCompositionPoint && (SystemUtils::TickCount() - fLastCompositionTicks > kSubsequentCompositionThreshold))));
 }
 
protected: 
 virtual void DisableHandleShapes(IGraphicsContext *gc, bool16 disable);

 virtual PMRect GetShapeDeviceBounds(IGraphicsContext* gc, int32 flags);

 virtual PMRect GetHandleDeviceBounds(IGraphicsContext* gc, int32 flags, PMMatrix* xForm);

 virtual PMRect GetTrackerBounds(IGraphicsContext* gc, int32 flags);

 virtual PMRect GetSelectionBounds(IGraphicsContext* gc);
 
 virtual void DrawTrackerExtra(IGraphicsContext* gc, int32 flags);

 virtual void ShowFirstTime(IGraphicsContext* gc, const PMPoint& where, int32 flags, PMMatrix* xForm);

 virtual void ShowSprite(IGraphicsContext* gc, const PMPoint& where, int32 flags, PMMatrix* xForm);

 virtual void ScrollSprite(IGraphicsContext* gc, const PMPoint& delta, int32 flags, PMMatrix* xForm);

 virtual void ShowLowMemory(IGraphicsContext* gc, const PMPoint& where, int32 flags, PMMatrix* xForm);

 virtual void ShowLowMemoryFirstTime(IGraphicsContext* gc, const PMPoint& where, int32 flags, PMMatrix* xForm);
 
 virtual void ScrollLowMemory(IGraphicsContext* gc, const PMPoint& delta, int32 flags, PMMatrix* xForm);

 virtual void HideSprite(IGraphicsContext* gc, bool16 bForceRedraw, PMMatrix* extraXform);

 virtual void HideLowMemory(IGraphicsContext* gc, bool16 bForceRedraw, PMMatrix* extraXform);

 virtual void EraseAndRedrawShapes(IGraphicsContext* gc, const PMPoint& where, int32 flags, PMMatrix* xForm);
 
 virtual void SetHiliteColor (UID layerUID);
 
 virtual void DrawShapes (IGraphicsContext* gc, SysRgn clipRgn = nil, bool16 bDisable = kFalse);

 virtual void DrawSelection (IGraphicsContext* gc);

 virtual void DrawSpriteShapes(IGraphicsContext* gc, int32 flags);
 
 virtual void DrawSpriteHandles(IGraphicsContext* gc, int32 flags, PMMatrix* xForm);

 virtual void CreateTrackerPaths(IGraphicsContext* gc);
 
 virtual void CreateHandlePaths(IGraphicsContext* gc, bool16 bDoDirectionHandles = kTrue);
 
 virtual void ClipToView(IGraphicsContext* gc, SysRect* bounds);

 virtual void ClipToView(IGraphicsContext* gc, PMRect& bounds);

 virtual PMRect GetStandOffBBox( IShape *pShape, IGraphicsContext *gc, int32 flags, const PMRect &bBox );
 
 virtual int32 GetDrawFlags() const;
 
 virtual bool16 UseDisplayList (int32 flags);
 
 void AddInvalidOffscreenBounds (IControlView* iView, PMRect* invalidBounds);
 
 void AddInvalidLayoutBounds (IControlView* iView, PMRect* invalidBounds);

 static void DrawCenterX( IGraphicsPort* gPort, const PBPMPoint& center ) ;

 void DrawSmartGuides(IGraphicsContext *gc, const PBPMPoint where, const PMMatrix *xForm);

 PMMatrix fXformFromLastShow;
 SysRect fLastBounds;
 ColorArray fRGBColorValue;
 PMPoint fStartPoint;
 PMPoint fCurrentPoint;
 SysPoint fLastMouseLoc;

 IControlView* fControlView;
 UIDList* fItemList;
 IDVOffscreenPortData* fBackgroundVP;
 IDVOffscreenPortData* fForegroundVP;
 IDataBase* fDataBase;

 int32 fDrawFlags;

 bool16 fValidDeviceBounds;

 bool16 fFirstTime;
 bool16 fValidSprite;
 bool16 fLowMemory;
 bool16 fIsFrontView;

 
 bool16 fDrawItemList;
 bool16 fIsPathSelection;
 bool16 fHandlesDisabled;
 
 bool16 fDoRevealAllImageData;
 bool16 fSmartGuidesDrawn;
 bool16 fDrawSmartGuides;

private:
 //-------------------------------------------------------------------------------

 void DrawBackgroundFirstTime (IGraphicsContext* gc); 
 
 void CreateItemDisplayList (IGraphicsContext* gc, int32 flags);
 
 UIDRef GetPageGuideColor();
 UIDRef GetSmartGuideColor();
 
 void CreateTimer();
 void CleanupTimer();

 void DrawSelectionPort(ILayoutRenderer* renderer, SysRgn updateRgn, const PMPoint& where, int32 flags, PMMatrix* xForm);
 void DrawSpriteGfx(IGraphicsContext* oc, const PMPoint& where, int32 flags, PMMatrix* xForm);

 PMMatrix fOriginalMat;
 PMMatrix fLastMatrix;
 PMRect fHandleDeviceBounds;
 PMRect fLastShapeDeviceBounds;
 PMPoint fLastCompositionPoint;
 UIDRef fSmartGuideColor;
 UIDRef fPageGuideColor;
 SpriteAGMStream* fAGMStream;
 void* fItemDLPort;
 uint32 fStartTicks;
 uint32 fLastCompositionTicks;
 bool16 fUseDisplayList;

#ifdef DEBUG
public:
 bool16 gDebugDontUseOffscreen;
#endif



};

class FindMasterItemsIterator : public ICallback
{ 
public: 
 FindMasterItemsIterator(const ISpread *drawingSpread, UIDList *masterItemsFound, const UIDList *candidates, PMMatrixCollection *masterInner2DrawingSpreadPBList); 
 
 virtual void ExecuteCallback(const PMMatrix *xform, IPMUnknown *iThing, int32 flags);
 
 virtual int32 IterateChildren();
 
 virtual IDrawMgr* GetCallbackDrawManager();

private: 
 const ISpread* fSpread; 
 IDrawMgr* fDrawMgr; 
 UIDList *fVisibleMasterItems; 
 const UIDList* fCandidates;
 PMMatrixCollection *fMatrices;
 bool fMasterItemsDone;
}; 

#ifdef DEBUG
 void ToggleDebugSpriteLowMem();
#endif

#endif