summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJean-Michaël Celerier <jean-michael.celerier@kdab.com>2019-08-07 16:09:14 +0200
committerJean-Michaël Celerier <jean-michael.celerier@kdab.com>2019-08-07 16:31:02 +0200
commit6388eb98a12a639a263ef34553269fc36b582269 (patch)
treeb53a9b98b1f1beb12b1f876fc4eabba3cd3618a4
parent4c8dfd84feddee954f048f8ab3366d4d6176c788 (diff)
Improve documentation of ObjectPicker
Add a reference to Scene3D hoverEnabled Change-Id: I59e282a985ae5af30ff22d7caf433fb3b7cd821b Reviewed-by: Mike Krus <mike.krus@kdab.com>
-rw-r--r--src/render/picking/qobjectpicker.cpp2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/render/picking/qobjectpicker.cpp b/src/render/picking/qobjectpicker.cpp
index c3671d018..e15a7cdfc 100644
--- a/src/render/picking/qobjectpicker.cpp
+++ b/src/render/picking/qobjectpicker.cpp
@@ -109,6 +109,8 @@ namespace Qt3DRender {
\sa PickingSettings, Geometry, Attribute, PickEvent, PickTriangleEvent
+ \note To receive hover events in QtQuick, the hoverEnabled property of Scene3D must also be set.
+
\note Instances of this component shouldn't be shared, not respecting that
condition will most likely result in undefined behavior.
*/