PMLine.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.
// 
// 
// Your basic line class. Encapsulates the equation for a line,
// solves for x, solves for y, and handles intersection testing.
// 
//========================================================================================

#ifndef __PMLine__
#define __PMLine__

 class PMPoint;
 
 
class PMLine
 {
 public:
 
 PMLine();
 
 PMLine (const PMReal& slope, const PMReal& yIntercept); 
 
 PMLine (const PMReal& xIntercept);
 
 PMLine (const PMPoint& P1, const PMPoint& P2);
 
 bool16 SolveForY (const PMReal& X, PMReal* Y) const;
 
 bool16 SolveForX (const PMReal& Y, PMReal* X) const;
 
 PMLine SolveForPerpendicularLine (const PMPoint& P) const;
 
 bool16 SolveForIntersectPoint (const PMLine& otherLine, PMPoint* intersectPt) const;

 bool16 SolveForIntersectPoint (const PMPoint& P1, const PMPoint& P2, PMPoint* intersectPt) const;
 
 bool16 GetSlope (PMReal* pSlope) const;

 bool16 FindPointOnLine (const PMPoint& P0, const PMReal& dist, const PMPoint& refPoint, PMPoint* retPt) const;
 
 bool16 ContainsPoint(const PMPoint& point) const;
 
 // Comparison operator
 friend bool16 operator ==(const PMLine& a, const PMLine& b);
 friend bool16 operator !=(const PMLine& a, const PMLine& b);
 
private:
 PMReal fSlope;
 PMReal fYIntercept;
 PMReal fXIntercept;
 bool16 fSlopeIsInfinite;
 bool16 fUndefined; // for those rare cases when the line can't be solved for
};
 
 
#endif