Qt Documentation

Qt 5.7
Qt 3D
C++ Classes
QPickingSettings

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	PickMethod { BoundingVolumePicking, TrianglePicking }
enum	PickResultMode { NearestPick, AllPicks }

Properties

pickMethod : PickMethod
pickResultMode : PickResultMode

2 properties inherited from Qt3DCore::QNode
1 property inherited from QObject

Public Functions

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

6 public functions inherited from Qt3DCore::QNode
31 public functions inherited from QObject

Public Slots

void	setPickMethod(PickMethod pickMethod)
void	setPickResultMode(PickResultMode pickResultMode)

2 public slots inherited from Qt3DCore::QNode
1 public slot inherited from QObject

Signals

void	pickMethodChanged(QPickingSettings::PickMethod pickMethod)
void	pickResultModeChanged(QPickingSettings::PickResultMode pickResult)

3 signals inherited from Qt3DCore::QNode
2 signals inherited from QObject

Additional Inherited Members

11 static public members inherited from QObject
2 protected functions inherited from Qt3DCore::QNode
9 protected functions inherited from QObject

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.

Member Type Documentation

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.
`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.
`Qt3DRender::QPickingSettings::AllPicks`	`1`	All entities that intersect the picking ray are picked.

Property Documentation

pickMethod : PickMethod

Holds the current pick method.

Access functions:

PickMethod	pickMethod() const
void	setPickMethod(PickMethod pickMethod)

Notifier signal:

void	pickMethodChanged(QPickingSettings::PickMethod pickMethod)

pickResultMode : PickResultMode

Holds the current pick results mode.