IGuideData.h

//========================================================================================
// 
// $File$
// 
// Owner: Stacy Molitor
// 
// $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 __IGuideData__
#define __IGuideData__

#include "IPMUnknown.h"
#include "GuideID.h"
#include "PMReal.h"
#include "PMPoint.h"
#include "iuicolorutils.h"
#include "IZoomCmdData.h"
#include "K2Vector.h"

const PMReal kNoViewThreshold = 0.0; // no view threshold, the guide is always drawn
const PMReal kDefaultViewThreshold = kMinZoom;
const PMReal kDefaultGuideWidth = 1.0;
const PMReal kDefaultGuideHeight = 1.0;

class IGuideData : public IPMUnknown
{
 public:
 enum {kDefaultIID = IID_IGUIDEDATA};

 enum GuideType
 {
 kRulerGuide = 0,
 kLiquidGuide,
 kMagneticGuide,
 kGrowZoneGuide
 };

 virtual void Set(bool16 isHoriz, const PMReal &distance, const UID &ownerUID, 
 const PMReal &threshold = kDefaultViewThreshold, 
 const int32 colorIndex = IUIColorUtils::kStockRulerGuide) = 0;
 
 virtual void SetIsShort(bool16 isShort) = 0;

 virtual void SetLocation(const PMReal& location) = 0;

 virtual void SetType(const GuideType guideType) = 0;
 
 virtual GuideType GetType() const = 0;
 
 virtual void SetLiquidGrowZoneSize(const PMReal& size) = 0;
 
 virtual PMReal GetLiquidGrowZoneSize() const = 0;
 
 virtual void ModifyIsHoriz(bool16 isHoriz) = 0;

 virtual void ModifyDistance(const PMReal &distance) = 0;
 
 virtual void ModifyOwnerUID(const UID &ownerUID) = 0;
 
 virtual void ModifyViewThreshold(const PMReal viewThreshold) = 0;
 
 virtual void ModifyColorUID(const UID colorUID) = 0;

 virtual bool16 GetIsHoriz() const = 0;
 
 virtual PMReal GetDistance() const = 0;
 
 virtual UID GetOwnerUID() const = 0;
 
 virtual PMReal GetViewThreshold() const = 0;
 
 virtual int32 GetColorIndex_FOR_CONVERSION_ONLY() const = 0;

 virtual UID GetColorUID() const = 0;
 
 virtual bool16 GetIsShort() = 0;
 
 virtual PMPoint GetTopLeftPoint() = 0;
 
 virtual PMPoint GetBottomRightPoint() = 0;
 
 virtual PMReal GetLocation() = 0;
};

DECLARE_BASE_TYPE(IGuideData::GuideType);


#endif