CPolygon

Heritage

Description

Usage

Environment

Protected Data Members

Public Methods

Constructor, Destructor, and Initializer Methods

Utility Methods

Protected Methods

Heritage

Subclasses: CRegularPoly

Description

Usage

CPolygon is initialized with an array of CPoints. Thus, the polygon is not necessarily regular (contrast with CRegularPoly). The object draws the polygon by connecting the dots, or CPoints. If you choose to let the object fill its interior, then the last point will connect with the first.

Environment

Protected Data Members

Public Methods

CPolygon(CSubview* theEnclosure, const RWOrdered* theListOfPoints);

A constructor. theEnclosure is a pointer to the subview that will contain the polygon. When you pass it an ordered list of points, this constructor connects these points into a polygon.

CPolygon(CSubview* theEnclosure,
	const CPoint* theArrayOfPoints,
	int theNumberOfPoints);

A constructor. theEnclosure is a pointer to the subview that will contain the polygon. When you pass it an array of points and give the number of points, this constructor connects these points into a polygon. This constructor, which uses an array, is an alternative to the preceding constructor, which uses an ordered list of points.

CPolygon(const CPolygon& thePolygon);

A copy constructor that creates a new CPolygon object with the same enclosure, color, visibility attributes, enabled/disabled attributes, environment, and so on as the original CPolygon object. However, any views nested within the original CPolygon object are not copied.

CPolygon& operator=(const CPolygon& thePolygon);

An assignment operator. It copies the attributes of the original CPolygon object, creating a new CPolygon object that has the same color, glue, environment, visibility state, and so on. However, any views nested within the original CPolygon object are not copied.

virtual ~CPolygon(void);

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

BOOLEAN IPolygon(BOOLEAN isFilled	= FALSE,
	BOOLEAN isVisible	= TRUE,
	GLUETYPE theGlue	= NULLSTICKY);

The initializer. By default, the CPolygon object has no interior fill, is visible, and uses the glue type NULLSTICKY. One or more of these defaults can be overridden.

virtual void SetFilled(BOOLEAN isFilled);

Takes a BOOLEAN value; if TRUE, the polygon has a fill.

virtual BOOLEAN IsFilled(void) const;

Returns a BOOLEAN value that indicates whether the polygon has a fill.

virtual void Draw(const CRect& theClippingRegion);

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

virtual void Size(const CRect& theNewSize);

Sizes the polygon 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-like the coordinates of the region that is passed in when a view is instantiated.

virtual void SetOrigin(const CPoint& theChange);

Takes the current origin of a polygon and adds theChange to it. For example, suppose a view has an origin of 10,20 and you want to shift the origin by three pixels to the right. You would set the origin by giving it a delta point of 3,0, which shifts the view three pixels horizontally.

virtual void SetDragging(BOOLEAN isDraggable);

Overrides CView::SetDragging to enable or disable dragging of this object whenever the user selects it via a mouse click. See Dragging and Stretching Methods under CView for more information.

virtual void SetSizing(BOOLEAN isSizable);

Overrides CView::SetSizing to enable or disable sizing of this object whenever the user selects it via a mouse click. See Dragging and Stretching Methods under CView for more information.

RWOrdered GetPoints(void) const;

Returns a list of CPointRWC points that define the polygon.

virtual BOOLEAN HitTest(const CPoint &theHitLoc) const;

Determines whether theHitLoc is a point in one of the polygon's lines.

CPolygon(CSubview* theEnclosure, const CRect& theRegion);

A constructor. theEnclosure is a pointer to the subview that will contain the polygon. theRegion is a coordinate location, local to the enclosure, that is used to place the polygon. This is a protected constructor for classes such as CRegularPoly, which create their internal point structures themselves.

void AdjustInternalPoints(void);

An internal method that adjusts the internal points used to draw a polygon, relative to the object's region and origin.

CRect CreatePoints(const CPoint* theArrayOfPoints,
	int theNumberOfPoints);

Given a pointer to an array of CPoints and an integer value indicating the number of points, this method translates the points into coordinates for the XVT Portability Toolkit.

CRect CreatePoints(const CIdOrderedList* theListOfPoints);

Given a pointer to an ordered list of CPoints, this method translates the points into coordinates for the XVT Portability Toolkit.

CRect BoundingRect();

Returns a CRect object representing the rectangular region bounding all points in the polygon.