diff options
| author | Colin Ogilvie <colin.ogilvie@kdab.com> | 2016-05-25 14:25:52 +0100 |
|---|---|---|
| committer | Jani Heikkinen <jani.heikkinen@qt.io> | 2016-06-03 06:27:36 +0000 |
| commit | 8487e1478c929bed1e60847feaf71d04db67cae8 (patch) | |
| tree | 7df61d525f29c65c091a7594cb4e69be38a74a63 /src/render/picking/qobjectpicker.cpp | |
| parent | d7612749d2e6bd362fcfc8cddb68cd4a0f6bd692 (diff) | |
More doc for render-picking
Task-number: QTBUG-46037
Change-Id: Idf4e2f123f4cf3d1662a91d5db82678caea26d6d
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
Diffstat (limited to 'src/render/picking/qobjectpicker.cpp')
| -rw-r--r-- | src/render/picking/qobjectpicker.cpp | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/src/render/picking/qobjectpicker.cpp b/src/render/picking/qobjectpicker.cpp index c8a69c363..29912fa79 100644 --- a/src/render/picking/qobjectpicker.cpp +++ b/src/render/picking/qobjectpicker.cpp @@ -80,26 +80,75 @@ namespace Qt3DRender { /*! \qmlsignal Qt3D.Render::ObjectPicker::pressed() + This signal is emitted when the bounding volume defined by the pickAttribute property intersects + with a ray on a mouse press. */ /*! \qmlsignal Qt3D.Render::ObjectPicker::released() + This signal is emitted when the bounding volume defined by the pickAttribute property intersects + with a ray on a mouse release. */ /*! \qmlsignal Qt3D.Render::ObjectPicker::clicked() + This signal is emitted when the bounding volume defined by the pickAttribute property intersects + with a ray on a mouse click. */ /*! \qmlsignal Qt3D.Render::ObjectPicker::moved() + This signal is emitted when the bounding volume defined by the pickAttribute property intersects + with a ray on a mouse move with a button pressed. */ /*! \qmlsignal Qt3D.Render::ObjectPicker::entered() + This signal is emitted when the bounding volume defined by the pickAttribute property intersects + with a ray on the mouse entering the volume. */ /*! \qmlsignal Qt3D.Render::ObjectPicker::exited() + This signal is emitted when the bounding volume defined by the pickAttribute property intersects + with a ray on the ray exiting the volume. +*/ + +/*! + \fn QObjectPicker::clicked(Qt3DRender::QPickEvent *pick) + This signal is emitted when the bounding volume defined by the pickAttribute property intersects + with a ray on a mouse click the QPickEvent \a pick contains details of the event. +*/ + +/*! + \fn QObjectPicker::entered() + This signal is emitted when the bounding volume defined by the pickAttribute property intersects + with a ray on the mouse entering the volume. +*/ + +/*! + \fn QObjectPicker::exited() + This signal is emitted when the bounding volume defined by the pickAttribute property intersects + with a ray on the ray exiting the volume. +*/ + +/*! + \fn QObjectPicker::moved(Qt3DRender::QPickEvent *pick) + This signal is emitted when the bounding volume defined by the pickAttribute property intersects + with a ray on a mouse move with a button pressed the QPickEvent \a pick contains details of the event. + +*/ + +/*! + \fn QObjectPicker::pressed(Qt3DRender::QPickEvent *pick) + This signal is emitted when the bounding volume defined by the pickAttribute property intersects + with a ray on a mouse press the QPickEvent \a pick contains details of the event. +*/ + +/*! + \fn QObjectPicker::released(Qt3DRender::QPickEvent *pick) + This signal is emitted when the bounding volume defined by the pickAttribute property intersects + with a ray on a mouse release the QPickEvent \a pick contains details of the event. */ QObjectPicker::QObjectPicker(Qt3DCore::QNode *parent) @@ -200,6 +249,7 @@ bool QObjectPicker::isPressed() const return d->m_pressed; } +/*! \internal */ void QObjectPicker::sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change) { Q_D(QObjectPicker); |