PMPathPoint.h

//========================================================================================
// 
// $File$
// 
// Owner: jargast
// 
// $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.
// 
// 
// A Generic class that describes a line point or a Bezier knot
// 
//========================================================================================

#ifndef __PMPathPoint__
#define __PMPathPoint__

#include "PMPoint.h"
#include "PathTypes.h"

class IPMStream;
class PMRect;
class PMPathPoint;
class PMMatrix;

typedef PMPathPoint PBPMPathPoint ; // path point in "Pasteboard" PMRealinates
typedef K2Vector<PMPathPoint> PMPathPointList;


class PMPathPoint
{
public: 
 typedef base_type data_type;

 constexpr PMPathPoint() noexcept : fAnchorType(kL), fLeftDirPt(0,0), fRightDirPt(0,0), fAnchorPt(0,0)
 {}
 
 PMPathPoint (PMPathPointType pointType, const PMPointList& ptList);
 
 PMPathPoint (PMPathPointType pointType, const PMPoint& leftDirPt, const PMPoint& anchorPt, const PMPoint& rightDirPt);

 PMPathPoint (const PMPointList& ptList);

 PMPathPoint (const PMPoint& linePt) noexcept;
 
 PMPathPoint (const PMPoint& leftDirPt, const PMPoint& anchorPt, const PMPoint& rightDirPt);
 
 const PMPoint& GetPoint (PathPointIndex ptIndex) const;
 
 const PMPoint& GetLeftDirPoint () const noexcept;
 const PMPoint& GetAnchorPoint () const noexcept;
 const PMPoint& GetRightDirPoint () const noexcept;
 
 PMPathPointType GetAnchorType() const noexcept;
 
 void ModifyPoint
 (
 PathPointIndex ptIndex,
 const PMPoint& newPoint,
 bool16 bMirrorPt = kFalse,
 PMRect* constrainRect = nil
 );

 void SetPoint( PathPointIndex ptIndex, const PMPoint& newPoint );
 void SetLeftDirPoint( const PMPoint& newPoint ) noexcept;
 void SetAnchorPoint( const PMPoint& newPoint ) noexcept;
 void SetRightDirPoint( const PMPoint& newPoint ) noexcept;

 void Flip();
 
 void ModifyAnchorType (PMPathPointType newType);
 
 PMRect GetBoundingBox() const;
 
 void TransformPoints (const PMMatrix& xForm);
 
 bool16 HitTest( const PMRect& hitRect, PathPointIndex& whichPt, const PMReal& handleSize = 0.0 ) const ;
 
 void ReadWrite (IPMStream* iPMStream);

 // Math Operators
 friend PMPathPoint operator *(const PMReal& c, const PMPathPoint& pt);
 friend PMPathPoint operator *(const PMPathPoint& pt, const PMReal& c);
 friend PMPathPoint operator /(const PMPathPoint& numer, const PMReal& denom);

 // Assignment Operators
 void operator *=(const PMReal& a);
 void operator /=(const PMReal& a);
 PMPathPoint(const PMPathPoint& rhs) noexcept = default;
 PMPathPoint(PMPathPoint&& rhs) noexcept = default;
 PMPathPoint& operator=(const PMPathPoint& rhs) noexcept = default;
 PMPathPoint& operator=(PMPathPoint&& rhs) noexcept = default;

 // Comparison Operators
 friend bool16 operator ==(const PMPathPoint& a, const PMPathPoint& b) noexcept;
 friend bool16 operator !=(const PMPathPoint& a, const PMPathPoint& b) noexcept;
 
private:
 PMPathPointType fAnchorType;
 PMPoint fLeftDirPt; 
 PMPoint fAnchorPt; 
 PMPoint fRightDirPt; 
};

inline bool16 operator ==(const PMPathPoint& a, const PMPathPoint& b) noexcept
{
 return ( a.fAnchorType == b.fAnchorType &&
 a.fLeftDirPt == b.fLeftDirPt &&
 a.fAnchorPt == b.fAnchorPt &&
 a.fRightDirPt == b.fRightDirPt );
}

inline bool16 operator !=(const PMPathPoint& a, const PMPathPoint& b) noexcept
{
 return !(a == b);
}



#endif