<Image variable>.DrawPolygon (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Image variable>.DrawPolygon (Function)

In french: <Variable Image>.DessinePolygone

Draws a polygon in an Image control.

Caution: A specific configuration is required to use this function in Linux. For more details, see The drawings.

Example

// Draw a 4-side polygon whose
// background is light yellow and whose border is light blue
IMG_Dessin.DrawPolygon(4, 10, 20, 20, 50, 40, 60, 50, 10, LightYellow, LightBlue)

Syntax

Building a polygon point by point Hide the details

<Image variable>.DrawPolygon(<Number of sides> , <X1> , <Y1> , <X2> , <Y2> [, <X3> , <Y3> [... [, <Xn> , <Yn>]]] [, <Background color> [, <Side color>]])

<Image variable>: Image variable

Name of the Image control to be used.

<Number of sides>: Integer

Number of sides in the polygon (up to 23 sides). This parameter defines the number of <X>, <Y> pairs to specify in the function.

<X1>: Integer

X-coordinate of first point of the polygon. These coordinates are expressed in pixels.

<Y1>: Integer

Y-coordinate of first point of the polygon. These coordinates are expressed in pixels.

<X2>: Integer

X-coordinate of second point of the polygon. These coordinates are expressed in pixels.

<Y2>: Integer

Y-coordinate of second point of the polygon. These coordinates are expressed in pixels.

<X3>: Integer

X-coordinate of 3rd point of the polygon. These coordinates are expressed in pixels.

<Y3>: Integer

Y-coordinate of 3rd point of the polygon. These coordinates are expressed in pixels.

<Xn>: Optional integer

X-coordinate of nth point of the polygon. These coordinates are expressed in pixels.

<Yn>: Optional integer

Y-coordinate of nth point of the polygon. These coordinates are expressed in pixels.

<Background color>: Integer or constant (optional)

Polygon background color. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color.
If this parameter is not specified, the background color:
is Transparent if <Image>.Background has not been used beforehand,
corresponds to the color specified in the last call to <Image>.Background.

<Side color>: Integer or constant (optional)

Color of polygon sides. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color.
If this parameter is not specified, the line color:
corresponds to the color specified in the last call to <Image>.Pen,
is the same as the background color if <Image>.Pen has not been used.

Building a polygon via an array of X and Y-coordinates Hide the details

<Image variable>.DrawPolygon(<Array of coordinates> [, <Background color> [, <Side color>]])

<Image variable>: Image variable

Name of the Image control to be used.

<Array of coordinates>: Array of integers or array of points

WLanguage array of integers containing the coordinates of polygon points. The even indices represent the X-coordinates while the odd indices represent the Y-coordinates of the points. These coordinates are expressed in pixels.
WLanguage array of Point variables containing the coordinates of the polygon points. These coordinates are expressed in pixels.

<Background color>: Integer or constant (optional)

Polygon background color. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color,
a variable of type Color.
If this parameter is not specified, the background color:
is Transparent if <Image>.Background has not been used beforehand,
corresponds to the color specified in the last call to <Image>.Background.

<Side color>: Integer or constant (optional)

Color of polygon sides. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color,
a variable of type Color.
If this parameter is not specified, the line color:
corresponds to the color specified in the last call to <Image>.Pen,
is the same as the background color if <Image>.Pen has not been used.

Building a polygon from a variable of type Polygon Hide the details

<Image variable>.DrawPolygon(<Polygon> [, <Background color> [, <Side color>]])

<Image variable>: Image variable

Name of the Image control to be used.

<Polygon>: Polygon variable

Name of the Polygon variable that describes the different points of the polygon.

<Background color>: Integer or constant (optional)

Polygon background color. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color,
a variable of type Color.
If this parameter is not specified, the background color:
is Transparent if <Image>.Background has not been used beforehand,
corresponds to the color specified in the last call to <Image>.Background.

<Side color>: Integer or constant (optional)

Color of polygon sides. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a WLanguage preset color,
a variable of type Color.
If this parameter is not specified, the line color:
corresponds to the color specified in the last call to <Image>.Pen,
is the same as the background color if <Image>.Pen has not been used.

Remarks

Coordinates

Drawing a polygon:

IMG_Drawing.DrawPolygon(5, 80, 10, 10, 150, 100, 200, 160, 80, 140, 40)

Coordinates are given with respect to the upper-left corner of the image (coordinates: (0.0)).

Important: There is no need to close the polygon (the coordinates of last point do not have to be equal to the coordinates of first point). The polygon is automatically "closed".

Limits: a polygon can contain up to 100 000 points in WINDEV, WEBDEV and Java, and up to 1000 points in Windows CE.

Drawing with opacity or anti-aliasing

For a drawing with opacity (<Image>.StartDrawing with the dWithOpacity constant) or anti-aliasing (<Image>.ChangeMode with the drawAntiAliasing constant), the outline is drawn inside the polygon: therefore, the line is partly combined with the inside of the polygon. If the line is very thick, it will be displayed in two colors.

Related Examples:

Unit examples (WINDEV): The drawing functions

[ + ] Using the main drawing functions of WINDEV to:
- Initialize an Image control for drawing
- Draw simple shapes
- Write a text into a drawing
- Change the color in a drawing

Business / UI classification: Neutral code

Component: wd280pnt.dll