Commits

Ian Chen  committed 7f5fb9c

Documentation part 2

  • Participants
  • Parent commits 3f43227
  • Branches ian-building

Comments (0)

Files changed (13)

File gazebo/gui/model_editor/BuildingEditorPalette.cc

 }
 
 /////////////////////////////////////////////////
-void BuildingEditorPalette::OnImportImage()
+/*void BuildingEditorPalette::OnImportImage()
 {
 //  gui::editor::Events::createEditorItem("Image");
-}
+}*/
 
 
 /////////////////////////////////////////////////

File gazebo/gui/model_editor/EditorWidget.hh

   {
     class EditorWidget : public QWidget
     {
+      /// \brief Constructor
+      /// \param[in] _parent Parent QWidget.
       public: EditorWidget(QWidget *_parent = 0);
 
+      /// \brief Destructor
       public: virtual ~EditorWidget();
 
+      /// \brief Get the building editor widget
+      /// \return Building editor widget
       public: QWidget *GetBuildingEditor() const;
 
+      /// \brief A building editor widget attached to this widget
       private: QWidget *buildingEditorWidget;
     };
   }

File gazebo/gui/model_editor/FinishModelDialog.hh

     {
       Q_OBJECT
 
+      /// \brief Modes of the dialog
       public: enum FinishMode {MODEL_FINISH, MODEL_SAVE};
 
+      /// \brief Constructor
+      /// \param[in] _mode Mode of the dialog
+      /// \param[in] _parent Parent QWidget.
       public: FinishModelDialog(int _mode = 0, QWidget *_parent = 0);
 
+      /// \brief Destructor
       public: ~FinishModelDialog();
 
+      /// \brief Get the model name
+      /// \return The model name
       public: std::string GetModelName() const;
 
+      /// \brief Get the save location
+      /// \return Path of the save location
       public: std::string GetSaveLocation() const;
 
+      /// \brief Set the model name
+      /// \param[in] _name Name to set the model to.
       public: void SetModelName(const std::string &_name);
 
+      /// \brief Set the save location
+      /// \param[in] _location Location to save to.
       public: void SetSaveLocation(const std::string &_location);
 
+      /// \brief Qt callback when the file directory browse button is pressed
       private slots: void OnBrowse();
 
+      /// \brief Qt callback when the cancel button is pressed
       private slots: void OnCancel();
 
+      /// \brief Qt callback when the Done button is pressed
       private slots: void OnFinish();
 
+      /// \brief Editable line for the model name
       private: QLineEdit* modelNameLineEdit;
 
+      /// \brief Editable line for the model location
       private: QLineEdit* modelLocationLineEdit;
     };
   }

File gazebo/gui/model_editor/FloorItem.cc

 FloorItem::FloorItem(): RectItem(), BuildingItem()
 {
   this->editorType = "Floor";
-  this->scale = BuildingMaker::conversionScale;
 
   this->level = 0;
   this->levelBaseHeight = 0;
   this->floorPos = this->scenePos();
 
   this->setFlag(QGraphicsItem::ItemIsSelectable, false);
-  this->wallGroup = new QGraphicsItemGroup();
   this->dirty = false;
 
   QTimer *timer = new QTimer(this);
 /////////////////////////////////////////////////
 FloorItem::~FloorItem()
 {
-  if (this->wallGroup)
-    delete this->wallGroup;
 }
 
 

File gazebo/gui/model_editor/FloorItem.hh

 #include "gazebo/gui/model_editor/RectItem.hh"
 #include "gazebo/gui/model_editor/BuildingItem.hh"
 
-
 namespace gazebo
 {
   namespace gui
     {
         Q_OBJECT
 
+        /// \brief Constructor
         public: FloorItem();
 
+        /// \brief Destructor
         public: ~FloorItem();
 
+        // Documentation inherited.
         public: virtual QVector3D GetSize() const;
 
+        // Documentation inherited.
         public: virtual QVector3D GetScenePosition() 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);
 
+        // 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 contextMenuEvent(
             QGraphicsSceneContextMenuEvent *_event);
 
+        /// \brief Notify that the bounding box of all the walls
+        /// needs to be changed.
         private slots: void NotifyChange();
 
+        /// \brief Qt callback to recalculate the bounding box of all wall
+        /// items.
         private slots: void RecalculateBoundingBox();
 
+        /// \brief Qt callback when a wall
         private slots: void WallDeleted();
 
+        /// \brief Update the floor properties and emit Qt signals
         private: void Update();
 
+        /// \brief Emit floor changed Qt signals.
         private: void FloorChanged();
 
+        /// \brief Emit size changed Qt signals.
         private: void SizeChanged();
 
+        /// \brief Depth of floor
         private: double floorDepth;
 
+        /// \brief Height of floor
         private: double floorHeight;
 
+        /// \brief Width of floor
         private: double floorWidth;
 
+        /// \brief Scene position of floor
         private: QPointF floorPos;
 
+        /// \brief A flag to indicate that there have been changes to the walls
         private: bool dirty;
 
-        private: double scale;
-
+        /// \brief A list of walls that the floor holds
         private: std::vector<WallItem *> walls;
 
-        private: QGraphicsItemGroup *wallGroup;
-
+        /// \brief Bounding box of the floor item
         private: QPolygonF floorBoundingRect;
     };
   }

