QLayerFilter#
Controls layers drawn in a frame graph branch. More…
Synopsis#
Properties#
Functions#
def
addLayer
(layer)def
filterMode
()def
layers
()def
removeLayer
(layer)def
setFilterMode
(filterMode)
Signals#
def
filterModeChanged
(filterMode)
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#
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 PySide6.Qt3DRender.Qt3DRender.QLayerFilter([parent=None])#
- Parameters:
parent –
PySide6.Qt3DCore.Qt3DCore.QNode
The constructor creates an instance with the specified parent
.
Note
Properties can be used directly when from __feature__ import true_property
is used or via accessor functions otherwise.
- property PᅟySide6.Qt3DRender.Qt3DRender.QLayerFilter.filterMode: FilterMode#
Holds the filter mode specifying the entities to select for drawing.
The default value is AcceptMatchingLayers.
- Access functions:
filterMode
()setFilterMode
(filterMode)Signal
filterModeChanged
(filterMode)
- PySide6.Qt3DRender.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 thisQLayerFilter
. This is the defaultQt3DRender.QLayerFilter.AcceptAllMatchingLayers
Accept entities that reference all the
QLayer
objects added to thisQLayerFilter
Qt3DRender.QLayerFilter.DiscardAnyMatchingLayers
Discard entities that reference one or more
QLayer
objects added to thisQLayerFilter
Qt3DRender.QLayerFilter.DiscardAllMatchingLayers
Discard entities that reference all
QLayer
objects added to thisQLayerFilter
- PySide6.Qt3DRender.Qt3DRender.QLayerFilter.addLayer(layer)#
- Parameters:
Add layer
to the current list of layers
- PySide6.Qt3DRender.Qt3DRender.QLayerFilter.filterMode()#
- Return type:
See also
Getter of property filterMode
.
- PySide6.Qt3DRender.Qt3DRender.QLayerFilter.filterModeChanged(filterMode)#
- Parameters:
filterMode –
FilterMode
Notification signal of property filterMode
.
- PySide6.Qt3DRender.Qt3DRender.QLayerFilter.layers()#
- Return type:
.list of Qt3DRender.QLayer
Returns the current list of layers
- PySide6.Qt3DRender.Qt3DRender.QLayerFilter.removeLayer(layer)#
- Parameters:
Remove layer
from the current list of layers
- PySide6.Qt3DRender.Qt3DRender.QLayerFilter.setFilterMode(filterMode)#
- Parameters:
filterMode –
FilterMode
See also
Setter of property filterMode
.