Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QSGTransformNode Class Reference

The QSGTransformNode class implements transformations in the scene graph. More...

#include <qsgnode.h>

+ Inheritance diagram for QSGTransformNode:
+ Collaboration diagram for QSGTransformNode:

Public Member Functions

 QSGTransformNode ()
 Create a new QSGTransformNode with its matrix set to the identity matrix.
 
 ~QSGTransformNode () override
 Deletes this transform node.
 
void setMatrix (const QMatrix4x4 &matrix)
 Sets this transform node's matrix to matrix.
 
const QMatrix4x4 & matrix () const
 Returns this transform node's matrix.
 
void setCombinedMatrix (const QMatrix4x4 &matrix)
 Sets the combined matrix of this matrix to transform.
 
const QMatrix4x4 & combinedMatrix () const
 Set during rendering to the combination of all parent matrices for that rendering pass.
 
- Public Member Functions inherited from QSGNode
 QSGNode ()
 Constructs a new node.
 
virtual ~QSGNode ()
 Destroys the node.
 
QSGNode * parent () const
 Returns the parent node of this node.
 
void removeChildNode (QSGNode *node)
 Removes node from this node's list of children.
 
void removeAllChildNodes ()
 Removes all child nodes from this node's list of children.
 
void prependChildNode (QSGNode *node)
 Prepends node to this node's the list of children.
 
void appendChildNode (QSGNode *node)
 Appends node to this node's list of children.
 
void insertChildNodeBefore (QSGNode *node, QSGNode *before)
 Inserts node to this node's list of children before the node specified with before.
 
void insertChildNodeAfter (QSGNode *node, QSGNode *after)
 Inserts node to this node's list of children after the node specified with after.
 
void reparentChildNodesTo (QSGNode *newParent)
 
int childCount () const
 Returns the number of child nodes.
 
QSGNode * childAtIndex (int i) const
 Returns the child at index i.
 
QSGNode * firstChild () const
 Returns the first child of this node.
 
QSGNode * lastChild () const
 Returns the last child of this node.
 
QSGNode * nextSibling () const
 Returns the node after this in the parent's list of children.
 
QSGNode * previousSibling () const
 Returns the node before this in the parent's list of children.
 
NodeType type () const
 Returns the type of this node.
 
QT_DEPRECATED void clearDirty ()
 
void markDirty (DirtyState bits)
 Notifies all connected renderers that the node has dirty bits.
 
QT_DEPRECATED DirtyState dirtyState () const
 
virtual bool isSubtreeBlocked () const
 Returns whether this node and its subtree is available for use.
 
Flags flags () const
 Returns the set of flags for this node.
 
void setFlag (Flag, bool=true)
 Sets the flag f on this node if enabled is true; otherwise clears the flag.
 
void setFlags (Flags, bool=true)
 Sets the flags f on this node if enabled is true; otherwise clears the flags.
 
virtual void preprocess ()
 Override this function to do processing on the node before it is rendered.
 

Additional Inherited Members

- Public Types inherited from QSGNode
enum  NodeType {
  BasicNodeType , GeometryNodeType , TransformNodeType , ClipNodeType ,
  OpacityNodeType , RootNodeType , RenderNodeType
}
 Can be used to figure out the type of node. More...
 
enum  Flag {
  OwnedByParent = 0x0001 , UsePreprocess = 0x0002 , OwnsGeometry = 0x00010000 , OwnsMaterial = 0x00020000 ,
  OwnsOpaqueMaterial = 0x00040000 , IsVisitableNode = 0x01000000
}
 The QSGNode::Flag enum describes flags on the QSGNode. More...
 
enum  DirtyStateBit {
  DirtySubtreeBlocked = 0x0080 , DirtyMatrix = 0x0100 , DirtyNodeAdded = 0x0400 , DirtyNodeRemoved = 0x0800 ,
  DirtyGeometry = 0x1000 , DirtyMaterial = 0x2000 , DirtyOpacity = 0x4000 , DirtyForceUpdate = 0x8000 ,
  DirtyUsePreprocess = UsePreprocess , DirtyPropagationMask
}
 Used in QSGNode::markDirty() to indicate how the scene graph has changed. More...
 
