IGeometry.h

//========================================================================================
// 
// $File$
// 
// Owner: Jeff Argast
// 
// $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:
// IGeometry is designed to be a "geometry independent" way of defining
// an object, meaning that nothing in the interface makes any assumption as
// to the item being rectangular, linear, etc.
// 
// PageItems are defined by one or more points. It is up to the implementer to
// decide how to interpret these point in order to get a BoundingBox, etc.
// As a convenience there are two sets of methods, one for bounding box
// with stroke and one for bounding box without stroke. For certain pageitems,
// such as images, the path bounds and stroke bounds will be the same.
// 
// Note: IGeometry does NOT draw. IShape is used for drawing and is implemented in
// terms of IGeometry.
// 
// IGeometry is a required interface of page items.
// 
//========================================================================================

#ifndef __IGeometry__
#define __IGeometry__

#include "IPMUnknown.h"
#include "PMReal.h"
#include "PMPoint.h"
#include "PMRect.h"
#include "PMMatrix.h"
#include "GraphicsID.h"
#include "TransformTypes.h"

class IGeometry : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IGEOMETRY };

 virtual PMRect GetStrokeBoundingBox(const PMMatrix& theMatrix) const = 0;

 virtual PMRect GetStrokeBoundingBox() const = 0;
 
 virtual ErrorCode SetStrokeBoundingBox(const PMRect& newBBox /*, SetAction whichAction*/) = 0;
 
 virtual ErrorCode SetStrokeBoundingBox(const PMMatrix& theMatrix, const PMRect& newBBox/*, SetAction whichAction*/) = 0;
 
 virtual PMRect GetPathBoundingBox(const PMMatrix& theMatrix) const = 0;

 virtual PMRect GetPathBoundingBox() const = 0;
 
 virtual ErrorCode SetPathBoundingBox(const PMRect& newBBox/*, SetAction whichAction*/) = 0;
 
 virtual ErrorCode SetPathBoundingBox(const PMMatrix& theMatrix, const PMRect& newBBox/*, SetAction whichAction*/) = 0;
 
 virtual PMReal GetStrokeProportion() const = 0;
 
 virtual PMReal GetPathProportion() const = 0;



 //These will need to be reworked when Geometry::InnerStrokeBounds() is added
 PMRect GetBoundingBox( Geometry::BoundsKind kind, const PMMatrix& theMatrix) const
 {
 kind = Geometry::ResolvePreferredBounds( kind);
 if( kind == Geometry::PathBounds()){ //BoundsKindCompare
 return GetPathBoundingBox( theMatrix);
 }else if( kind == Geometry::OuterStrokeBounds()){
 return GetStrokeBoundingBox( theMatrix);
 }else{
 ASSERT_UNIMPLEMENTED();
 return PMRect();
 }
 }

 PMRect GetBoundingBox( Geometry::BoundsKind kind) const
 {
 kind = Geometry::ResolvePreferredBounds( kind);
 if( kind == Geometry::PathBounds()){ //BoundsKindCompare
 return GetPathBoundingBox();
 }else if( kind == Geometry::OuterStrokeBounds()){
 return GetStrokeBoundingBox();
 }else{
 ASSERT_UNIMPLEMENTED();
 return PMRect();
 }
 }

 ErrorCode SetBoundingBox( Geometry::BoundsKind kind, const PMRect& newBBox)
 {
 kind = Geometry::ResolvePreferredBounds( kind);
 if( kind == Geometry::PathBounds()){ //BoundsKindCompare
 return SetPathBoundingBox( newBBox);
 }else if( kind == Geometry::OuterStrokeBounds()){
 return SetStrokeBoundingBox( newBBox);
 }else{
 ASSERT_UNIMPLEMENTED();
 return kFailure;
 }
 }

 ErrorCode SetBoundingBox( Geometry::BoundsKind kind, const PMMatrix& theMatrix, const PMRect& newBBox)
 {
 kind = Geometry::ResolvePreferredBounds( kind);
 if( kind == Geometry::PathBounds()){ //BoundsKindCompare
 return SetPathBoundingBox( theMatrix, newBBox);
 }else if( kind == Geometry::OuterStrokeBounds()){
 return SetStrokeBoundingBox( theMatrix, newBBox);
 }else{
 ASSERT_UNIMPLEMENTED();
 return kFailure;
 }
 }
 
};


#endif