QLayerFilter

Controls layers drawn in a frame graph branch. More

Synopsis

Functions

Signals

Detailed Description

A QLayerFilter can be used to instruct the renderer as to which layer(s) to draw in that branch of the frame graph. QLayerFilter selects which entities to draw based on the QLayer instance(s) added to the QLayerFilter and as components to QEntity .

QLayerFilter can be configured to select or discard entities with a specific QLayer depending on the filterMode property. By default, entities referencing one of the QLayer objects that are also being referenced by the QLayerFilter are selected ( AcceptAnyMatchingLayers ).

Within the FrameGraph tree, multiple QLayerFilter nodes can be nested within a branch going from root to a leaf. In that case the filtering will first operate on all entities of the scene using the filtering method specified by the first declared QLayerFilter . Then the filtered subset of entities will be filtered again based on the filtering method set on the second QLayerFilter declared. This is then repeated until all QLayerFilter nodes of the branch have been consumed.

class PySide2.Qt3DRender.QLayerFilter([parent=None])
param parent

PySide2.Qt3DCore.QNode

The constructor creates an instance with the specified parent .

PySide2.Qt3DRender.QLayerFilter.FilterMode

Specifies the rules for selecting entities to draw.

Constant

Description

Qt3DRender.QLayerFilter.AcceptAnyMatchingLayers

Accept entities that reference one or more QLayer objects added to this QLayerFilter . This is the default

Qt3DRender.QLayerFilter.AcceptAllMatchingLayers

Accept entities that reference all the QLayer objects added to this QLayerFilter

Qt3DRender.QLayerFilter.DiscardAnyMatchingLayers

Discard entities that reference one or more QLayer objects added to this QLayerFilter

Qt3DRender.QLayerFilter.DiscardAllMatchingLayers

Discard entities that reference all QLayer objects added to this QLayerFilter

PySide2.Qt3DRender.QLayerFilter.addLayer(layer)
Parameters

layerPySide2.Qt3DRender.QLayer

Add layer to the current list of layers

PySide2.Qt3DRender.QLayerFilter.filterMode()
Return type

FilterMode

Holds the filter mode specifying the entities to select for drawing.

The default value is AcceptMatchingLayers.

PySide2.Qt3DRender.QLayerFilter.filterModeChanged(filterMode)
Parameters

filterModeFilterMode

PySide2.Qt3DRender.QLayerFilter.layers()
Return type

Returns the current list of layers

PySide2.Qt3DRender.QLayerFilter.removeLayer(layer)
Parameters

layerPySide2.Qt3DRender.QLayer

Remove layer from the current list of layers

PySide2.Qt3DRender.QLayerFilter.setFilterMode(filterMode)
Parameters

filterModeFilterMode

Holds the filter mode specifying the entities to select for drawing.

The default value is AcceptMatchingLayers.