IOpacityGradientStops.h

//========================================================================================
// 
// $File$
// 
// Owner: Matt Phillips
// 
// $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.
// 
// 
// Defines an opacity gradient's data. Similar to gradient fill data, but at each stop
// there's only a simple PMReal opacity, not a full set. That, and the gradient type
// is stored externally since in the future we may want to add this interface onto 
// color gradients, which would then create a conflict of attributes problem.
// 
// Note that an empty gradient is assumed to be equivalent to not having a gradient
// (ie, constant alpha=1).
// 
//========================================================================================


#include "IPMUnknown.h"
#include "XPID.h"
#include "GraphicTypes.h"

class IOpacityGradientStops : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IOPACITYGRADIENTSTOPS };

public:
 virtual void ResetToDefault() = 0;
 
 virtual void DeleteAllStops() = 0;
 
 virtual int32 GetNumStops() const = 0;
 
 virtual int32 InsertStop(int32 beforeStop = -1) = 0;

 virtual bool32 DeleteStop(int32 whichStop) = 0;

 virtual void SetStopOpacity(int32 whichStop, PMReal opacity) = 0;
 
 virtual PMReal GetStopOpacity(int32 whichStop) const = 0;
 
 virtual int32 SetStopPosition(int32 whichStop, PMReal position, bool32 autoRearrange = kTrue) = 0;
 
 virtual PMReal GetStopPosition(int32 whichStop) const = 0;
 
 virtual void SetStopMidpoint(int32 whichStop, PMReal midpoint) = 0;
 
 virtual PMReal GetStopMidpoint(int32 whichStop) const = 0;
 
 virtual void SetStopMidpointRelativeLocation(int32 whichStop, PMReal relLoc) = 0;
 
 virtual PMReal GetStopMidpointRelativeLocation(int32 whichStop) const = 0;
 
 virtual bool16 Equals(const IOpacityGradientStops* iOther) const = 0;

 virtual void CopyFrom(const IOpacityGradientStops* iOther) = 0;

 virtual IDataBase* GetDataBase (void) const = 0;
};