CLine

Heritage

Description

Usage

Environment

Public Data Members

Protected Data Members

Public Methods

Constructor, Destructor, and Initializer Methods

Hit Test Methods

Overridden CView Methods

Utility Methods

Protected Methods

Internal Methods

Heritage

Subclasses: None

Description

Usage

Environment

Public Data Members

Protected Data Members

Public Methods

CLine (CSubview* theEnclosure, 
	const CPoint& theStartingPoint, 
	const CPoint& theEndingPoint);

A constructor. theEnclosure is a pointer to the subview that will contain the line.In addition, this method takes two points (CPoints), the point at which the line starts and the point at which it stops.

CLine(const CLine& theLine);

A copy constructor that creates a new CLine object with the same enclosure, color, visibility attributes, enabled/disabled attributes, environment, and so on as the original CLine object.

CLine& operator=(const CLine& theLine);

An assignment operator. It copies the attributes of the original CLine object, creating a new CLine object that has the same color, glue, environment, visibility state, and so on.

The destructor. It cleans up after the line and deletes any views nested within it.

BOOLEAN ILine(BOOLEAN hasBeginningArrow	= FALSE, 
	BOOLEAN hasEndingArrow 	= FALSE, 
	BOOLEAN isVisible 	= TRUE,
	long theGlue 	= NULLSTICKY);

The initializer. By default, the line has neither a beginning arrow nor an ending arrow, it is visible, and it uses the glue type NULLSTICKY. One or more of these defaults can be overridden.

virtual void Draw(const CRect& theClippingRegion);

Takes care of any drawing the line must do. theClippingRegion is the part of the line to be drawn, and it is in global, window-relative coordinates.

virtual void Size(const CRect& theNewSize);

Sizes the line according to the coordinates of theNewSize. The reset region could be in a different location and have completely different dimensions-a new width or a new height. The coordinates of the region, theNewSize, are relative to the enclosure.

virtual void Size(const CPoint& theStartingPoint, 
	const CPoint& theEndingPoint);

Resizes the line using theStartingPoint and theEndingPoint as the line's new starting and ending coordinates.

virtual void SetEnvironment(
	const CEnvironment& theNewEnvironment, 
	BOOLEAN isUpdate = FALSE);

Overrides CView::SetEnvironment to set the colors of this object.

static UNITS GetDistanceFromLine(
const CPoint &theStart,
const CPoint &theEnd,
const CPoint &thePoint);

Calculates the distance from line: Given a line p(x1, y1) to q(x2, y2) and a point r(x3, y3) calculate the distance from the point (r) to the line (p-q)

virtual BOOLEAN HitTest(const CPoint &theHitLoc) const;

Determines if theHitLoc is a point in the line.

virtual void SetDragging(BOOLEAN isDraggable);

Overrides CView::SetDragging to enable or disable dragging of this object whenever the user selects via a mouse click.

virtual void SetSizing(BOOLEAN isSizable);

Overrides CView::SetSizing to enable or disable sizing of this object whenever the user selects via a mouse click.

virtual void SetArrows(BOOLEAN hasBeginningArrow, 
	BOOLEAN hasEndingArrow);

Allows you to set the beginning and ending arrows for the line, taking a BOOLEAN value of TRUE or FALSE for each of its two parameters.

virtual BOOLEAN HasBeginningArrow(void);

Returns a BOOLEAN value indicating whether the line has a beginning arrow.

virtual BOOLEAN HasEndingArrow(void);

Returns a BOOLEAN value indicating whether the line has an ending arrow.

CPoint GetStartPoint(void) const;

Returns the coordinates of the starting point of the line.

CPoint GetEndPoint(void) const;

Returns the coordinates of the ending point of the line.

CRefct GetInitialFrame(CSubview* theEnclosure,
	const CPoint& theStPnt, const CPoint& theEndPnt);

Given two points, returns a CRect that is relative to theEnclosure and contains both points.

void PadFrameFromPoints(void);

Internal method that resizes the line's frame to fit the points in the line taking in consideration the line's width.

void PadPointsFromFrame(void);

Internal method which resizes the line to fit its frame.