Scene Graph - Custom Geometry¶

Shows how to implement a custom geometry in the Qt Quick Scene Graph.

The custom geometry example shows how to create a QQuickItem which uses the scene graph API to build a custom geometry for the scene graph. It does this by creating a BezierCurve item which is made part of the CustomGeometry module and makes use of this in a QML file.

BezierCurve Declaration¶

from PySide6.QtQuick import QtQuick/QQuickItem
class BezierCurve(QQuickItem):

    Q_OBJECT
    Q_PROPERTY(QPointF p1 READ p1 WRITE setP1 NOTIFY p1Changed)
    Q_PROPERTY(QPointF p2 READ p2 WRITE setP2 NOTIFY p2Changed)
    Q_PROPERTY(QPointF p3 READ p3 WRITE setP3 NOTIFY p3Changed)
    Q_PROPERTY(QPointF p4 READ p4 WRITE setP4 NOTIFY p4Changed)
    Q_PROPERTY(int segmentCount READ segmentCount WRITE setSegmentCount NOTIFY segmentCountChanged)

    QML_ELEMENT

# public
    BezierCurve(QQuickItem parent = 0)
    ~BezierCurve()

    updatePaintNode = QSGNode(QSGNode , UpdatePaintNodeData )

    QPointF p1() { return m_p1; }
    QPointF p2() { return m_p2; }
    QPointF p3() { return m_p3; }
    QPointF p4() { return m_p4; }
    int segmentCount() { return m_segmentCount; }
    def setP1(p):
    def setP2(p):
    def setP3(p):
    def setP4(p):
    def setSegmentCount(count):
signals:
    def p1Changed(p):
    def p2Changed(p):
    def p3Changed(p):
    def p4Changed(p):
    def segmentCountChanged(count):
# private
    m_p1 = QPointF()
    m_p2 = QPointF()
    m_p3 = QPointF()
    m_p4 = QPointF()
    m_segmentCount = int()

The item declaration subclasses the QQuickItem class and adds five properties. One for each of the four control points in the bezier curve and a parameter to control the number of segments the curve is subdivided into. For each of the properties we have corresponding getter and setter functions. Since these properties can be bound to in QML, it is also preferable to have notifier signals for each of them so changes will be picked up the QML engine and used accordingly.

updatePaintNode = QSGNode(QSGNode , UpdatePaintNodeData )

The synchronization point between the QML scene and the rendering scene graph is the virtual function updatePaintNode() which all items with custom scene graph logic must implement.

Note

The scene graph will on many hardware configurations be rendering on a separate thread. It is therefore crucial that interaction with the scene graph happens in a controlled manner, first and foremost through the updatePaintNode() function.

BezierCurve Implementation¶

def __init__(self, parent):
    QQuickItem.__init__(self, parent)
    , m_p1(0, 0)
    , m_p2(1, 0)
    , m_p3(0, 1)
    , m_p4(1, 1)
    , m_segmentCount(32)

    setFlag(ItemHasContents, True)

The BezierCurve constructor sets up default values for the control points and the number of segments. The bezier curve is specified in normalized coordinates relative to the item’s bounding rectangle.

The constructor also sets the flag ItemHasContents . This flags tells the canvas that this item provides visual content and will call updatePaintNode() when it is time for the QML scene to be synchronized with the rendering scene graph.

BezierCurve::~BezierCurve()

The BezierCurve class has no data members that need to be cleaned up so the destructor does nothing. It is worth mentioning that the rendering scene graph is managed by the scene graph it self, potentially in a different thread, so one should never retain QSGNode references in the QQuickItem class nor try to clean them up explicitly.

def setP1(self, p):

    if (p == m_p1)
        return
    m_p1 = p
    p1Changed.emit(p)
    update()

The setter function for the p1 property checks if the value is unchanged and exits early if this is the case. Then it updates the internal value and emits the changed signal. It then proceeds to call the update() function which will notify the rendering scene graph, that the state of this object has changed and needs to be synchronized with the rendering scene graph. A call to update() will result in a call to updatePaintNode() at a later time.

The other property setters are equivalent, and are omitted from this example.

