Qt3DRender.QPickingSettings

The QPickingSettings class specifies how entity picking is handled. More…

Synopsis

Functions

• def faceOrientationPickingMode ()

• def pickMethod ()

• def pickResultMode ()

• def worldSpaceTolerance ()

Slots

• def setFaceOrientationPickingMode (faceOrientationPickingMode)

• def setPickMethod (pickMethod)

• def setPickResultMode (pickResultMode)

• def setWorldSpaceTolerance (worldSpaceTolerance)

Signals

• def faceOrientationPickingModeChanged (faceOrientationPickingMode)

• def pickMethodChanged (pickMethod)

• def pickResultModeChanged (pickResult)

• def worldSpaceToleranceChanged (worldSpaceTolerance)

Detailed Description

The picking settings determine how the entity picking is handled. For more details about entity picking, see QObjectPicker and QRayCaster component documentation.

When using QObjectPicker components, picking is triggered by mouse events.

When using QRayCaster or QScreenRayCaster components, picking can be explicitly triggered by the application.

In both cases, a ray will be cast through the scene to find geometry intersecting the ray.

See also

QObjectPicker QPickEvent QPickTriangleEvent QRayCaster QScreenRayCaster

class PySide2.Qt3DRender.Qt3DRender.QPickingSettings([parent=None])

Parameters

parent – QNode

PySide2.Qt3DRender.Qt3DRender.QPickingSettings.PickMethod

Specifies the picking method.

Constant	Description
Qt3DRender.QPickingSettings.BoundingVolumePicking	An entity is considered picked if the picking ray intersects the bounding volume of the entity (default).
Qt3DRender.QPickingSettings.TrianglePicking	An entity is considered picked if the picking ray intersects with any triangle of the entity’s mesh component.
Qt3DRender.QPickingSettings.LinePicking	An entity is considered picked if the picking ray intersects with any edge of the entity’s mesh component.
Qt3DRender.QPickingSettings.PointPicking	An entity is considered picked if the picking ray intersects with any point of the entity’s mesh component.
Qt3DRender.QPickingSettings.PrimitivePicking	An entity is considered picked if the picking ray intersects with any point, edge or triangle of the entity’s mesh component.

PySide2.Qt3DRender.Qt3DRender.QPickingSettings.PickResultMode

Specifies what is included into the picking results.

Constant	Description
Qt3DRender.QPickingSettings.NearestPick	Only the nearest entity to picking ray origin intersected by the picking ray is picked (default).
Qt3DRender.QPickingSettings.AllPicks	All entities that intersect the picking ray are picked.

See also

QPickEvent

PySide2.Qt3DRender.Qt3DRender.QPickingSettings.FaceOrientationPickingMode

Specifies how face orientation affects triangle picking

Constant	Description
Qt3DRender.QPickingSettings.FrontFace	Only front-facing triangles will be picked (default).
Qt3DRender.QPickingSettings.BackFace	Only back-facing triangles will be picked.
Qt3DRender.QPickingSettings.FrontAndBackFace	Both front- and back-facing triangles will be picked.

PySide2.Qt3DRender.Qt3DRender.QPickingSettings.faceOrientationPickingMode()

Return type

FaceOrientationPickingMode

See also

setFaceOrientationPickingMode()

PySide2.Qt3DRender.Qt3DRender.QPickingSettings.faceOrientationPickingModeChanged(faceOrientationPickingMode)

Parameters

faceOrientationPickingMode – FaceOrientationPickingMode

PySide2.Qt3DRender.Qt3DRender.QPickingSettings.pickMethod()

Return type

PickMethod

See also

setPickMethod()

PySide2.Qt3DRender.Qt3DRender.QPickingSettings.pickMethodChanged(pickMethod)

Parameters

pickMethod – PickMethod

PySide2.Qt3DRender.Qt3DRender.QPickingSettings.pickResultMode()

Return type

PickResultMode

See also

setPickResultMode()

PySide2.Qt3DRender.Qt3DRender.QPickingSettings.pickResultModeChanged(pickResult)

Parameters

pickResult – PickResultMode

PySide2.Qt3DRender.Qt3DRender.QPickingSettings.setFaceOrientationPickingMode(faceOrientationPickingMode)

Parameters

faceOrientationPickingMode – FaceOrientationPickingMode

See also

faceOrientationPickingMode()

PySide2.Qt3DRender.Qt3DRender.QPickingSettings.setPickMethod(pickMethod)

Parameters

pickMethod – PickMethod

See also

pickMethod()

PySide2.Qt3DRender.Qt3DRender.QPickingSettings.setPickResultMode(pickResultMode)

Parameters

pickResultMode – PickResultMode

See also

pickResultMode()

PySide2.Qt3DRender.Qt3DRender.QPickingSettings.setWorldSpaceTolerance(worldSpaceTolerance)

Parameters

worldSpaceTolerance – float

Sets the threshold used for line and point picking to worldSpaceTolerance .

See also

worldSpaceTolerance()

PySide2.Qt3DRender.Qt3DRender.QPickingSettings.worldSpaceTolerance()

Return type

float

Returns the line and point precision worldSpaceTolerance

See also

setWorldSpaceTolerance()

PySide2.Qt3DRender.Qt3DRender.QPickingSettings.worldSpaceToleranceChanged(worldSpaceTolerance)

Parameters

worldSpaceTolerance – float