PMLineSeg Class Reference

#include <PMLineSeg.h>

Public Member Functions
	PMLineSeg ()
	PMLineSeg (const PMPoint &P1, const PMPoint &P2)
	PMLineSeg (const PMPoint &P1, const PMReal &xDistance, const PMReal &yDistance)
	PMLineSeg (const PMReal &p1x, const PMReal &p1y, const PMReal &p2x, const PMReal &p2y)
bool16	IsHorizontal () const
bool16	IsVertical () const
PMReal	DeltaX () const
PMReal	DeltaY () const
const PMPoint &	TopPoint () const
const PMPoint &	BottomPoint () const
const PMReal &	Top () const
PMReal &	Top ()
void	Top (const PMReal &newP1y)
const PMReal &	Bottom () const
PMReal &	Bottom ()
void	Bottom (const PMReal &newP2y)
const PMReal &	Left () const
PMReal &	Left ()
void	Left (const PMReal &newLeft)
const PMReal &	Right () const
PMReal &	Right ()
void	Right (const PMReal &newRight)
void	SetX (const PMReal &x1, const PMReal &x2)
void	SetY (const PMReal &y1, const PMReal &y2)
void	SetHorizontal (const PMReal &x1, const PMReal &x2)
void	SetVertical (const PMReal &y1, const PMReal &y2)
PMLineSeg &	MoveRel (const PMReal &dx, const PMReal &dy)
PMLineSeg &	MoveRel (const PMPoint &point)

Friends
bool16	operator== (const PMLineSeg &a, const PMLineSeg &b)
bool16	operator!= (const PMLineSeg &a, const PMLineSeg &b)

Detailed Description

A C++ class for line segment. This line segment is defined by two points.

Constructor & Destructor Documentation

PMLineSeg::PMLineSeg ( )

inline

The default constructor makes no assumptions about what a default line is.

PMLineSeg::PMLineSeg ( const PMPoint &  P1, const PMPoint &  P2  )

inline

Creates a line given two points. (Current) usage is such that, usually P1 is "less than" P2, resulting in DeltaY being positive. We assert the fact that P1.Y() < P2.Y(). The x-dimension can be arbitrary. Therefore it is assumed that P1 is the top point and P2 the bottom.

Parameters

P1	is the first point.
P2	is the second point.

PMLineSeg::PMLineSeg ( const PMPoint &  P1, const PMReal &  xDistance, const PMReal &  yDistance  )

inline

Creates a line given a point and x and y distances. It is assumed that P1 is the top point and P2 the bottom

Parameters

P1	is the point.
xDistance	is the distance to the y-axis (P2).
yDistance	is the distance to the x-axis (P2).

PMLineSeg::PMLineSeg ( const PMReal &  p1x, const PMReal &  p1y, const PMReal &  p2x, const PMReal &  p2y  )

inline

Cosntruct a line given two points as x and y each. It is assumed that P1 is the top point and P2 the bottom

Parameters

p1x	is the x position of the first point (P1).
p1y	is the y position of the first point (P1).
p1x	is the x position of the second point (P2).
p1y	is the y position of the second point (P2).

Member Function Documentation

const PMReal& PMLineSeg::Bottom ( ) const

inline

the bottom point y value.

PMReal& PMLineSeg::Bottom ( )

inline

Return the bottom point y value. Caution when using this method - you should ASSERT(fTop.Y() <= fBottom.Y()); the bottom point y value.

void PMLineSeg::Bottom ( const PMReal &  newP2y )

inline

Set the bottom point y value.

Parameters

newP2y

is the new y value for bottom point.

const PMPoint& PMLineSeg::BottomPoint ( ) const

inline

the bottom point.

PMReal PMLineSeg::DeltaX ( ) const

inline

Returns

the difference in the x coordinates.

PMReal PMLineSeg::DeltaY ( ) const

inline

Returns

the difference in the y coordinates.

bool16 PMLineSeg::IsHorizontal ( ) const

inline

Returns

true if line is a horizontal line.

bool16 PMLineSeg::IsVertical ( ) const

inline

Returns

true if line is a vertical line.

const PMReal& PMLineSeg::Left ( ) const

inline

Returns

the left point.

PMReal& PMLineSeg::Left ( )

inline

Returns

the left point.

void PMLineSeg::Left ( const PMReal &  newLeft )

inline

Set the new left value

Parameters

newLeft

specifies the new left value.

PMLineSeg& PMLineSeg::MoveRel ( const PMReal &  dx, const PMReal &  dy  )

inline

Move the line segmenet by delta amount in both x and y direction.

Parameters

dx	the amount in x position to move.
dy	is the amount in y position to move.

Returns

the new line segment.

PMLineSeg& PMLineSeg::MoveRel ( const PMPoint &  point )

inline

Move the line segmenet by delta amount in both x and y direction specified by point.

Parameters

point

the amount to move.

Returns

the new line segment.

const PMReal& PMLineSeg::Right ( ) const

inline

Returns

the right point.

PMReal& PMLineSeg::Right ( )

inline

Returns

the right point.

void PMLineSeg::Right ( const PMReal &  newRight )

inline

Set the new right value

Parameters

newRight

specifies the new right value.

void PMLineSeg::SetHorizontal ( const PMReal &  x1, const PMReal &  x2  )

inline

Turn the line segment to a horizontal line that passes through x1 and x2.

Parameters

x1	is the new left value for the horizontal line.
x2	is the new right value for the horizontal line.

void PMLineSeg::SetVertical ( const PMReal &  y1, const PMReal &  y2  )

inline

Turn the line segment to a vertical line that passes through y1 and y2.

Parameters

y1	is the new top value for the vertical line.
y2	is the new bottom value for the vertical line.

void PMLineSeg::SetX ( const PMReal &  x1, const PMReal &  x2  )

inline

Set the new x values for top and bottom points.

Parameters

x1	is the x value for the top point.
x2	is the x value for the bottom point.

void PMLineSeg::SetY ( const PMReal &  y1, const PMReal &  y2  )

inline

Set the new top and bottom value for the points.

Parameters

y1	is the new top value for the top point.
y2	is the new bottom value for the bottom point.

const PMReal& PMLineSeg::Top ( ) const

inline

the top point y value.

PMReal& PMLineSeg::Top ( )

inline

Return the top point y value. Caution when using this method - you should ASSERT(fTop.Y() <= fBottom.Y()); the top point y value.

void PMLineSeg::Top ( const PMReal &  newP1y )

inline

Set the top point y value.

Parameters

newP1y

is the new y value for top point.

const PMPoint& PMLineSeg::TopPoint ( ) const

inline

the top point.

Friends And Related Function Documentation

bool16 operator!= ( const PMLineSeg &  a, const PMLineSeg &  b  )

friend

Return true if two PMLineSeg are not equal.

Parameters

a	is first line segment.
b	is second line segment.

Returns

true if a and b are not equal.

bool16 operator== ( const PMLineSeg &  a, const PMLineSeg &  b  )

friend

Return true if two PMLineSeg are equal.

Parameters

a	is first line segment.
b	is second line segment.

Returns

true if a and b are equal.