- Protected Member Functions inherited from QSGNode
 QSGNode (NodeType type)
 Constructs a new node with the given node type.
 
 QSGNode (QSGNodePrivate &dd, NodeType type)
 Constructs a new node with the given node type.
 
- Protected Attributes inherited from QSGNode
QScopedPointer< QSGNodePrivate > d_ptr
 

Detailed Description

The QSGTransformNode class implements transformations in the scene graph.

\inmodule QtQuick

Transformations apply the node's subtree and can be nested. Multiple transform nodes will be accumulated by intersecting all their matrices. The accumulation happens as part of the rendering.

The transform nodes implement a 4x4 matrix which in theory supports full 3D transformations. However, because the renderer optimizes for 2D use-cases rather than 3D use-cases, rendering a scene with full 3D transformations needs to be done with some care.

Note
All classes with QSG prefix should be used solely on the scene graph's rendering thread. See \l {Scene Graph and Rendering} for more information.

Definition at line 240 of file qsgnode.h.

Constructor & Destructor Documentation

◆ QSGTransformNode()

QSGTransformNode::QSGTransformNode ( )

Create a new QSGTransformNode with its matrix set to the identity matrix.

Definition at line 1133 of file qsgnode.cpp.

Referenced by QQuickBasicBusyIndicatorNode::QQuickBasicBusyIndicatorNode(), QQuickBasicProgressBarNode::sync(), QQuickMaterialProgressBarNode::sync(), QQuickUniversalBusyIndicatorNode::sync(), and QQuickUniversalProgressBarNode::sync().

+ Here is the caller graph for this function:

◆ ~QSGTransformNode()

QSGTransformNode::~QSGTransformNode ( )
override

Deletes this transform node.

Definition at line 1144 of file qsgnode.cpp.

Member Function Documentation

◆ combinedMatrix()

const QMatrix4x4 & QSGTransformNode::combinedMatrix ( ) const
inline

Set during rendering to the combination of all parent matrices for that rendering pass.

Definition at line 250 of file qsgnode.h.

◆ matrix()

QMatrix4x4 QSGTransformNode::matrix ( ) const
inline

Returns this transform node's matrix.

Definition at line 247 of file qsgnode.h.

Referenced by setCombinedMatrix(), setMatrix(), QQuickMaterialRippleBackgroundNode::sync(), QQuickUniversalBusyIndicatorNode::sync(), QQuickUniversalBusyIndicatorNode::updateCurrentTime(), QQuickUniversalProgressBarNode::updateCurrentTime(), QGeoTiledMapRootNode::updateTiles(), QSGOpenVGNodeVisitor::visit(), and QSGSoftwareRenderableNodeUpdater::visit().

+ Here is the caller graph for this function:

◆ setCombinedMatrix()

void QSGTransformNode::setCombinedMatrix ( const QMatrix4x4 & matrix)

Sets the combined matrix of this matrix to transform.

This function is meant to be called by the node preprocessing prior to rendering the tree, so it will not mark the tree as dirty.

Definition at line 1188 of file qsgnode.cpp.

References matrix().

+ Here is the call graph for this function:

◆ setMatrix()

void QSGTransformNode::setMatrix ( const QMatrix4x4 & matrix)

Sets this transform node's matrix to matrix.

Definition at line 1162 of file qsgnode.cpp.

References QSGNode::DirtyMatrix, QSGNode::markDirty(), and matrix().

Referenced by QQuickBasicBusyIndicatorNode::sync(), QQuickBasicProgressBarNode::sync(), QQuickMaterialProgressBarNode::sync(), QQuickMaterialRippleBackgroundNode::sync(), QQuickUniversalBusyIndicatorNode::sync(), QQuickBasicProgressBarNode::updateCurrentTime(), QQuickMaterialRippleWaveNode::updateCurrentTime(), QQuickUniversalBusyIndicatorNode::updateCurrentTime(), updateNodeTransform(), QQuickText::updatePaintNode(), QQuickPaddedRectangle::updatePaintNode(), QQuickTextInput::updatePaintNode(), and QGeoTiledMapRootNode::updateTiles().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:
The documentation for this class was generated from the following files: