IRefPointUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $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 __IRefPointUtils__
#define __IRefPointUtils__

#include "AppFrameworkID.h"
#include "IPMUnknown.h"
#include "IReferencePointData.h"
#include "TransformTypes.h"

class UIDList;

class IRefPointUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IREFPOINTUTILS };

 virtual PBPMPoint CalculateReferencePoint_1(IReferencePointData::ReferencePointPosition position,
 const PMPolygon4& bounds) = 0; //should probably use a PMRect, PMMatrix pair

 virtual PBPMPoint CalculateReferencePoint_2(IReferencePointData::ReferencePointPosition position,
 const UIDList& items,
 PBPMRect* referenceFrame /*= nil*/, // Optionally return parent rect if it exists (e.g. graphic item direct selected)
 const Geometry::BoundsKind* pUseStroke /*= nil*/, // Optionally sets setting to indicate whether to use stroke or path bound.
 const Transform::CoordinateSpace* coordinateSpace /* = nil*/) = 0;

 inline PBPMPoint CalculateReferencePoint_3( IReferencePointData::ReferencePointPosition position, const UIDList& items)
 {
 return CalculateReferencePoint_2( position, items, nil, nil, nil);
 }

 virtual IReferencePointData::ReferencePointPosition MapPointIndexToReferencePoint(PMRect::PointIndex index) = 0;

 virtual PMRect::PointIndex MapReferencePointToPointIndex(IReferencePointData::ReferencePointPosition position) = 0;

 virtual Transform::TransformOrigin RefPositionToTransformOrigin(IReferencePointData::ReferencePointPosition position) = 0;

};


#endif // __IRefPointUtils__