QPickingSettings¶

PyQt5.Qt3DRender.QPickingSettings: Inherits from QNode.

Description¶

The QPickingSettings class specifies how entity picking is handled.

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.

Enums¶

FaceOrientationPickingMode

Specifies how face orientation affects triangle picking

Member	Value	Description
BackFace	0x02	Only back-facing triangles will be picked.
FrontAndBackFace	0x03	Both front- and back-facing triangles will be picked.
FrontFace	0x01	Only front-facing triangles will be picked (default).

PickMethod

Specifies the picking method.

Member	Value	Description
BoundingVolumePicking	0x00	An entity is considered picked if the picking ray intersects the bounding volume of the entity (default).
LinePicking	0x02	An entity is considered picked if the picking ray intersects with any edge of the entity’s mesh component.
PointPicking	0x04	An entity is considered picked if the picking ray intersects with any point of the entity’s mesh component.
PrimitivePicking	TrianglePicking \| LinePicking \| PointPicking	An entity is considered picked if the picking ray intersects with any point, edge or triangle of the entity’s mesh component.
TrianglePicking	0x01	An entity is considered picked if the picking ray intersects with any triangle of the entity’s mesh component.

PickResultMode

Specifies what is included into the picking results.

Methods¶

__init__(parent: QNode = None): TODO

faceOrientationPickingMode() → FaceOrientationPickingMode: See also

setFaceOrientationPickingMode().

pickMethod() → PickMethod: See also

setPickMethod().

pickResultMode() → PickResultMode: See also

setPickResultMode().

setFaceOrientationPickingMode(FaceOrientationPickingMode): See also

faceOrientationPickingMode().

setPickMethod(PickMethod): See also

pickMethod().

setPickResultMode(PickResultMode): See also

pickResultMode().

setWorldSpaceTolerance(float): Sets the threshold used for line and point picking to worldSpaceTolerance.

See also

worldSpaceTolerance().

worldSpaceTolerance() → float: Returns the line and point precision worldSpaceTolerance

See also

setWorldSpaceTolerance().

Signals¶

faceOrientationPickingModeChanged(FaceOrientationPickingMode): TODO

pickMethodChanged(PickMethod): TODO

pickResultModeChanged(PickResultMode): TODO

worldSpaceToleranceChanged(float): TODO

Member	Value	Description
AllPicks	1	All entities that intersect the picking ray are picked.
NearestPick	0	Only the nearest entity to picking ray origin intersected by the picking ray is picked (default).
NearestPriorityPick	TODO	TODO