File gazebo/gui/model_editor/GrabberHandle.hh

   {
     class GrabberHandle : public QGraphicsItem
     {
+      /// \brief Constructor
+      /// \param[in] _parent Parent graphics Item
+      /// \param[in] _index Index of grabber handle
       public: GrabberHandle(QGraphicsItem *_parent = 0, int index = 0);
 
+      /// \brief Get the index of the grabber handle.
+      /// \return Index of the grabber handle.
       public: int GetIndex() const;
 
-      /// \brief Set the current mouse state
+      /// \brief Get the current mouse state.
+      /// \return The current mouse state.
+      public: int  GetMouseState() const;
+
+      /// \brief Get the center point of the grabber handle in pixels.
+      /// \return Center point in pixels.
+      public: QPointF GetCenterPoint() const;
+
+      /// \brief Get the X position of the mouse press in pixels.
+      /// \return Mouse press X position in pixels.
+      public: double GetMouseDownX() const;
+
+      /// \brief Get the Y position of the mouse press in pixels.
+      /// \return Mouse press Y position in pixels.
+      public: double GetMouseDownY() const;
+
+      /// \brief Get the width of the grabber handle.
+      /// \return The width of the grabber handle in pixels.
+      public: double GetWidth() const;
+
+      /// \brief Get the Height of the grabber handle.
+      /// \return The height of the grabber handle in pixels.
+      public: double GetHeight() const;
+
+      /// \brief Get the fill color of the grabber handle.
+      /// \return _color Fill color.
+      public: QColor GetColor() const;
+
+      /// \brief Set the current mouse state.
+      /// \param[in] _state Current mouse state.
       public: void SetMouseState(int _state);
 
-      /// \brief Retrieve the current mouse state
-      public: int  GetMouseState() const;
-
-      public: QPointF GetCenterPoint() const;
-
+      /// \brief Set the X position of the mouse press in pixels.
+      /// \param[in] _x Mouse press X position in pixels.
       public: void SetMouseDownX(double _x);
 
+      /// \brief Set the Y position of the mouse press in pixels.
+      /// \param[in] _y Mouse press Y position in pixels.
       public: void SetMouseDownY(double _y);
 
-      public: double GetMouseDownX() const;
-
-      public: double GetMouseDownY() const;
-
+      /// \brief Set the width of the grabber handle in pixels.
+      /// \param[in] _width Width in pixels.
       public: void SetWidth(double _width);
 
+      /// \brief Set the height of the grabber handle in pixels.
+      /// \param[in] _height Height in pixels.
       public: void SetHeight(double _height);
 
-      public: double GetWidth() const;
-
-      public: double GetHeight() const;
-
+      /// \brief Set the fill color of the grabber handle.
+      /// \param[in] _color Fill Color.
       public: void SetColor(const QColor &color);
 
-      public: QColor GetColor() const;
-
+      /// \brief Set the border color of the grabber handle.
+      /// \param[in] _borderColor Border Color.
       public: void SetBorderColor(const QColor &_borderColor);
 
+      /// \brief Get the bounding box of the grabber handle.
+      /// \return The grabber handle bounding box.
       public: virtual QRectF boundingRect() const;
 
+      /// \brief Qt paint function for drawing the grabber handle.
+      /// \param[in] _painter Qt painter object.
+      /// \param[in] _painter Qt style options for the item.
+      /// \param[in] _painter Qt widget being painted on.
       private: virtual void paint(QPainter *_painter,
         const QStyleOptionGraphicsItem *_option, QWidget *_widget);
 
+      /// \brief Qt mouse hover enter event
+      /// \param[in] _event Qt mouse hover event
       protected: void hoverEnterEvent(QGraphicsSceneHoverEvent *_event);
 
+      /// \brief Qt mouse hover leave event
+      /// \param[in] _event Qt mouse hover event
       protected: void hoverLeaveEvent(QGraphicsSceneHoverEvent *_event);
 
+      /// \brief Qt mouse move event
+      /// \param[in] _event Qt mouse event
       protected: void mouseMoveEvent(QGraphicsSceneMouseEvent *_event);
 
+      /// \brief Qt mouse press event
+      /// \param[in] _event Qt mouse event
+      protected: void mousePressEvent(QGraphicsSceneMouseEvent *_event);
+
+      /// \brief Qt mouse release event
+      /// \param[in] _event Qt mouse event
+      protected: void mouseReleaseEvent(QGraphicsSceneMouseEvent *_event);
+
+      /// \brief Qt mouse press event during drag and drop
+      /// \param[in] _event Qt mouse drag and drop event
+      protected: void mousePressEvent(QGraphicsSceneDragDropEvent *_event);
+
+      /// \brief Qt mouse move event during drag and drop
+      /// \param[in] _event Qt mouse drag and drop event
       protected: void mouseMoveEvent(QGraphicsSceneDragDropEvent *_event);
 
-      protected: void mousePressEvent(QGraphicsSceneMouseEvent *_event);
-
-      protected: void mousePressEvent(QGraphicsSceneDragDropEvent *_event);
-
-      protected: void mouseReleaseEvent(QGraphicsSceneMouseEvent *_event);
-
+      /// \brief Index of this corner grabber
       private: int index;
 
+      /// \brief Mouse press X position in pixels.
       private: double mouseDownX;
 
+      /// \brief Mouse press Y position in pixels.
       private: double mouseDownY;
 
+      /// \brief Fill color of the grabber handle.
       private: QColor handleColor;
 
+      /// \brief Border color of the grabber handle.
       private: QColor borderColor;
 
+      /// \brief Width of the grabber handle in pixels.
       private: double width;
 
+      /// \brief Height of the grabber handle in pixels.
       private: double height;
 
+      /// \brief Extra width for the mouse grab hotspot for easy grabbing.
       private: double widthGrabBuffer;
 
+      /// \brief Extra height for the mouse grab hotspot for easy grabbing.
       private: double heightGrabBuffer;
 
+      /// \brief Current mouse state.
       private: int mouseButtonState;
-
-      private: double size;
     };
   }
 }

