QAbstractRayCaster

An abstract base class for ray casting in 3d scenes. More

Inheritance diagram of PySide6.Qt3DRender.Qt3DRender.QAbstractRayCaster

Inherited by: QScreenRayCaster, QRayCaster

New in version 5.11.

Synopsis

Functions

Detailed Description

QAbstractRayCaster is an abstract base class for casting rays into a 3d scene. QAbstractRayCaster can not be directly instantiated, but rather through its subclasses. QAbstractRayCaster specifies common properties for all ray casters, such as run mode and layer handling, while leaving the actual ray casting details to the subclasses.

Ray castings differs from picking (using QObjectPicker ) in that it does not require mouse events to trigger.

By default, the instances of QAbstractRayCaster are disabled. When enabled, the specified ray will be tested for intersecting objects at every frame. The hits property will be updated with the results of the ray casting, even if no objects are found.

The QPickingSettings can be used to control the ray casting, such as which primitives are tested and how the results are returned.

Furthermore, QLayer components can be used to control how entities, or entity sub-graphs, react to ray casting.

Note

Components derived from QAbstractRayCaster should not be shared amount multiple entities.

See also

QRayCaster QScreenRayCaster QObjectPicker QPickingSettings QNoPicking

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

parentPySide6.Qt3DCore.Qt3DCore.QNode

PySide6.Qt3DRender.Qt3DRender.QAbstractRayCaster.RunMode

This enumeration specifies how often ray casting is performed

Constant

Description

Qt3DRender.QAbstractRayCaster.Continuous

Ray casting is performed at every frame as long as the component is enabled.

Qt3DRender.QAbstractRayCaster.SingleShot

Ray casting is done once then the component disables itself. This is the default

PySide6.Qt3DRender.Qt3DRender.QAbstractRayCaster.FilterMode

Specifies the rules for selecting entities to test for raycasting.

Constant

Description

Qt3DRender.QAbstractRayCaster.AcceptAnyMatchingLayers

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

Qt3DRender.QAbstractRayCaster.AcceptAllMatchingLayers

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

Qt3DRender.QAbstractRayCaster.DiscardAnyMatchingLayers

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

Qt3DRender.QAbstractRayCaster.DiscardAllMatchingLayers

Discard entities that reference all QLayer objects added to this QAbstractRayCaster

PySide6.Qt3DRender.Qt3DRender.QAbstractRayCaster.addLayer(layer)
Parameters

layerPySide6.Qt3DRender.Qt3DRender.QLayer

Add layer to the current list of layers

PySide6.Qt3DRender.Qt3DRender.QAbstractRayCaster.filterMode()
Return type

FilterMode

See also

setFilterMode()

PySide6.Qt3DRender.Qt3DRender.QAbstractRayCaster.filterModeChanged(filterMode)
Parameters

filterModeFilterMode

PySide6.Qt3DRender.Qt3DRender.QAbstractRayCaster.hits()
Return type

PySide6.Qt3DRender.Qt3DRender.QAbstractRayCaster.hitsChanged(hits)
Parameters

hits

PySide6.Qt3DRender.Qt3DRender.QAbstractRayCaster.layers()
Return type

Returns the current list of layers

PySide6.Qt3DRender.Qt3DRender.QAbstractRayCaster.removeLayer(layer)
Parameters

layerPySide6.Qt3DRender.Qt3DRender.QLayer

Remove layer from the current list of layers

PySide6.Qt3DRender.Qt3DRender.QAbstractRayCaster.runMode()
Return type

RunMode

See also

setRunMode()

PySide6.Qt3DRender.Qt3DRender.QAbstractRayCaster.runModeChanged(runMode)
Parameters

runModeRunMode

PySide6.Qt3DRender.Qt3DRender.QAbstractRayCaster.setFilterMode(filterMode)
Parameters

filterModeFilterMode

See also

filterMode()

PySide6.Qt3DRender.Qt3DRender.QAbstractRayCaster.setRunMode(runMode)
Parameters

runModeRunMode

See also

runMode()