BezierCurve::updatePaintNode = QSGNode(QSGNode oldNode, UpdatePaintNodeData )

    node = None()
    geometry = None()
    if (not oldNode) {
        node = QSGGeometryNode

The updatePaintNode() function is the primary integration point for synchronizing the state of the QML scene with the rendering scene graph. The function gets passed a QSGNode which is the instance that was returned on the last call to the function. It will be null the first time the function gets called and we create our QSGGeometryNode which we will fill with geometry and a material.

geometry = QSGGeometry(QSGGeometry.defaultAttributes_Point2D(), m_segmentCount)
geometry.setLineWidth(2)
geometry.setDrawingMode(QSGGeometry.DrawLineStrip)
node.setGeometry(geometry)
node.setFlag(QSGNode.OwnsGeometry)

We then create the geometry and add it to the node. The first argument to the QSGGeometry constructor is a definition of the vertex type, called an “attribute set”. Since the graphics often used in QML centers around a few common standard attribute sets, these are provided by default. Here we use the Point2D attribute set which has two floats, one for x coordinates and one for y coordinates. The second argument is the vertex count.

Custom attribute sets can also created, but that is not covered in this example.

Since we do not have any special needs for memory managing the geometry, we specify that the QSGGeometryNode should own the geometry.

To minimize allocations, reduce memory fragmentation and improve performance, it would also be possible to make the geometry a member of a QSGGeometryNode subclass, in which case, we would not have set the QSGGeometryNode::OwnsGeometry flag.

material = QSGFlatColorMaterial()
material.setColor(QColor(255, 0, 0))
node.setMaterial(material)
node.setFlag(QSGNode.OwnsMaterial)

The scene graph API provides a few commonly used material implementations. In this example we use the QSGFlatColorMaterial which will fill the shape defined by the geometry with a solid color. Again we pass the ownership of the material to the node, so it can be cleaned up by the scene graph.

else:
    node = QSGGeometryNode (oldNode)
    geometry = node.geometry()
    geometry.allocate(m_segmentCount)

In the case where the QML item has changed and we only want to modify the existing node’s geometry, we cast the oldNode to a QSGGeometryNode instance and extract it’s geometry. In case the segment count has changed, we call allocate() to make sure it has the right number of vertices.

itemSize = size()
QSGGeometry.Point2D vertices = geometry.vertexDataAsPoint2D()
for i in range(0, m_segmentCount):
    t = i / qreal(m_segmentCount - 1)
    invt = 1 - t
    pos = invt * invt * invt * m_p1
                + 3 * invt * invt * t * m_p2
                + 3 * invt * t * t * m_p3
                + t * t * t * m_p4
    x = pos.x() * itemSize.width()
    y = pos.y() * itemSize.height()
    vertices[i].set(x, y)

node.markDirty(QSGNode.DirtyGeometry)

To fill the geometry, we first extract the vertex array from it. Since we are using one of the default attribute sets, we can use the convenience function vertexDataAsPoint2D() . Then we go through each segment and calculate its position and write that value to the vertex.

return node

In the end of the function, we return the node so the scene graph can render it.

Application Entry-Point¶

if __name__ == "__main__":

    app = QGuiApplication(argc, argv)
    view = QQuickView()
    format = view.format()
    format.setSamples(16)
    view.setFormat(format)
    view.setSource(QUrl("qrc:///scenegraph/customgeometry/main.qml"))
    view.show()
    sys.exit(app.exec())

The application is a straightforward QML application, with a QGuiApplication and a QQuickView that we pass a .qml file.

QML_ELEMENT

To make use of the BezierCurve item, we need to register it in the QML engine, using the QML_ELEMENT macro. This gives it the name BezierCurve and makes it part of the CustomGeometry 1.0 module as defined in the customgeometry.pro file:

<Code snippet "/tmp/snapshot-qt5full-6.2/qt5/qtbase/scenegraph/customgeometry/customgeometry.pro" not found>

As the bezier curve is drawn as line strips, we specify that the view should be multisampled to get antialiasing. This is not required, but it will make the item look a bit nicer on hardware that supports it. Multisampling is not enabled by default because it often results in higher memory usage.

Using the Item¶

import QtQuick 2.0
import CustomGeometry 1.0

Our .qml file imports the QtQuick 2.0 module to get the standard types and also our own CustomGeometry 1.0 module which contains our newly created BezierCurve objects.

Item {
    width: 300
    height: 200

    BezierCurve {
        id: line
        anchors.fill: parent
        anchors.margins: 20

Then we create the our root item and an instance of the BezierCurve which we anchor to fill the root.

    property real t
    SequentialAnimation on t {
        NumberAnimation { to: 1; duration: 2000; easing.type: Easing.InOutQuad }
        NumberAnimation { to: 0; duration: 2000; easing.type: Easing.InOutQuad }
        loops: Animation.Infinite
    }

    p2: Qt.point(t, 1 - t)
    p3: Qt.point(1 - t, t)
}

To make the example a bit more interesting we add an animation to change the two control points in the curve. The end points stay unchanged.

    Text {
        anchors.bottom: line.bottom

        x: 20
        width: parent.width - 40
        wrapMode: Text.WordWrap

        text: "This curve is a custom scene graph item, implemented using line strips"
    }
}

Finally we overlay a short text outlining what the example shows.

Example project @ code.qt.io

Table of Contents

Previous topic

Next topic