File gazebo/gui/model_editor/GridLines.cc

 }
 
 /////////////////////////////////////////////////
-void GridLines::HandleWindowSizeChanged(int _w, int _h)
+void GridLines::SetSize(int _width, int _height)
 {
-  this->width = _w;
-  this->height = _h;
+  this->width = _width;
+  this->height = _height;
 }
 
 /////////////////////////////////////////////////

File gazebo/gui/model_editor/GridLines.hh

   {
     class GridLines : public  QGraphicsItem
     {
+      /// \brief Constructor
+      /// \param[in] _width Width of grid lines in pixels.
+      /// \param[in] _height Height of grid lines in pixels.
       public : GridLines(int _width, int _height);
 
+      /// \brief Destructor
       public : ~GridLines();
 
-      public : void HandleWindowSizeChanged(int _w, int _h);
+      /// \return Set the size of grid lines in pixels.
+      /// \param[in] _width Width of grid lines in pixels.
+      /// \param[in] _height Height of grid lines in pixels.
+      public : void SetSize(int _width, int _height);
 
+      /// \brief Get the bounding box of the grid lines
+      /// \return The bounding box of the grid lines
       private: virtual QRectF boundingRect() const;
 
+      /// \brief Qt paint function for drawing the grid lines.
+      /// \param[in] _painter Qt painter object.
+      /// \param[in] _painter Qt style options for the item.
+      /// \param[in] _painter Qt widget being painted on.
       private: virtual void paint(QPainter *_painter,
         const QStyleOptionGraphicsItem *_option, QWidget *_widget);
 
+      /// \brief Qt mouse move event
+      /// \param[in] _event Qt mouse event
       private: virtual void mouseMoveEvent(QGraphicsSceneMouseEvent *_event);
 
+      /// \brief Qt mouse press event
+      /// \param[in] _event Qt mouse event
+      private: virtual void mousePressEvent(QGraphicsSceneMouseEvent *_event);
+
+      /// \brief Qt mouse move event during drag and drop
+      /// \param[in] _event Qt mouse event
       private: virtual void mouseMoveEvent(QGraphicsSceneDragDropEvent *_event);
 
-      private: virtual void mousePressEvent(QGraphicsSceneMouseEvent *_event);
-
+      /// \brief Qt mouse press event
+      /// \param[in] _event Qt mouse event
       private: virtual void mousePressEvent(
           QGraphicsSceneDragDropEvent *_event);
 
+      /// \brief Width of grid lines in pixels.
       private: int width;
 
+      /// \brief height of grid lines in pixels.
       private: int height;
 
+      /// \brief Space between the lines in pixels.
       private: int space;
-          };
+    };
   }
 }
 #endif

