Qt Documentation

Qt 5.12
Qt 3D
C++ Classes
QProximityFilter

QProximityFilter Class

(Qt3DRender::QProximityFilter)

Select entities which are within a distance threshold of a target entity. More...

Header:	#include <QProximityFilter>
qmake:	QT += 3drender
Since:	Qt 5.10
Instantiated By:	ProximityFilter
Inherits:	Qt3DRender::QFrameGraphNode

Properties

distanceThreshold : float
entity : Qt3DCore::QEntity*

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

Public Functions

	QProximityFilter(Qt3DCore::QNode *parent = nullptr)
float	distanceThreshold() const
Qt3DCore::QEntity *	entity() const

1 public function inherited from Qt3DRender::QFrameGraphNode
13 public functions inherited from Qt3DCore::QNode
31 public functions inherited from QObject

Public Slots

void	setDistanceThreshold(float distanceThreshold)
void	setEntity(Qt3DCore::QEntity *entity)

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

Signals

void	distanceThresholdChanged(float distanceThreshold)
void	entityChanged(Qt3DCore::QEntity *entity)

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

Static Public Members

const QMetaObject staticMetaObject

9 static public members inherited from QObject

Additional Inherited Members

1 protected function inherited from Qt3DRender::QFrameGraphNode
2 protected functions inherited from Qt3DCore::QNode
9 protected functions inherited from QObject

Detailed Description

Select entities which are within a distance threshold of a target entity.

A Qt3DRender::QProximityFilter can be used to select entities to render when they are placed within a given distance threshold of another entity.

Property Documentation

distanceThreshold : float

Holds the distance to the target entity above which entities are filtered out.

Access functions:

float	distanceThreshold() const
void	setDistanceThreshold(float distanceThreshold)

Notifier signal:

void	distanceThresholdChanged(float distanceThreshold)

entity : Qt3DCore::QEntity*

Holds the entity against which we should compare the distance to.