summaryrefslogtreecommitdiffstats
path: root/src/render/picking/qpickevent.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/render/picking/qpickevent.cpp')
-rw-r--r--src/render/picking/qpickevent.cpp32
1 files changed, 21 insertions, 11 deletions
diff --git a/src/render/picking/qpickevent.cpp b/src/render/picking/qpickevent.cpp
index c7abf639c..148850baf 100644
--- a/src/render/picking/qpickevent.cpp
+++ b/src/render/picking/qpickevent.cpp
@@ -50,6 +50,10 @@ namespace Qt3DRender {
\inmodule Qt3DRender
\brief The QPickEvent class holds information when an object is picked
+
+ This is received as a parameter in most of the QObjectPicker component signals when picking
+ succeeds.
+
\sa QPickingSettings, QPickTriangleEvent, QObjectPicker
\since 5.7
@@ -61,9 +65,10 @@ namespace Qt3DRender {
* \inqmlmodule Qt3D.Render
* \sa ObjectPicker PickingSettings
* \brief PickEvent holds information when an object is picked.
+ * This is received as a parameter in most of the QObjectPicker component signals when picking
+ * succeeds.
*/
-
/*!
\fn Qt3DRender::QPickEvent::QPickEvent()
Constructs a new QPickEvent.
@@ -73,6 +78,11 @@ QPickEvent::QPickEvent()
{
}
+QPickEventPrivate *QPickEventPrivate::get(QPickEvent *object)
+{
+ return object->d_func();
+}
+
/*!
\fn Qt3DRender::QPickEvent::QPickEvent(const QPointF &position, const QVector3D &intersection, const QVector3D &localIntersection, float distance)
Constructs a new QPickEvent with the given parameters: \a position, \a intersection, \a localIntersection and \a distance
@@ -147,11 +157,11 @@ void QPickEvent::setAccepted(bool accepted)
/*!
\qmlproperty bool Qt3D.Render::PickEvent::position
- Specifies the position of the event
+ Specifies the mouse position with respect to the render area (window or quick item)
*/
/*!
\property Qt3DRender::QPickEvent::position
- Specifies the position of the event
+ Specifies the mouse position with respect to the render area (window or quick item)
*/
/*!
* \brief QPickEvent::position
@@ -165,11 +175,11 @@ QPointF QPickEvent::position() const
/*!
\qmlproperty bool Qt3D.Render::PickEvent::distance
- Specifies the distance of the event
+ Specifies the distance of the hit to the camera
*/
/*!
\property Qt3DRender::QPickEvent::distance
- Specifies the distance of the event
+ Specifies the distance of the hit to the camera
*/
/*!
* \brief QPickEvent::distance
@@ -183,15 +193,15 @@ float QPickEvent::distance() const
/*!
\qmlproperty bool Qt3D.Render::PickEvent::worldIntersection
- Specifies the world intersection of the event
+ Specifies the coordinates of the hit in world coordinate system
*/
/*!
\property Qt3DRender::QPickEvent::worldIntersection
- Specifies the world intersection of the event
+ Specifies the coordinates of the hit in world coordinate system
*/
/*!
* \brief QPickEvent::worldIntersection
- * \return world coordinate of the pick point
+ * \return coordinates of the hit in world coordinate system
*/
QVector3D QPickEvent::worldIntersection() const
{
@@ -201,15 +211,15 @@ QVector3D QPickEvent::worldIntersection() const
/*!
\qmlproperty bool Qt3D.Render::PickEvent::localIntersection
- Specifies the world local intersection of the event
+ Specifies the coordinates of the hit in the local coordinate system of the picked entity
*/
/*!
\property Qt3DRender::QPickEvent::localIntersection
- Specifies the local intersection of the event
+ Specifies the coordinates of the hit in the local coordinate system of the picked entity
*/
/*!
* \brief QPickEvent::localIntersection
- * \return local coordinate of pick point
+ * \return coordinates of the hit in the local coordinate system of the picked entity
*/
QVector3D QPickEvent::localIntersection() const
{