MapPolygon QML Type

The MapPolygon type displays a polygon on a Map. More...

• List of all members, including inherited members

Properties

• autoFadeIn : bool
• backend : MapPolygon.Backend
• border
  • border.color : color
  • border.width : int
• color : color
• path : list<coordinate>

Methods

• void addCoordinate(coordinate)
• void removeCoordinate(coordinate)

Detailed Description

The MapPolygon type displays a polygon on a Map, specified in terms of an ordered list of coordinates. For best appearance and results, polygons should be simple (not self-intersecting).

The coordinates on the path cannot be directly changed after being added to the Polygon. Instead, copy the path into a var, modify the copy and reassign the copy back to the path.

var path = mapPolygon.path;
path[0].latitude = 5;
mapPolygon.path = path;

Coordinates can also be added and removed at any time using the addCoordinate and removeCoordinate methods.

For drawing rectangles with "straight" edges (same latitude across one edge, same latitude across the other), the MapRectangle type provides a simpler, two-point API.

By default, the polygon is displayed as a 1 pixel black border with no fill. To change its appearance, use the color, border.color and border.width properties.

Performance

MapPolygons have a rendering cost that is O(n) with respect to the number of vertices. This means that the per frame cost of having a Polygon on the Map grows in direct proportion to the number of points on the Polygon. There is an additional triangulation cost (approximately O(n log n)) which is currently paid with each frame, but in future may be paid only upon adding or removing points.

Like the other map objects, MapPolygon is normally drawn without a smooth appearance. Setting the opacity property will force the object to be blended, which decreases performance considerably depending on the hardware in use.

Example Usage

The following snippet shows a MapPolygon being used to display a triangle, with three vertices near Brisbane, Australia. The triangle is filled in green, with a 1 pixel black border.

Map {
    MapPolygon {
        color: 'green'
        path: [
            { latitude: -27, longitude: 153.0 },
            { latitude: -27, longitude: 154.1 },
            { latitude: -28, longitude: 153.5 }
        ]
    }
}

Property Documentation

Method Documentation