PathTypes.h

//========================================================================================
// 
// $File$
// 
// Owner: Paul Sorrick
// 
// $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 __PathTypes__
#define __PathTypes__

#include "K2Vector.h"
#include "IPMStream.h"

enum PathPointIndex
{
 kLeftDirPt = 0,
 kAnchorPt,
 kRightDirPt,
 kBothDirPts,
 kSegment
} ;
 
enum PMPathPointType
{
 kCS,
 kCK,
 kL
};
DECLARE_BASE_TYPE(PMPathPointType);

typedef K2Vector<PMPathPointType> PointTypeList;

enum PMPathSegmentType
{
 kLine,
 kCurve,
 kNoSegment
} ;

inline int32 PT_INDEX( int32 n, int32 total ) { return (n + total) % total ; }

class PointSelector
{
public:
 typedef base_type data_type;

 PointSelector() :
 fPathIndex( -1 ),
 fPointIndex( -1 ),
 fSelector( kAnchorPt ),
 fAdornmentClass(kInvalidClass)
 {}
 PointSelector( int32 path, int32 point, PathPointIndex flags = kAnchorPt, ClassID adornmentClass = kInvalidClass ) :
 fPathIndex( path ),
 fPointIndex( point ),
 fSelector( flags ),
 fAdornmentClass (adornmentClass)
 {}

 int32 PathIndex() const { return fPathIndex ; }
 void PathIndex( int32 pathIndex ) { fPathIndex = pathIndex ; }

 int32 PointIndex() const { return fPointIndex ; }
 void PointIndex( int32 pointIndex ) { fPointIndex = pointIndex ; }

 PathPointIndex Selector() const { return fSelector ; }
 void Selector( PathPointIndex selector ) { fSelector = selector ; }

 ClassID AdornmentClass() const { return fAdornmentClass; }
 void AdornmentClass (ClassID adornmentClass) { fAdornmentClass = adornmentClass; }
 
 bool16 operator==( const PointSelector& other ) const
 {
 return ( fPathIndex == other.fPathIndex && fPointIndex == other.fPointIndex && fSelector == other.fSelector ) ;
 }
 bool16 operator!=( const PointSelector& other ) const
 {
 return ( fPathIndex != other.fPathIndex || fPointIndex != other.fPointIndex || fSelector != other.fSelector ) ;
 }
 bool16 operator<( const PointSelector& other ) const
 {
 if ( fPathIndex < other.fPathIndex )
 return kTrue ;
 if ( fPathIndex > other.fPathIndex )
 return kFalse ;
 if ( fPointIndex < other.fPointIndex )
 return kTrue ;
 return kFalse ;
 }
 void ReadWrite(IPMStream *s)
 {
 s->XferInt32(fPathIndex);
 s->XferInt32(fPointIndex);
 s->XferInt32((int32&)fSelector);
 s->XferID(fAdornmentClass);
 }
private:
 int32 fPathIndex ;
 int32 fPointIndex ;
 PathPointIndex fSelector ;
 
 ClassID fAdornmentClass; // If the item hit was an adornment then this will not be kInvalidClass
} ;

typedef K2Vector<PointSelector> PointSelectorList ;

#endif