File gazebo/gui/model_editor/LevelInspectorDialog.hh

     {
       Q_OBJECT
 
-      public: enum type {WINDOW, DOOR};
+      /// \brief Dialog mode.
+      public: enum mode {WINDOW, DOOR};
 
+      /// \brief Constructor
+      /// \param[in] _parent Parent QWidget.
       public: LevelInspectorDialog(QWidget *_parent = 0);
 
+      /// \brief Destructor
       public: ~LevelInspectorDialog();
 
+      /// \brief Get the name of the level
+      /// \return The level name
       public: std::string GetLevelName() const;
 
+      /// \brief Get the height of the level in pixels
+      /// \return The level height in pixels
       public: double GetHeight() const;
 
+      /// \brief Set the name of the level
+      /// \param[in] _levelName New level name.
       public: void SetLevelName(const std::string &_levelName);
 
+      /// \brief Set the height of the level
+      /// \param[in] _height Level height in pixels.
       public: void SetHeight(double _height);
 
+      /// \brief Qt signal emitted to indicate that changes should be applied
       Q_SIGNALS: void Applied();
 
+      /// \brief Qt callback when the Cancel button is pressed
       private slots: void OnCancel();
 
+      /// \brief Qt callback when the Apply button is pressed
       private slots: void OnApply();
 
+      /// \brief Qt callback when the Ok button is pressed
       private slots: void OnOK();
 
+      /// \brief Editable line that holds the the level name
       private: QLineEdit* levelNameLineEdit;
 
+      /// \brief Spin box for configuring the level height
       private: QDoubleSpinBox *heightSpinBox;
 
+      /// \brief Spin box for configuring the floor thickness
       private: QDoubleSpinBox *floorThicknessSpinBox;
 
+      /// \brief Combo box for configuring the floor material
       private: QComboBox *materialComboBox;
     };
   }

