docs and some cleanup

Signed-off-by: Louise Poubel <[email protected]>

examples/config/scene3d.config

@@ -15,6 +15,19 @@
     <background_color>0.8 0.8 0.8</background_color>
     <camera_pose>-6 0 6 0 0.5 0</camera_pose>
 </plugin>
+<plugin filename="InteractiveViewControl" name="Interactive view control">
+  <ignition-gui>
+    <anchors target="View 1">
+      <line own="right" target="right"/>
+      <line own="top" target="top"/>
+    </anchors>
+    <property key="resizable" type="bool">false</property>
+    <property key="width" type="double">5</property>
+    <property key="height" type="double">5</property>
+    <property key="state" type="string">floating</property>
+    <property key="showTitleBar" type="bool">false</property>
+  </ignition-gui>
+</plugin>
 <plugin filename="TransportSceneManager" name="Transport Scene Manager">
   <ignition-gui>
     <anchors target="View 1">

src/plugins/interactive_view_control/InteractiveViewControl.cc

@@ -35,15 +35,19 @@
 /// \brief Private data class for InteractiveViewControl
 class ignition::gui::plugins::InteractiveViewControlPrivate
 {
-  /// \brief
+  /// \brief Perform rendering calls in the rendering thread.
   public: void OnRender();
 
-  math::Vector3d ScreenToScene(
-      const math::Vector2i &_screenPos) const;
+  /// \brief Transform a position on screen to the first point that's hit on
+  /// the 3D scene
+  /// \param[in] _screenPos Position on 2D screen within the 3D scene
+  /// \return First point hit on the 3D scene.
+  math::Vector3d ScreenToScene(const math::Vector2i &_screenPos) const;
 
   /// \brief Flag to indicate if mouse event is dirty
   public: bool mouseDirty = false;
 
+  /// \brief True to block orbiting with the mouse.
   public: bool blockOrbit = false;
 
   /// \brief Mouse event
@@ -191,7 +195,7 @@ math::Vector3d InteractiveViewControlPrivate::ScreenToScene(
 
 /////////////////////////////////////////////////
 InteractiveViewControl::InteractiveViewControl()
-  : Plugin(), dataPtr(new InteractiveViewControlPrivate)
+  : Plugin(), dataPtr(std::make_unique<InteractiveViewControlPrivate>())
 {
 }
 
@@ -247,7 +251,6 @@ bool InteractiveViewControl::eventFilter(QObject *_obj, QEvent *_event)
     auto blockOrbit = reinterpret_cast<ignition::gui::events::BlockOrbit *>(
       _event);
     this->dataPtr->blockOrbit = blockOrbit->Block();
-    std::cerr << "BlockOrbit " << blockOrbit->Block() << '\n';
   }
 
   // Standard event processing

src/plugins/minimal_scene/MinimalScene.cc

@@ -63,17 +63,17 @@ class ignition::gui::plugins::IgnRenderer::Implementation
   /// \brief Mouse event
   public: common::MouseEvent mouseEvent;
 
-    /// \brief Mouse event
-    public: common::KeyEvent keyEvent;
+  /// \brief Key event
+  public: common::KeyEvent keyEvent;
 
-    /// \brief Mutex to protect mouse events
-    public: std::mutex mutex;
+  /// \brief Mutex to protect mouse events
+  public: std::mutex mutex;
 
   /// \brief User camera
   public: rendering::CameraPtr camera{nullptr};
 
-    /// \brief The currently hovered mouse position in screen coordinates
-    public: math::Vector2i mouseHoverPos{math::Vector2i::Zero};
+  /// \brief The currently hovered mouse position in screen coordinates
+  public: math::Vector2i mouseHoverPos{math::Vector2i::Zero};
 
   /// \brief Ray query for mouse clicks
   public: rendering::RayQueryPtr rayQuery{nullptr};