MIRA
SceneQueryTool.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2017 by
3  * MetraLabs GmbH (MLAB), GERMANY
4  * and
5  * Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
6  * All rights reserved.
7  *
8  * Contact: info@mira-project.org
9  *
10  * Commercial Usage:
11  * Licensees holding valid commercial licenses may use this file in
12  * accordance with the commercial license agreement provided with the
13  * software or, alternatively, in accordance with the terms contained in
14  * a written agreement between you and MLAB or NICR.
15  *
16  * GNU General Public License Usage:
17  * Alternatively, this file may be used under the terms of the GNU
18  * General Public License version 3.0 as published by the Free Software
19  * Foundation and appearing in the file LICENSE.GPL3 included in the
20  * packaging of this file. Please review the following information to
21  * ensure the GNU General Public License version 3.0 requirements will be
22  * met: http://www.gnu.org/copyleft/gpl.html.
23  * Alternatively you may (at your option) use any later version of the GNU
24  * General Public License if such license has been publicly approved by
25  * MLAB and NICR (or its successors, if any).
26  *
27  * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
28  * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
29  * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
30  * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
33  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
34  * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
35  * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
36  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
37  */
38 
47 #ifndef _MIRA_SCENEQUERYTOOL3D_H_
48 #define _MIRA_SCENEQUERYTOOL3D_H_
49 
51 
52 namespace mira {
53 
55 
56 /*
57  * Base class for any tools that want to query the scene in a Visualization3DView
58  * (in contrast to tools just affecting the camera)
59  */
61 {
62 public:
64  IGNORE_BACKGROUND = 0,
66  IGNORE_OBJECTS
67  };
68 
69 public:
71 
72 public:
73 
74  template <typename Reflector>
75  void reflect(Reflector& r)
76  {
78  r.property("Background mode", mBackgroundMode,
79  "Objects only = select first object hit or nothing\n"
80  "Prefer objects = select background if no object hit\n"
81  "Background only = always select background, regardless of objects hit",
82  IGNORE_BACKGROUND,
83  PropertyHints::enumeration("Hit objects only;Prefer objects over background;Hit background only"));
84  r.property("Background height", mBackgroundHeight,
85  "Height of (virtual) background plane to assume for determining coordinates clicked on background", 0.f);
86  }
87 
88 public:
89 
90  virtual void onMousePressed(QMouseEvent* e, float devicePixelRatio);
91  virtual void onMouseReleased(QMouseEvent* e, float devicePixelRatio);
92  virtual void onMouseDoubleClick(QMouseEvent* e, float devicePixelRatio);
93  virtual void onMouseMoved(QMouseEvent* e, float devicePixelRatio);
94  virtual void onMouseWheel(QWheelEvent * e, float devicePixelRatio);
95 
96 protected:
97 
98  virtual void setupScene(IVisualization3DSite* site);
99 
100  /*
101  * Get intersection of a click into the view with objects in the view.
102  * @param x Viewport x coordinate
103  * @param y Viewport y coordinate
104  * @param mask If not empty, find only objects with name matching filter.
105  * @param exactMatch If true, name must match filter exactly.
106  * Otherwise, name must contain filter as substring.
107  * @param transform Apply transformVector to the coordinates (transform to FixedFrame)
108  * @return Pair of object name and hit position. Returned name is empty if neither object nor background hit.
109  */
110  std::pair<std::string, Ogre::Vector3> getIntersection(float x, float y,
111  const std::string& filter = "",
112  bool exactMatch = false,
113  bool transform = false);
114 
115 protected:
116 
117  Ogre::RaySceneQuery* mRaySceneQuery;
118 
121 
123 };
124 
126 
127 } // namespace
128 
129 #endif
Ogre::RaySceneQuery * mRaySceneQuery
Definition: SceneQueryTool.h:117
The interface of a Visualization3DSite.
Definition: Visualization3D.h:84
float mBackgroundHeight
Definition: SceneQueryTool.h:120
Definition: SceneQueryTool.h:60
specialize cv::DataType for our ImgPixel and inherit from cv::DataType<Vec>
Definition: IOService.h:67
float mDevicePixelRatio
Definition: SceneQueryTool.h:122
Definition: SceneQueryTool.h:65
PropertyHint enumeration(const std::string &values)
Sets the attribute "enumeration".
Definition: PropertyHint.h:306
#define MIRA_REFLECT_BASE(reflector, BaseClass)
Macro that can be used to reflect the base class easily.
Definition: ReflectorInterface.h:912
Definition: VisualizationTool3D.h:63
void reflect(Reflector &r)
Definition: SceneQueryTool.h:75
BackgroundMode
Definition: SceneQueryTool.h:63
#define MIRA_GUI_VISUALIZATION_EXPORT
Definition: GuiVisualizationExports.h:61
BackgroundMode mBackgroundMode
Definition: SceneQueryTool.h:119