PySide6.Qt3DRender.Qt3DRender.QSubtreeEnabler

class QSubtreeEnabler

Enables or disables entire subtrees of framegraph nodes. More…

Synopsis

Properties

• enablementᅟ

Methods

• def __init__()

• def enablement()

• def requestUpdate()

• def setEnablement()

Signals

• def enablementChanged()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

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

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property enablementᅟ: Qt3DRender.QSubtreeEnabler.Enablement

Controls whether subtree enablement is persistent or transient.

Access functions:

• enablement()

• setEnablement()

• Signal enablementChanged()

__init__([parent=None])

Parameters:

parent – QNode

enablement()

Return type:

Enablement

See also

setEnablement()

Getter of property enablementᅟ .

enablementChanged(enablement)

Parameters:

enablement – Enablement

Notification signal of property enablementᅟ .

requestUpdate()

Requests that the subtree be enabled.

A convenience method intended to be used with SingleShot enablement.

setEnablement(enablement)

Parameters:

enablement – Enablement

See also

enablement()

Setter of property enablementᅟ .