ISprite.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:
// ISprite defines how to draw and manipulate objects dynamically.
// 
//========================================================================================

#ifndef __ISprite__
#define __ISprite__

#include "IPMUnknown.h"
#include "GraphicsID.h"

#include "PMReal.h"
#include "IShape.h"

class UIDList;
class PMRect;
class PMMatrix;

class ISprite : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISPRITE };

 virtual bool16 CreateSprite(IGraphicsContext* gc, UIDList* itemList, const PMPoint& startPt, bool16 bDrawItems = kTrue) = 0;

 virtual void DestroySprite(IGraphicsContext* gc) = 0;
 
 virtual void DisableShapes (IGraphicsContext* gc, bool16 disable) = 0;
 
 virtual bool16 Show(IGraphicsContext* gc, const PMPoint& where, int32 flags, PMMatrix* xForm = nil) = 0;
 
 virtual bool16 Scroll(IGraphicsContext* gc, const PMPoint& delta, int32 flags, PMMatrix* xForm = nil) = 0;
 
 virtual void Erase(IGraphicsContext* gc, const PMPoint& where, int32 flags, PMMatrix* xForm = nil) = 0;
 
 virtual void Hide(IGraphicsContext* gc, bool16 bForceRedraw, PMMatrix* xForm = nil) = 0;
 
 virtual SysRect GetDeviceBounds (IGraphicsContext* gc, int32 flags, PMMatrix* xForm = nil) = 0;

 virtual void InvalidateBBox() = 0;
 
 virtual bool16 ValidSprite() const = 0;

 virtual bool16 NeedsUpdate(const PMPoint& where, int32 flags) const = 0;
};
#endif