QSubtreeEnabler#

Enables or disables entire subtrees of framegraph nodes. More

Synopsis#

Functions#

Signals#

Detailed Description#

While QFrameGraphNodes can be individually enabled and disabled via the enabled property, this can become tedious when an entire path needs to be turned on or off. QSubtreeEnabler is a convenience node that makes this use case trivial, allowing all of its children to be controlled by a single switch.

QSubtreeEnabler is enabled by default.

class PySide6.Qt3DRender.Qt3DRender.QSubtreeEnabler([parent=None])#
Parameters

parentPySide6.Qt3DCore.Qt3DCore.QNode

PySide6.Qt3DRender.Qt3DRender.QSubtreeEnabler.Enablement#

Specifies whether subtree enablement is persistent or transient.

Constant

Description

Qt3DRender.QSubtreeEnabler.Persistent

The value of enabled is persistent. This is the default.

Qt3DRender.QSubtreeEnabler.SingleShot

The value of enabled will last for a single frame and then be reset to false. This might be used for a subtree drawing to an FBO, for example, to only update the FBO when the relevant portions of the scene changed.

PySide6.Qt3DRender.Qt3DRender.QSubtreeEnabler.enablement()#
Return type

Enablement

Controls whether subtree enablement is persistent or transient.

PySide6.Qt3DRender.Qt3DRender.QSubtreeEnabler.enablementChanged(enablement)#
Parameters

enablementEnablement

PySide6.Qt3DRender.Qt3DRender.QSubtreeEnabler.requestUpdate()#

Requests that the subtree be enabled.

A convenience method intended to be used with SingleShot enablement.

PySide6.Qt3DRender.Qt3DRender.QSubtreeEnabler.setEnablement(enablement)#
Parameters

enablementEnablement

Controls whether subtree enablement is persistent or transient.