File gazebo/gui/model_editor/StairsInspectorDialog.hh

     {
       Q_OBJECT
 
+      /// \brief Constructor
+      /// \param[in] _parent Parent QWidget.
       public: StairsInspectorDialog(QWidget *_parent = 0);
 
+      /// \brief Destructor
       public: ~StairsInspectorDialog();
 
+      /// \brief Get starting position (bottom-end) of the staircase in pixels.
       public: QPointF GetStartPosition() const;
 
+      /// \brief Get the width the staircase in pixels.
+      /// \return Staircase width in pixels.
       public: double GetWidth() const;
 
+      /// \brief Get the depth the staircase in pixels
+      /// \return Staircase depth in pixels.
       public: double GetDepth() const;
 
+      /// \brief Get the height the staircase in pixels
+      /// \return Staircase height in pixels.
       public: double GetHeight() const;
 
+      /// \brief Get the number of steps in the staircase.
+      /// \return Number of steps in the staircase.
       public: int GetSteps() const;
 
+      /// \brief Set the name of the staircase.
+      /// \param[in] _name Name to set to.
       public: void SetName(const std::string &_name);
 
+      /// \brief Set the starting position of the staircase.
+      /// \param[in] _pos Starting position in pixels.
       public: void SetStartPosition(const QPointF &_pos);
 
+      /// \brief Set the width of the staircase.
+      /// \param[in] _pos Width in pixels.
       public: void SetWidth(double _width);
 
+      /// \brief Set the depth of the staircase.
+      /// \param[in] _pos depth in pixels.
       public: void SetDepth(double _depth);
 
+      /// \brief Set the height of the staircase.
+      /// \param[in] _pos height in pixels.
       public: void SetHeight(double _height);
 
+      /// \brief Set the number of steps in the staircase.
+      /// \param[in] _pos Number of steps.
       public: void SetSteps(int _steps);
 
+      /// \brief Qt signal emitted to indicate that changes should be applied.
       Q_SIGNALS: void Applied();
 
+      /// \brief Qt callback when the Cancel button is pressed.
       private slots: void OnCancel();
 
+      /// \brief Qt callback when the Apply button is pressed.
       private slots: void OnApply();
 
+      /// \brief Qt callback when the Ok button is pressed.
       private slots: void OnOK();
 
+      /// \brief Spin box for configuring the X starting position of the
+      /// staircase.
       private: QDoubleSpinBox *startXSpinBox;
 
+      /// \brief Spin box for configuring the Y starting position of the
+      /// staircase.
       private: QDoubleSpinBox *startYSpinBox;
 
+      /// \brief Spin box for configuring the width of the staircase.
       private: QDoubleSpinBox *widthSpinBox;
 
+      /// \brief Spin box for configuring the depth of the staircase.
       private: QDoubleSpinBox *depthSpinBox;
 
+      /// \brief Spin box for configuring the height of the staircase.
       private: QDoubleSpinBox *heightSpinBox;
 
+      /// \brief Spin box for configuring the number of steps in the staircase.
       private: QSpinBox *stepsSpinBox;
 
+      /// \brief Label that displays the name of the staircase
       private: QLabel* stairsNameLabel;
     };
   }

