Path QML Type

Defines a path for use by PathView and Shape. More...

Import Statement: import QtQuick
Inherited By:

ShapePath

Properties

Methods

Detailed Description

A Path is composed of one or more path segments - PathLine, PathPolyline, PathQuad, PathCubic, PathArc, PathAngleArc, PathCurve, PathSvg.

The spacing of the items along the Path can be adjusted via a PathPercent object.

PathAttribute allows named attributes with values to be defined along the path.

Path and the other types for specifying path elements are shared between PathView and Shape. The following table provides an overview of the applicability of the various path elements:

ElementPathViewShapeShape, software
PathMoveN/AYesYes
PathLineYesYesYes
PathPolylineYesYesYes
PathMultiLineYesYesYes
PathQuadYesYesYes
PathCubicYesYesYes
PathArcYesYesYes
PathAngleArcYesYesYes
PathSvgYesYesYes
PathAttributeYesN/AN/A
PathPercentYesN/AN/A
PathCurveYesNoNo

Note: Path is a non-visual type; it does not display anything on its own. To draw a path, use Shape.

See also PathView, Shape, PathAttribute, PathPercent, PathLine, PathPolyline, PathMove, PathQuad, PathCubic, PathArc, PathAngleArc, PathCurve, and PathSvg.

Property Documentation

startX : real

startY : real

These properties hold the starting position of the path.


[read-only] closed : bool

This property holds whether the start and end of the path are identical.


[default] pathElements : list<PathElement>

This property holds the objects composing the path.

A path can contain the following path objects:

  • PathLine - a straight line to a given position.
  • PathPolyline - a polyline specified as a list of coordinates.
  • PathMultiline - a list of polylines specified as a list of lists of coordinates.
  • PathQuad - a quadratic Bezier curve to a given position with a control point.
  • PathCubic - a cubic Bezier curve to a given position with two control points.
  • PathArc - an arc to a given position with a radius.
  • PathAngleArc - an arc specified by center point, radii, and angles.
  • PathSvg - a path specified as an SVG path data string.
  • PathCurve - a point on a Catmull-Rom curve.
  • PathAttribute - an attribute at a given position in the path.
  • PathPercent - a way to spread out items along various segments of the path.
    PathView {
        anchors.fill: parent
        model: ContactModel {}
        delegate: delegate
        path: Path {
            startX: 120; startY: 100
            PathAttribute { name: "iconScale"; value: 1.0 }
            PathAttribute { name: "iconOpacity"; value: 1.0 }
            PathQuad { x: 120; y: 25; controlX: 260; controlY: 75 }
            PathAttribute { name: "iconScale"; value: 0.3 }
            PathAttribute { name: "iconOpacity"; value: 0.5 }
            PathQuad { x: 120; y: 100; controlX: -20; controlY: 75 }
        }
    }

[since QtQuick 2.14] scale : size

This property holds the scale factor for the path. The width and height of scale can be different, to achieve anisotropic scaling.

Note: Setting this property will not affect the border width.

This property was introduced in QtQuick 2.14.


Method Documentation

[since QtQuick 2.14] point pointAtPercent(real t)

Returns the point at the percentage t of the current path. The argument t has to be between 0 and 1.

Note: Similarly to other percent methods in QPainterPath, the percentage measurement is not linear with regards to the length, if curves are present in the path. When curves are present, the percentage argument is mapped to the t parameter of the Bezier equations.

This method was introduced in QtQuick 2.14.

See also QPainterPath::pointAtPercent().


© 2023 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.