IRenderingObject.h

//========================================================================================
// 
// $File$
// 
// Owner: SusanCL
// 
// $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 __IRenderingObject__
#define __IRenderingObject__

#include "IPMUnknown.h"
#include "ShuksanID.h"
#include "ColorSystemID.h"
#include "PMString.h"
#include "IColorData.h"

class PMRect;
class AttributeBossList;
class GridAddress;
class IGraphicsPort;
class IGraphicStyleDescriptor;
class IWaxRenderData;
class IGraphicAttributeSuite;
class IViewPort;
class IControlView;
class IGraphicsContext;

class RenderingObjectInstallData
{
public:
 virtual ~RenderingObjectInstallData() {}
 virtual PMReal GetTint() = 0;
 
 virtual void SetTint(PMReal tint) = 0;

 virtual bool16 GradientValuesSet() = 0;
 
 virtual void SetGradientValues(PMReal fillAngle, PMReal fillLength, PMPoint fillCenter, PMReal fillRadius, 
 PMReal highlightAngle, PMReal highlightLength) = 0;
 
 virtual PMReal GetFillAngle() = 0;
 virtual PMReal GetFillLength() = 0;
 virtual PMPoint GetFillCenter() = 0;
 virtual PMReal GetFillRadius() = 0;
 virtual PMReal GetHighlightAngle() = 0;
 virtual PMReal GetHighlighLength() = 0;
};

class IRenderingObject : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IRENDERINGOBJECT };

 enum InstallAction
 {
 kInstallStroke,
 kInstallFill,
 kInstallGap
 };
 
 virtual void Install (IGraphicsPort* gPort, IGraphicStyleDescriptor* iGSDesc, InstallAction theAction) const = 0;
 
 virtual void Install (IGraphicsPort* gPort, IWaxRenderData* iWaxData, InstallAction theAction) const = 0;
 
 virtual void Install (IGraphicsPort* gPort, IGraphicAttributeSuite* iGfxAttrSuite, InstallAction theAction, const PMRect& r ) const = 0;
 
 virtual void Install (IGraphicsPort* gPort, const AttributeBossList& attrs, const PMRect& r, InstallAction theAction) const = 0;
 
 virtual void Install (IGraphicsPort* gPort, const PMRect& r) const = 0;
 
 virtual void Install (IGraphicsPort* gPort, RenderingObjectInstallData *data, const PMRect& r, InstallAction theAction) const = 0;
 
 virtual const PMString& GetSwatchUIName () const = 0; 

 virtual PMString GetTipText() const = 0;

 virtual PMString GetTipText( const int32& colorSpace, const ColorArray& colorComponents ) const = 0;
 
 virtual const PMString& GetSwatchName() const = 0;

 virtual bool16 GetVisibility() const = 0;

 virtual bool16 GetCanDelete() const = 0;

 virtual bool16 GetCanEdit() const = 0;

 virtual bool16 IsGlobal() const = 0;

 virtual UID GetSwatchAliasUID () const = 0;

 virtual void SetSwatchName(const PMString& newName) = 0;

 virtual void SetVisibility(const bool16 visible) = 0;

 virtual void SetCanDelete(const bool16 canDelete) = 0;

 virtual void SetCanEdit(const bool16 canEdit) = 0;
 
 virtual void SetSwatchAliasUID (UID newAliasUID) = 0;

 virtual int32 GetCreatorID () const = 0;
 
 virtual void SetCreatorID (int32 newCreatorID) = 0;
 
 virtual int32 GetSpecialEditInfo() const = 0;
 
 virtual void SetSpecialEditInfo(const int32 newEditInfo) = 0;
 
 virtual bool16 NeedUpdate( UID interestedUID ) const = 0;

 virtual UID DuplicateAsLocal ( const IGraphicStyleDescriptor* overrideAttrs, InstallAction theAction) const = 0;
 virtual UID DuplicateAsLocal ( const AttributeBossList* overrideAttrs, InstallAction theAction) const = 0;
 virtual UID DuplicateAsLocal ( const PMReal& tint) const = 0;

 //____________________________________________________________________________________
 // Utilities
 //____________________________________________________________________________________
 
 virtual ClassID GetRenderClass () const = 0;
 
 virtual bool16 IsEqual (const IRenderingObject* iRenderObject2) const = 0;
 
};


#endif