File gazebo/gui/model_editor/WallInspectorDialog.hh

     {
       Q_OBJECT
 
+      /// \brief Constructor
+      /// \param[in] _parent Parent QWidget.
       public: WallInspectorDialog(QWidget *_parent = 0);
 
+      /// \brief Destructor
       public: ~WallInspectorDialog();
 
       public: double GetLength() const;
 
       public: void SetMaterial(const std::string &_material);
 
+      /// \brief Qt signal emitted to indicate that changes should be applied
       Q_SIGNALS: void Applied();
 
+      /// \brief Qt callback when the Cancel button is pressed
       private slots: void OnCancel();
 
+      /// \brief Qt callback when the Apply button is pressed
       private slots: void OnApply();
 
+      /// \brief Qt callback when the Ok button is pressed
       private slots: void OnOK();
 
       private: QDoubleSpinBox *startXSpinBox;

File gazebo/gui/model_editor/WindowDoorInspectorDialog.cc

 using namespace gui;
 
 /////////////////////////////////////////////////
-WindowDoorInspectorDialog::WindowDoorInspectorDialog(int _type,
+WindowDoorInspectorDialog::WindowDoorInspectorDialog(int _mode,
   QWidget *_parent) : QDialog(_parent)
 {
   this->setObjectName("windowDoorInspectorDialog");
 
-  this->modelType = _type;
+  int dialogMode = _mode;
 
-  if (this->modelType == WINDOW)
-    this->modelTypeStr = "Window";
-  else if (this->modelType == DOOR)
-    this->modelTypeStr = "Door";
+  std::string dialogModeStr = "";
+  if (dialogMode == WINDOW)
+    dialogModeStr = "Window";
+  else if (dialogMode == DOOR)
+    dialogModeStr = "Door";
 
-  std::string titleStr = modelTypeStr + " Inspector";
+  std::string titleStr = dialogModeStr + " Inspector";
   this->setWindowTitle(tr(titleStr.c_str()));
 
-  std::string modelLabelStr = modelTypeStr + " Name:";
-  QLabel *modelLabel = new QLabel(tr(modelLabelStr.c_str()));
-  this->modelNameLabel = new QLabel(tr(""));
+  std::string itemLabelStr = dialogModeStr + " Name:";
+  QLabel *itemlLabel = new QLabel(tr(itemLabelStr.c_str()));
+  this->itemNameLabel = new QLabel(tr(""));
 
   QHBoxLayout *nameLayout = new QHBoxLayout;
-  nameLayout->addWidget(modelLabel);
-  nameLayout->addWidget(modelNameLabel);
+  nameLayout->addWidget(itemlLabel);
+  nameLayout->addWidget(itemNameLabel);
 
   QLabel *widthLabel = new QLabel(tr("Width: "));
 //  QLabel *depthLabel = new QLabel(tr("Depth: "));
 /////////////////////////////////////////////////
 void WindowDoorInspectorDialog::SetName(const std::string &_name)
 {
-  this->modelNameLabel->setText(tr(_name.c_str()));
+  this->itemNameLabel->setText(tr(_name.c_str()));
 }
 
 /////////////////////////////////////////////////

File gazebo/gui/model_editor/WindowDoorInspectorDialog.hh

     {
       Q_OBJECT
 
-      public: enum type {WINDOW, DOOR};
+      /// \brief Dialog mode
+      public: enum mode {WINDOW, DOOR};
 
-      public: WindowDoorInspectorDialog(int _type = WINDOW,
+      /// \brief Constructor
+      /// \param[in] _mode Dialog mode
+      /// \param[in] _parent Parent QWidget.
+      public: WindowDoorInspectorDialog(int _mode = WINDOW,
           QWidget *_parent = 0);
 
+      /// \brief Destructor
       public: ~WindowDoorInspectorDialog();
 
+      /// \brief Get the item width
+      /// \return Width in pixels.
       public: double GetWidth() const;
 
+      /// \brief Get the item height
+      /// \return Height in pixels.
       public: double GetHeight() const;
 
+      /// \brief Get the item depth
+      /// \return Depth in pixels.
       public: double GetDepth() const;
 
+      /// \brief Get the item position
+      /// \return Item position in pixels.
       public: QPointF GetPosition() const;
 
+      /// \brief Get the item elevation
+      /// \return Item elevation
       public: double GetElevation() const;
 
+      /// \brief Get the item type
+      /// \return Item type
       public: std::string GetType() const;
 
+      /// \brief Set the item name
+      /// \param[in] _depth Name to set to.
       public: void SetName(const std::string &_name);
 
+      /// \brief Set the item width in pixels.
+      /// \param[in] _depth Width in pixels.
       public: void SetWidth(double _width);
 
+      /// \brief Set the item height in pixels.
+      /// \param[in] _depth Height in pixels.
       public: void SetHeight(double _height);
 
+      /// \brief Set the item depth in pixels.
+      /// \param[in] _depth Depth in pixels.
       public: void SetDepth(double _depth);
 
+      /// \brief Set the item position in pixels.
+      /// \param[in] _pos Position in pixels.
       public: void SetPosition(const QPointF &_pos);
 
+      /// \brief Set the item elevation.
+      /// \param[in] _elevation Item elevation.
       public: void SetElevation(double _elevation);
 
+      /// \brief Set the item type.
+      /// \param[in] _type Item type.
       public: void SetType(const std::string &_type);
 
+      /// \brief Qt signal emitted to indicate that changes should be applied.
       Q_SIGNALS: void Applied();
 
+      /// \brief Qt callback when the Cancel button is pressed.
       private slots: void OnCancel();
 
+      /// \brief Qt callback when the Apply button is pressed.
       private slots: void OnApply();
 
+      /// \brief Qt callback when the Ok button is pressed.
       private slots: void OnOK();
 
-      private: QLabel* modelNameLabel;
+      /// \brief Label that displays the name of the item.
+      private: QLabel* itemNameLabel;
 
-      private: int modelType;
-
-      private: std::string modelTypeStr;
-
+      /// \brief Spin box for configuring the width of the item.
       private: QDoubleSpinBox *widthSpinBox;
 
+      /// \brief Spin box for configuring the depth of the item.
       private: QDoubleSpinBox *depthSpinBox;
 
+      /// \brief Spin box for configuring the height of the item.
       private: QDoubleSpinBox *heightSpinBox;
 
+      /// \brief Spin box for configuring the X position of the item.
       private: QDoubleSpinBox *positionXSpinBox;
 
+      /// \brief Spin box for configuring the Y position of the item.
       private: QDoubleSpinBox *positionYSpinBox;
 
+      /// \brief Spin box for configuring the elevation of the item.
       private: QDoubleSpinBox *elevationSpinBox;
 
+      /// \brief Combo box for selecting the type of the item.
       private: QComboBox *typeComboBox;
     };
   }