Skip to content

SGNode

Qt Base Class: QSGNode

Signature: QSGNode(self) -> None QSGNode(self, type: PySide6.QtQuick.QSGNode.NodeType) -> None

Base classes

Name Children Inherits
QSGNode
PySide6.QtQuick
QSGNode(self) -> None

⋔ Inheritance diagram

graph TD
  1473374462320["quick.SGNode"]
  1473572378432["QtQuick.QSGNode"]
  1473291690208["Shiboken.Object"]
  140713234304496["builtins.object"]
  1473572378432 --> 1473374462320
  1473291690208 --> 1473572378432
  140713234304496 --> 1473291690208

🛈 DocStrings

Bases: QSGNode

The base class for all nodes in the scene graph.

Source code in prettyqt\quick\sgnode.py 
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
class SGNode(QtQuick.QSGNode):
    """The base class for all nodes in the scene graph."""

    def __getitem__(self, index: int) -> QtQuick.QSGNode:
        return self.childAtIndex(index)

    def __delitem__(self, item: int | QtQuick.QSGNode):
        if isinstance(item, int):
            item = self.childAtIndex(item)
        self.removeChildNode(item)

    def get_type(self) -> NodeTypeStr:
        """Get the type of the node.

        Returns:
            Node type
        """
        return NODE_TYPE.inverse[self.type()]

    def get_flags(self) -> list[FlagStr]:
        return FLAG.get_list(self.flags())

    def get_children(self, recursive: bool = False) -> list[SGNode]:
        """Get children of this item.

        recursive option is written iteratively to also support original QTreeWidgetItems.
        """
        if not recursive:
            return [self.childAtIndex(i) for i in range(self.childCount())]
        results = []
        nodes = [self]
        while nodes:
            items = []
            for node in nodes:
                results.append(node)
                items.extend(node.childAtIndex(i) for i in range(node.childCount()))
            nodes = items
        return results[1:]

get_children(recursive: bool = False) -> list[SGNode]

Get children of this item.

recursive option is written iteratively to also support original QTreeWidgetItems.

Source code in prettyqt\quick\sgnode.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
def get_children(self, recursive: bool = False) -> list[SGNode]:
    """Get children of this item.

    recursive option is written iteratively to also support original QTreeWidgetItems.
    """
    if not recursive:
        return [self.childAtIndex(i) for i in range(self.childCount())]
    results = []
    nodes = [self]
    while nodes:
        items = []
        for node in nodes:
            results.append(node)
            items.extend(node.childAtIndex(i) for i in range(node.childCount()))
        nodes = items
    return results[1:]

get_type() -> NodeTypeStr

Get the type of the node.

Source code in prettyqt\quick\sgnode.py 
75
76
77
78
79
80
81
def get_type(self) -> NodeTypeStr:
    """Get the type of the node.

    Returns:
        Node type
    """
    return NODE_TYPE.inverse[self.type()]