Commits

Ian Chen committed 29dff03

Documentation part 5

Comments (0)

Files changed (26)

gazebo/gui/model_editor/BuildingEditorPalette.hh

 {
   namespace gui
   {
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class BuildingEditorPalette BuildingEditorPalette.hh
+    /// \brief A palette that displays different drawing operations.
     class BuildingEditorPalette : public QWidget
     {
       Q_OBJECT
       /// \brief A list of gui editor events.
       private: std::vector<event::ConnectionPtr> connections;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/BuildingEditorWidget.hh

 
     class ScaleWidget;
 
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class BuildingEditorWidget BuildingEditorWidget.hh
+    /// \brief A widget which the building editor is attached to.
     class BuildingEditorWidget : public QWidget
     {
       /// \brief Types of models supported in building editor
       /// \brief A widget to display the scale of the 2D editor view.
       private: ScaleWidget *scaleWidget;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/BuildingItem.hh

 {
   namespace gui
   {
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class BuildingItem BuildingItem.hh
+    /// \brief A base class that holds properties of a building level
     class BuildingItem
     {
         /// \brief Constructor
         /// \brief Base height of the level
         protected: double levelBaseHeight;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/BuildingMaker.hh

 
     class ModelManip;
 
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class BuildingMaker BuildingMaker.hh
+    /// \brief Create and manage 3D visuals of a building.
     class BuildingMaker : public EntityMaker
     {
       /// \brief Constructor
       /// \brief A list of gui editor events.
       private: std::vector<event::ConnectionPtr> connections;
     };
+    /// \}
   }
 }
 #endif

gazebo/gui/model_editor/DoorItem.hh

 
     class WindowDoorInspectorDialog;
 
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class DoorItem DoorItem.hh
+    /// \brief 2D representation of a door
     class DoorItem : public RectItem, public BuildingItem
     {
       Q_OBJECT
       /// \brief Door elevation in pixels
       private: double doorElevation;
 
-      /// \brief Door scene position in pixels
+      /// \brief Door scene position in pixel coordinates.
       private: QPointF doorPos;
 
       /// \brief Scale for converting to from pixel to metric units
       private: double scale;
 
-      /// \brief Inspector for configuring the window item.
+      /// \brief Inspector for configuring the door item.
       private: WindowDoorInspectorDialog *inspector;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/EditorItem.hh

 {
   namespace gui
   {
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class EditorItem EditorItem.hh
+    /// \brief A base class representing an item on the editor.
     class EditorItem : public QObject
     {
       Q_OBJECT
       /// \brief Name of editor item
       protected: std::string name;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/EditorView.hh

       public: double height;
     };
 
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class EditorView EditorView.hh
+    /// \brief Controls the editor view and manage contents in the editor scene.
     class EditorView : public QGraphicsView
     {
       Q_OBJECT
       /// wall operation.
       private: bool snapToCloseWall;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/EditorWidget.hh

 {
   namespace gui
   {
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class EditorWidget EditorWidget.hh
+    /// \brief Root widget of an editor.
     class EditorWidget : public QWidget
     {
       /// \brief Constructor
       /// \brief A building editor widget attached to this widget
       private: QWidget *buildingEditorWidget;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/FinishModelDialog.hh

 {
   namespace gui
   {
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class FinishModelDialog FinishModelDialog.hh
+    /// \brief Dialog for saving the building model.
     class FinishModelDialog : public QDialog
     {
       Q_OBJECT
       /// \brief Editable line that holds the model's save location.
       private: QLineEdit* modelLocationLineEdit;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/FloorItem.hh

 
     class WallItem;
 
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class FloorItem FloorItem.hh
+    /// \brief 2D representation of a floor.
     class FloorItem : public RectItem, public BuildingItem
     {
-        Q_OBJECT
+      Q_OBJECT
 
-        /// \brief Constructor
-        public: FloorItem();
+      /// \brief Constructor
+      public: FloorItem();
 
-        /// \brief Destructor
-        public: ~FloorItem();
+      /// \brief Destructor
+      public: ~FloorItem();
 
-        // Documentation inherited.
-        public: virtual QVector3D GetSize() const;
+      // Documentation inherited.
+      public: virtual QVector3D GetSize() const;
 
-        // Documentation inherited.
-        public: virtual QVector3D GetScenePosition() const;
+      // Documentation inherited.
+      public: virtual QVector3D GetScenePosition() const;
 
-        // Documentation inherited.
-        public: virtual double GetSceneRotation() const;
+      // Documentation inherited.
+      public: virtual double GetSceneRotation() const;
 
-        /// \brief Attach walls so the floor can auto expand to hold the wall.
-        /// \param[in] _wallItem Wall item to attach to the floor.
-        public: void AttachWall(WallItem *_wallItem);
+      /// \brief Attach walls so the floor can auto expand to hold the wall.
+      /// \param[in] _wallItem Wall item to attach to the floor.
+      public: void AttachWall(WallItem *_wallItem);
 
-        // Documentation inherited.
-        private: virtual void paint(QPainter *_painter,
-            const QStyleOptionGraphicsItem *_option, QWidget *_widget);
+      // Documentation inherited.
+      private: virtual void paint(QPainter *_painter,
+          const QStyleOptionGraphicsItem *_option, QWidget *_widget);
 
-        // Documentation inherited.
-        private: virtual void mousePressEvent(QGraphicsSceneMouseEvent *_event);
+      // Documentation inherited.
+      private: virtual void mousePressEvent(QGraphicsSceneMouseEvent *_event);
 
-        // Documentation inherited.
-        private: virtual void contextMenuEvent(
-            QGraphicsSceneContextMenuEvent *_event);
+      // Documentation inherited.
+      private: virtual void contextMenuEvent(
+          QGraphicsSceneContextMenuEvent *_event);
 
-        /// \brief Notify that the bounding box of the wall items needs to be
-        /// changed.
-        private slots: void NotifyChange();
+      /// \brief Notify that the bounding box of the wall items needs to be
+      /// changed.
+      private slots: void NotifyChange();
 
-        /// \brief Qt callback to recalculate the bounding box of wall items.
-        private slots: void RecalculateBoundingBox();
+      /// \brief Qt callback to recalculate the bounding box of wall items.
+      private slots: void RecalculateBoundingBox();
 
-        /// \brief Qt callback when a wall
-        private slots: void WallDeleted();
+      /// \brief Qt callback when a wall
+      private slots: void WallDeleted();
 
-        /// \brief Update the floor properties and emit Qt signals
-        private: void Update();
+      /// \brief Update the floor properties and emit Qt signals
+      private: void Update();
 
-        /// \brief Emit floor changed Qt signals.
-        private: void FloorChanged();
+      /// \brief Emit floor changed Qt signals.
+      private: void FloorChanged();
 
-        /// \brief Emit size changed Qt signals.
-        private: void SizeChanged();
+      /// \brief Emit size changed Qt signals.
+      private: void SizeChanged();
 
-        /// \brief Depth of floor item in pixels.
-        private: double floorDepth;
+      /// \brief Depth of floor item in pixels.
+      private: double floorDepth;
 
-        /// \brief Height of floor item in pixels.
-        private: double floorHeight;
+      /// \brief Height of floor item in pixels.
+      private: double floorHeight;
 
-        /// \brief Width of floor item in pixels.
-        private: double floorWidth;
+      /// \brief Width of floor item in pixels.
+      private: double floorWidth;
 
-        /// \brief Scene position of floor item in pixel coordinates.
-        private: QPointF floorPos;
+      /// \brief Scene position of floor item in pixel coordinates.
+      private: QPointF floorPos;
 
-        /// \brief A flag to indicate that there have been changes to the wall
-        /// items.
-        private: bool dirty;
+      /// \brief A flag to indicate that there have been changes to the wall
+      /// items.
+      private: bool dirty;
 
-        /// \brief A list of wall items that the floor item holds.
-        private: std::vector<WallItem *> walls;
+      /// \brief A list of wall items that the floor item holds.
+      private: std::vector<WallItem *> walls;
 
-        /// \brief Bounding box of the floor item.
-        private: QPolygonF floorBoundingRect;
+      /// \brief Bounding box of the floor item.
+      private: QPolygonF floorBoundingRect;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/GrabberHandle.hh

       /// \brief Current mouse state.
       private: int mouseButtonState;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/GridLines.hh

 {
   namespace gui
   {
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class GridLines GridLines.hh
+    /// \brief 2D grid lines.
     class GridLines : public  QGraphicsItem
     {
       /// \brief Constructor
       /// \brief Space between the lines in pixels.
       private: int space;
     };
+    /// \}
   }
 }
 #endif

gazebo/gui/model_editor/LevelInspectorDialog.hh

 {
   namespace gui
   {
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class LevelInspectorDialog LevelInspectorDialog.hh
+    /// \brief Dialog for configuring a building level
     class LevelInspectorDialog : public QDialog
     {
       Q_OBJECT
       /// \brief Combo box for configuring the floor material.
       private: QComboBox *materialComboBox;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/LevelWidget.hh

 {
   namespace gui
   {
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class GridLines GridLines.hh
+    /// \brief A widget for adding and changing building levels.
     class LevelWidget : public QWidget
     {
       Q_OBJECT
       /// \brief Counter for the total number of levels.
       private: int levelCounter;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/LineSegmentItem.hh

   {
     class EditorItem;
 
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class LineSegmentItem LineSegmentItem.hh
+    /// \brief 2D line segment.
     class LineSegmentItem : public EditorItem, public QGraphicsLineItem
     {
       /// \brief Constructor
       /// \brief Mouse press Y position in pixel coordinates.
       private: double mouseDownY;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/ModelManip.hh

   {
     class BuildingMaker;
 
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class ModelManip ModelManip.hh
+    /// \brief Manipulate a 3D visual generated from a 2D editor item
     class ModelManip : public QObject
     {
       Q_OBJECT
       /// \brief Parent manipulator.
       private: ModelManip * parent;
     };
+    /// \}
   }
 }
 #endif

gazebo/gui/model_editor/PolylineItem.hh

 
     class LineSegmentItem;
 
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class PolylineItem PolylineItem.hh
+    /// \brief 2D polyline.
     class PolylineItem : public EditorItem, public QGraphicsPathItem
     {
       /// \brief Constructor
       /// \brief Thickness of the polyline in pixels
       private: double lineThickness;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/RectItem.hh

 
     class EditorItem;
 
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class RectItem RectItem.hh
+    /// \brief 2D rectangle.
     class RectItem : public EditorItem, public QGraphicsRectItem
     {
       Q_OBJECT
       /// \brieft Resize flag that controls how the rect item can be resized.
       private: unsigned int resizeFlag;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/RotateHandle.hh

 {
   namespace gui
   {
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class RotateHandle RotateHandle.hh
+    /// \brief Handle for rotating an editor item
     class RotateHandle : public QGraphicsItem
     {
       /// \brief Constructor
       /// \brief Offset position of the rotate handle pixel coordinates.
       private: QPointF handleOffset;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/ScaleWidget.hh

 {
   namespace gui
   {
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class ScaleWidget ScaleWidget.hh
+    /// \brief Widget that displays the scale (zoom level) of the editor
     class ScaleWidget : public QWidget
     {
       Q_OBJECT
       /// \brief A list of gui editor events connected to this widget.
       private: std::vector<event::ConnectionPtr> connections;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/StairsInspectorDialog.hh

 {
   namespace gui
   {
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class StairsInspectorDialog StairsInspectorDialog.hh
+    /// \brief Dialog for configuring a staircase item.
     class StairsInspectorDialog : public QDialog
     {
       Q_OBJECT
       /// \brief Label that holds the name of the staircase.
       private: QLabel* stairsNameLabel;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/StairsItem.hh

 
     class StairsInspectorDialog;
 
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class StairsItem StairsItem.hh
+    /// \brief 2D representation of a staircase.
     class StairsItem :  public RectItem, public BuildingItem
     {
       Q_OBJECT
 
       // private: double stairsUnitRun;
     };
+    /// \}
   }
 }
 #endif

gazebo/gui/model_editor/WallInspectorDialog.hh

 {
   namespace gui
   {
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class WallInspectorDialog WallInspectorDialog.hh
+    /// \brief Dialog for configuring a wall item.
     class WallInspectorDialog : public QDialog
     {
       Q_OBJECT
       /// \brief Label that holds the name of the wall.
       private: QLabel* wallNameLabel;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/WallItem.hh

 
     class WallInspectorDialog;
 
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class WallItem WallItem.hh
+    /// \brief 2D representation of a wall.
     class WallItem : public PolylineItem, public BuildingItem
     {
       Q_OBJECT
       /// \brief Inspector for configuring the wall item.
       private: WallInspectorDialog *inspector;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/WindowDoorInspectorDialog.hh

       /// \brief Combo box for selecting the type of the item to use.
       private: QComboBox *typeComboBox;
     };
+    /// \}
   }
 }
 

gazebo/gui/model_editor/WindowItem.hh

 
     class WindowDoorInspectorDialog;
 
+    /// \addtogroup gazebo_gui
+    /// \{
+
+    /// \class WindowItem WindowItem.hh
+    /// \brief 2D representation of a window.
     class WindowItem : public RectItem, public BuildingItem
     {
         Q_OBJECT
         /// \brief Inspector for configuring the window item.
         private: WindowDoorInspectorDialog *inspector;
     };
+    /// \}
   }
 }
 #endif