Back to Doc.qt.io
Contact Us Blog Download Qt

RegularPolygonItem QML Type

A filled regular polygon with an optional border. More...

Import Statement: import QtQuick.Studio.Components
Since: QtQuick.Studio.Components 1.0
Inherits:

Shape

Properties

Detailed Description

A regular polygon can be just a 2D polygon shaped stroke, a filling, or a stroke with filling. The strokeColor, strokeWidth, and strokeStyle properties specify the appearance of the outline. The dashPattern and dashOffset properties specify the appearance of dashed stroke.

The area inside the stroke is painted using either a solid fill color, specified using the fillColor property, or a gradient, defined using one of the ShapeGradient subtypes and set using the gradient property. If both a color and a gradient are specified, the gradient is used.

To create a polygon with a stroke, set the sideCount property between 3 to 100 and the strokeWidth property greater than 0. The strokeWidth property specifies the width of the polygon stroke.The default sideCount value is 6 and the default strokeWidth value is 4. Setting the strokeWidth value to a negetive value hides the border.

The radius property specifies whether the polygon corners are rounded. Because this introduces curved edges to the corners, it may be appropriate to set the antialiasing property that is inherited from Item to improve the appearance of the stroke.

Example Usage

The QML code looks as follows:

RegularPolygonItem {
    id: regularPolygon
    x: 817
    y: 404
    width: 133
    height: 133
    radius: 10
    strokeColor: "#262525"
    fillColor: "#766e6e"
}

RegularPolygonItem {
    id: regularPolygon1
    x: 973
    y: 404
    width: 133
    height: 133
    sideCount: 15
    gradient: RadialGradient {
        GradientStop {
            position: 0
            color: "#c56060"
        }

        GradientStop {
            position: 1
            color: "#665e5e"
        }
        focalY: regularPolygon1.height * 0.5
        focalX: regularPolygon1.width * 0.5
        focalRadius: Math.min(regularPolygon1.width, regularPolygon1.height) * 0
        centerY: regularPolygon1.height * 0.5
        centerX: regularPolygon1.width * 0.5
        centerRadius: Math.min(regularPolygon1.width, regularPolygon1.height) * 0.5
    }
    strokeColor: "#262525"
}

RegularPolygonItem {
    id: regularPolygon2
    x: 817
    y: 567
    width: 133
    height: 133
    gradient: ConicalGradient {
        centerY: regularPolygon2.height * 0.5
        centerX: regularPolygon2.width * 0.5
        angle: 0

        GradientStop {
            position: 0
            color: "#fc8e8e"
        }

        GradientStop {
            position: 1
            color: "#f0b9b9"
        }
    }
    joinStyle: 1
    strokeStyle: 4
    strokeColor: "#262525"
    sideCount: 10
}

RegularPolygonItem {
    id: regularPolygon3
    x: 973
    y: 567
    width: 133
    height: 133
    strokeWidth: -1
    strokeColor: "#262525"
    sideCount: 7
    gradient: RadialGradient {
        GradientStop {
            position: 0.21053
            color: "#60c2c5"
        }

        GradientStop {
            position: 1
            color: "#deb2b2"
        }
        focalY: regularPolygon3.height * 0.5
        focalX: regularPolygon3.width * 0.5
        focalRadius: Math.min(regularPolygon3.width, regularPolygon3.height) * 0
        centerY: regularPolygon3.height * 0.5
        centerX: regularPolygon3.width * 0.5
        centerRadius: Math.min(regularPolygon3.width, regularPolygon3.height) * 0.5
    }
}

Property Documentation

capStyle : int

The cap style defines how the end points of lines are drawn using QPainter. The cap style only applies to lines with width 1 or greater. The cap style can be square, flat, or round.

The default is Qt::SquareCap

See also QPen::capStyle().


dashOffset : alias

The starting point of the dash pattern for the regular polygon border.

The offset is measured in terms of the units used to specify the dash pattern. For example, a pattern where each stroke is four units long, followed by a gap of two units, will begin with the stroke when drawn as a line. However, if the dash offset is set to 4.0, any line drawn will begin with the gap. Values of the offset up to 4.0 will cause part of the stroke to be drawn first, and values of the offset between 4.0 and 6.0 will cause the line to begin with part of the gap.

The default value is 0.

See also QPen::setDashOffset().


dashPattern : alias

The dash pattern of the regular polygon border specified as the dashes and the gaps between them.

The dash pattern is specified in units of the pen's width. That is, a dash with the length 5 and width 10 is 50 pixels long.

Each dash is also subject to cap styles, and therefore a dash of 1 with square cap set will extend 0.5 pixels out in each direction resulting in a total width of 2.

The default value is (4, 2), meaning a dash of 4 * strokeWidth pixels followed by a space of 2 * strokeWidth pixels.

See also QPen::setDashPattern().


fillColor : alias

The regular polygon fill color.

A regular polygon can be filled with a solid color or with any of the linear, radial, or conical gradients.

When set to transparent, no filling occurs.

The default value is white.


gradient : alias

The gradient of the regular polygon fill color.

By default, no gradient is enabled and the value is null. In this case, the fill uses a solid color based on the value of fillColor.

When set, fillColor is ignored and filling is done using one of the ShapeGradient subtypes.


joinStyle : int

The join style is used to connect two border line segments.

ConstantDescription
ShapePath.MiterJoinThe outer edges of the lines are extended to meet at an angle, and this area is filled.
ShapePath.BevelJoinThe triangular notch between the two lines is filled. This is the default value.
ShapePath.RoundJoinA circular arc between the two lines is filled.

See also Qt::PenJoinStyle.


radius : int

The radius used to draw rounded corners. The default value is 10. If radius is non-zero, the corners will be rounded, otherwise they will be sharp.


sideCount : int

The number of edges on the regular polygon. The minimum number of edges can be 3. The default value is 6.


strokeColor : alias

The color used to draw the border of the regular polygon. When set to transparent, no line is drawn. The default value is red.

See also QColor.


strokeStyle : int

The style of the regular polygon stroke.

When set to None, no stroke is drawn.

The stroke can be set to have a Solid, Dash, Dot, Dash Dot, or Dash Dot Dot pattern.

The default value is Solid.


strokeWidth : alias

The width of the border of the regular polygon. The default value is 4. A width of 1 creates a thin line. For no line, use a negative value or a transparent color.

Note: The width of the regular polygon's border does not affect the geometry of the regular polygon itself or its position relative to other items if anchors are used.

The border is rendered within the regular polygon's boundaries.


© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.