QObjectPicker Class

(Qt3DRender::QObjectPicker)

The QObjectPicker class instantiates a component that can be used to interact with a QEntity by a process known as picking. More...

Header: #include <QObjectPicker>
qmake: QT += 3drender
Since: Qt 5.6
Inherits: Qt3DCore::QComponent

Properties

Public Functions

QObjectPicker(QNode *parent = nullptr)
bool containsMouse() const
bool isDragEnabled() const
bool isHoverEnabled() const
bool isPressed() const

Public Slots

void setDragEnabled(bool dragEnabled)
void setHoverEnabled(bool hoverEnabled)

Signals

void clicked(Qt3DRender::QPickEvent *pick)
void containsMouseChanged(bool containsMouse)
void dragEnabledChanged(bool dragEnabled)
void entered()
void exited()
void hoverEnabledChanged(bool hoverEnabled)
void moved(Qt3DRender::QPickEvent *pick)
void pressed(Qt3DRender::QPickEvent *pick)
void pressedChanged(bool pressed)
void released(Qt3DRender::QPickEvent *pick)

Protected Functions

void sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change)

Additional Inherited Members

  • 1 public variable inherited from QObject
  • 10 static public members inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

The QObjectPicker class instantiates a component that can be used to interact with a QEntity by a process known as picking.

The signals pressed(), released(), clicked(), moved(), entered(), and exited() are emitted when the bounding volume defined by the pickAttribute property intersects with a ray.

Note: Instances of this component shouldn't be shared, not respecting that condition will most likely result in undefined behavior.

Property Documentation

containsMouse : const bool

Access functions:

bool containsMouse() const

Notifier signal:

void containsMouseChanged(bool containsMouse)

dragEnabled : bool

Access functions:

bool isDragEnabled() const
void setDragEnabled(bool dragEnabled)

Notifier signal:

void dragEnabledChanged(bool dragEnabled)

hoverEnabled : bool

Access functions:

bool isHoverEnabled() const
void setHoverEnabled(bool hoverEnabled)

Notifier signal:

void hoverEnabledChanged(bool hoverEnabled)

pressed : const bool

Access functions:

bool isPressed() const

Notifier signal:

void pressedChanged(bool pressed)

Member Function Documentation

QObjectPicker::QObjectPicker(QNode *parent = nullptr)

Default constructs an instance of QObjectPicker.

[signal] void QObjectPicker::clicked(Qt3DRender::QPickEvent *pick)

[signal] void QObjectPicker::entered()

[signal] void QObjectPicker::exited()

[signal] void QObjectPicker::moved(Qt3DRender::QPickEvent *pick)

[signal] void QObjectPicker::pressed(Qt3DRender::QPickEvent *pick)

[signal] void QObjectPicker::released(Qt3DRender::QPickEvent *pick)

[protected] void QObjectPicker::sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change)