Add documentation

delphyne-gui/visualizer/arrow_mesh.hh

@@ -9,31 +9,54 @@
 namespace delphyne {
 namespace gui {
 
+/// \brief Renders a cone which will act as a pointing arrow when the user clicks over a lane
 class ArrowMesh
 {
 
 public:
 
+  /// \brief Constructor. Creates a cone and adds it as a child to the RootVisual of the scene, which will move
+  /// upwards and downwards for a fixed amount of ticks.
+  /// \param[in] _scene Scene pointer to create the cone.
+  /// \param[in] _zOffset Units above the pointed object that the cone tip should be.
+  /// \param[in] _scaleFactor Factor to increase/decrease the scale of the arrow based on the distance from the camera
+  /// to the clicked position.
   ArrowMesh(ignition::rendering::ScenePtr& _scene, double _zOffset = 2.0, double _scaleFactor = 0.025);
+  /// \brief Destructor.
   ~ArrowMesh() = default;
 
+  /// \brief Moves the arrow to a given world position and resets the downwards movement.
+  /// \param[in] _distanceFromCamera How far the camera is from the clicked point.
+  /// \param[in] _worldPosition World position of the cursor ray cast click.
   void MoveArrowAt(double _distanceFromCamera, const ignition::math::Vector3d& _worldPosition);
+  /// \brief Toggles the visibility of the arrow.
+  /// \param[in] _visible Boolean that determines if the arrow should be visible or not.
   void SetArrowVisibility(bool _visible);
 
+  /// \brief Updates the position of the arrow moving slightly the z axis.
   void Update();
 
 private:
 
+  /// \brief Bounding box of the cone in construction time.
   ignition::math::Vector3d minBoundingBox;
 
+  /// \brief Visual pointer of the created cone.
   ignition::rendering::VisualPtr arrow;
 
+  /// \brief Units that the tip of the cone should be from the clicked position.
   const double zOffset;
+  /// \brief Factor to increase/decrease the size of the cone.
   const double scaleFactor;
+  /// \brief Distance to move downwards/upwards.
   const double distanceToMove;
+  /// \brief How much units should the arrow move downwards/upwards per tick.
   const double step;
+  /// \brief How much ticks required to move the arrow from down to up or up to down.
   const int totalTicks;
+  /// \brief How many ticks passed since it started moving.
   int currentTick;
+  /// \brief Tells the arrow if it should move upwards or downwards.
   bool moveDown;
 };
 }  // namespace gui