dPolygon (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Drawing functions

Graphic strings management functions

Drawing with opacity or anti-aliasing

Using the drawing functions

Related examples

See also

dPolygon (Function)

In french: dPolygone

Draws a polygon:

in an Image control,
in an Image variable.

Example

See additional examples

// Initialise le dessin dans un champ Image
dStartDrawing(IMG_Dessin)
// Dessin d'un polygone à 4 côtés dont le
// fond est jaune clair et le bord bleu clair
dPolygon(4, 10, 20, 20, 50, 40, 60, 50, 10, LightYellow, LightBlue)

Versions 24 and later

// Dessin d'un polygone à 4 côtés dont le
// fond est jaune clair et le bord bleu clair
dPolygon(IMG_Dessin, 4, 10, 20, 20, 50, 40, 60, 50, 10, LightYellow, LightBlue)

New in version 24

// Dessin d'un polygone à 4 côtés dont le
// fond est jaune clair et le bord bleu clair
dPolygon(IMG_Dessin, 4, 10, 20, 20, 50, 40, 60, 50, 10, LightYellow, LightBlue)

// Dessin d'un polygone à partir d'un tableau de coordonnées de points
tabCoordonnéesXY is array of 0 by 2 int = [[2, 3], [14, 100], [10,70], [50, 80]]
dPolygon(tabCoordonnéesXY)
tabCoordonnéesXY2 is array of 0 int = [2, 2, 140, 2, 150, 70, 0, 100, 200, 100]
dPolygon(tabCoordonnéesXY2)
tabCoordonnéesXYC is array of 36 by 2 int
Rayon is int = 50
FOR I = 1 TO 36
// x
tabCoordonnéesXYC[I][1] = 80 + Cos(I*10) * Rayon
// y
tabCoordonnéesXYC[I][2] = 60 + Sin(I*10) * Rayon
END
dPolygon(tabCoordonnéesXYC, LightGray, YellowToolhelp)

Syntax

Building a polygon point by point Hide the details

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

<Image>: Optional control name or optional Image, WDPic or picLayer variable

Versions 24 and later
Image to use. This image can correspond to:
the name of an Image control.
the name of a variable of type Image.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.
New in version 24
Image to use. This image can correspond to:
the name of an Image control.
the name of a variable of type Image.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.
Image to use. This image can correspond to:
the name of an Image control.
the name of a variable of type Image.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.

<Number of sides>: entier

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>: entier

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

<Y1>: entier

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

<X2>: entier

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

<Y2>: entier

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

<X3>: entier

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

<Y3>: entier

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 function dBackground has not been used before,
corresponds to the Color specified in the last call to the dBackground function.

<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 the dPen function,
is identical to the Color used for the Background if the dPen function was not used.

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

dPolygon([<Image>, ] <Array of coordinates> [, <Background color> [, <Side color>]])

<Image>: Optional control name or optional Image, WDPic or picLayer variable

Versions 24 and later
Image to use. This image can correspond to:
the name of an Image control.
the name of a variable of type Image.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.
New in version 24
Image to use. This image can correspond to:
the name of an Image control.
the name of a variable of type Image.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.
Image to use. This image can correspond to:
the name of an Image control.
the name of a variable of type Image.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.

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

WLanguage array of integers containing the coordinates of polygon points. The even subscript represent the X-coordinates while the odd subscripts represent the Y-coordinates of 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,
If this parameter is not specified, the background color:
is Transparent if the dBackground function has not been used before,
corresponds to the Color specified in the last call to the dBackground function.

<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 dPen,
is identical to the Color used for the Background if the dPen function was not used.

Versions 26 and later

Construction of a polygon from an Variable of the Polygon type Hide the details

dPolygon([<Image>, ] <Polygon> [, <Background color> [, <Side color>]])

<Image>: Optional control name or optional Image, WDPic or picLayer variable

Image to use. This image can correspond to:
the name of an Image control.
the name of a variable of type Image.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.

<Polygon>: Variable type Polygon

Name of the variable of type Polygon describing 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 the dBackground function has not been used before,
corresponds to the Color specified in the last call to the dBackground function.

<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 dPen,
is identical to the Color used for the Background if the dPen function was not used.

New in version 26

Construction of a polygon from an Variable of the Polygon type Hide the details

dPolygon([<Image>, ] <Polygon> [, <Background color> [, <Side color>]])

<Image>: Optional control name or optional Image, WDPic or picLayer variable

Image to use. This image can correspond to:
the name of an Image control.
the name of a variable of type Image.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.

<Polygon>: Variable type Polygon

Name of the variable of type Polygon describing 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 the dBackground function has not been used before,
corresponds to the Color specified in the last call to the dBackground function.

<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 dPen,
is identical to the Color used for the Background if the dPen function was not used.

Construction of a polygon from an Variable of the Polygon type Hide the details

dPolygon([<Image>, ] <Polygon> [, <Background color> [, <Side color>]])

<Image>: Optional control name or optional Image, WDPic or picLayer variable

Image to use. This image can correspond to:
the name of an Image control.
the name of a variable of type Image.
If this parameter is not specified, it is necessary to define the drawing destination with dStartDrawing.

<Polygon>: Variable type Polygon

Name of the variable of type Polygon describing 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 the dBackground function has not been used before,
corresponds to the Color specified in the last call to the dBackground function.

<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 dPen,
is identical to the Color used for the Background if the dPen function was not used.

Remarks

Coordinates

Drawing a polygon:

dPolygon(5, 80, 10, 10, 150, 100, 200, 160, 80, 140, 40)

Coordinates are given with respect to the top 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

When drawing with opacity (dStartDrawing with the dWithOpacity constant) or with anti-aliasing (dChangeMode with the drawAntiAliasing constant), the border is drawn above the inside of 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.

Using the drawing functions

The drawing functions can be used according to 2 methods:

Method 1: Using dStartDrawing
- dStartDrawing must be called before any other drawing function. dStartDrawing is used to define the element (Image control or variable) to which the drawing functions will be applied.
- When drawing on an Image control:
  - The drawing functions operate on a copy ("bitmap") of the image. You can use the drawing functions of Windows (via API or CallDLL32) but these functions must use the DC (Device Context) returned by dStartDrawing.
  - dEndDrawing and dStartDrawing must not be called in the same process.
    The drawing will not be displayed if dEndDrawing and dStartDrawing are called in the same process: it will be automatically erased.
Versions 24 and later
Method 2: indicating the drawing target directly in the syntax (via a parameter)
The <Image> parameter is used to specify directly the target of the drawing. The dStartDrawing function becomes unnecessary. This function must be deleted.

New in version 24
Method 2: indicating the drawing target directly in the syntax (via a parameter)
The <Image> parameter is used to specify directly the target of the drawing. The dStartDrawing function becomes unnecessary. This function must be deleted.

Method 2: indicating the drawing target directly in the syntax (via a parameter)
The <Image> parameter is used to specify directly the target of the drawing. The dStartDrawing function becomes unnecessary. This function must be deleted.

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: wd270pnt.dll