QPickingSettings Class | Qt 3D 5.9

Qt 5.9 | Qt 3D | C++ Classes | QPickingSettings

Qt 5.9.9 Reference Documentation

# QPickingSettings Class

(Qt3DRender::QPickingSettings)

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

Header: | #include <QPickingSettings>
qmake: | QT += 3drender
Since: | Qt 5.7
Instantiated By: | PickingSettings
Inherits: | Qt3DCore::QNode

- List of all members, including inherited members

## Public Types

enum | FaceOrientationPickingMode { FrontFace, BackFace, FrontAndBackFace }
enum | PickMethod { BoundingVolumePicking, TrianglePicking }
enum | PickResultMode { NearestPick, AllPicks }

## Properties

- faceOrientationPickingMode : FaceOrientationPickingMode
- pickMethod : PickMethod
- pickResultMode : PickResultMode

- 3 properties inherited from Qt3DCore::QNode

## Public Functions

| QPickingSettings(Qt3DCore::QNode *parent = nullptr)
FaceOrientationPickingMode | faceOrientationPickingMode() const
PickMethod | pickMethod() const
PickResultMode | pickResultMode() const

- 11 public functions inherited from Qt3DCore::QNode

## Public Slots

void | setFaceOrientationPickingMode(FaceOrientationPickingMode faceOrientationPickingMode)
void | setPickMethod(PickMethod pickMethod)
void | setPickResultMode(PickResultMode pickResultMode)

- 3 public slots inherited from Qt3DCore::QNode

## Signals

void | faceOrientationPickingModeChanged(QPickingSettings::FaceOrientationPickingMode faceOrientationPickingMode)
void | pickMethodChanged(QPickingSettings::PickMethod pickMethod)
void | pickResultModeChanged(QPickingSettings::PickResultMode pickResult)

- 4 signals inherited from Qt3DCore::QNode

### Additional Inherited Members

- 2 protected functions inherited from Qt3DCore::QNode

## Detailed 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 component documentation.

Picking is triggered by mouse events. It will cast a ray through the scene and look for geometry intersecting the ray.

See also QObjectPicker, QPickEvent, and QPickTriangleEvent.

## Member Type Documentation

### enum QPickingSettings::FaceOrientationPickingMode

Specifies how face orientation affects triangle picking

Constant | Value | Description
--- | --- | ---
`Qt3DRender::QPickingSettings::FrontFace` | `0x01` | Only front-facing triangles will be picked (default).
`Qt3DRender::QPickingSettings::BackFace` | `0x02` | Only back-facing triangles will be picked.
`Qt3DRender::QPickingSettings::FrontAndBackFace` | `0x03` | Both front- and back-facing triangles will be picked.

### enum QPickingSettings::PickMethod

Specifies the picking method.

Constant | Value | Description
--- | --- | ---
`Qt3DRender::QPickingSettings::BoundingVolumePicking` | `0` | An entity is considered picked if the picking ray intersects the bounding volume of the entity (default).
`Qt3DRender::QPickingSettings::TrianglePicking` | `1` | An entity is considered picked if the picking ray intersects with any triangle of the entity's mesh component.

### enum QPickingSettings::PickResultMode

Specifies what is included into the picking results.

Constant | Value | Description
--- | --- | ---
`Qt3DRender::QPickingSettings::NearestPick` | `0` | Only the nearest entity to picking ray origin intersected by the picking ray is picked (default).
`Qt3DRender::QPickingSettings::AllPicks` | `1` | All entities that intersect the picking ray are picked.

See also Qt3DRender::QPickEvent.

## Property Documentation

### faceOrientationPickingMode : FaceOrientationPickingMode

Specifies how face orientation affects triangle picking

Access functions:

FaceOrientationPickingMode | faceOrientationPickingMode() const
void | setFaceOrientationPickingMode(FaceOrientationPickingMode faceOrientationPickingMode)

Notifier signal:

void | faceOrientationPickingModeChanged(QPickingSettings::FaceOrientationPickingMode faceOrientationPickingMode)

### pickMethod : PickMethod

Holds the current pick method.

By default, for performance reasons, ray casting will use bounding volume picking. This may however lead to unexpected results if a small object is englobed in the bounding sphere of a large object behind it.

Triangle picking will produce exact results but is computationally more expensive.

Access functions:

PickMethod | pickMethod() const
void | setPickMethod(PickMethod pickMethod)

Notifier signal:

void | pickMethodChanged(QPickingSettings::PickMethod pickMethod)

### pickResultMode : PickResultMode

Holds the current pick results mode.

By default, pick results will only be produced for the entity closest to the camera.

When setting the pick method to AllPicks, events will be triggered for all the entities with a QObjectPicker along the ray.

If a QObjectPicker is assigned to an entity with multiple children, an event will be triggered for each child entity that intersects the ray.

Access functions:

PickResultMode | pickResultMode() const
void | setPickResultMode(PickResultMode pickResultMode)

Notifier signal:

void | pickResultModeChanged(QPickingSettings::PickResultMode pickResult)

## Member Function Documentation

### QPickingSettings::QPickingSettings(Qt3DCore::QNode *parent = nullptr)

Default constructs an instance of QPickingSettings.