From: vsv Date: Wed, 29 Aug 2018 14:10:38 +0000 (+0300) Subject: Modify Box help page according to request X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=97db9ea6fec1baaed68b995ed91d5ef5b2263de1;p=modules%2Fshaper.git Modify Box help page according to request --- diff --git a/src/PrimitivesPlugin/doc/boxFeature.rst b/src/PrimitivesPlugin/doc/boxFeature.rst index a97423fb7..e1b7713c7 100644 --- a/src/PrimitivesPlugin/doc/boxFeature.rst +++ b/src/PrimitivesPlugin/doc/boxFeature.rst @@ -3,12 +3,14 @@ Box === +The feature Box lets to create a solid of a box shape. + To create a Box in the active part: #. select in the Main Menu *Primitives - > Box* item or -#. click **Box** button in the toolbar +#. click **Box** button in the toolbar: -.. image:: images/Box_button.png +.. image:: images/box.png :align: center .. centered:: @@ -16,37 +18,43 @@ To create a Box in the active part: There are 2 algorithms for creation of a Box: -.. image:: images/Box_dimensions.png - :align: center - -.. centered:: - **By dimensions** +.. image:: images/box_2pt_32x32.png + :align: left +**By dimensions** creates a box by dimensions along X, Y, Z axis. + +.. image:: images/box_dxyz_32x32.png + :align: left +**By two points** creates a box by two points of the box diagnal. -and -.. image:: images/Box_2points.png - :align: center - -.. centered:: - **By two points** +By dimensions +""""""""""""" -The description of input fields for **By dimensions** tab is given below: +.. image:: images/Box_dimensions.png + :align: center -- **DX**, **DY**, **DZ** specify box dimensions along the coordinate axes for box with vertex coinciding with coordinate origin. +In this case it is necessary to specify **DX**, **DY**, **DZ** sizes of the box along corresponded coordinate axes. The box will be created starting from the origin. **TUI Command**: *model.addBox(Part_doc, DX, DY, DZ)* **Arguments**: 1 Part + 3 values (dimensions at origin). -The description of input fields for **By two points** tab is given below: -- selected **Point 1** and **Point 2** define the opposite vertices of the box. +By two points +""""""""""""" + +.. image:: images/Box_2points.png + :align: center + +In this case it is necessary to select **Point 1** and **Point 2** to define a diagonal points of the box. **TUI Command**: *model.addBox(Part_doc, FirstPoint, SecondPoint)* **Arguments**: 1 Part + 2 selected points (opposite vertices of the box) +Result +"""""" The Result of operation will be a SOLID. The edges of the box will be parallel to the coordinate axes. diff --git a/src/PrimitivesPlugin/doc/images/Box_2points.png b/src/PrimitivesPlugin/doc/images/Box_2points.png index d5131cd02..c8f88fff4 100644 Binary files a/src/PrimitivesPlugin/doc/images/Box_2points.png and b/src/PrimitivesPlugin/doc/images/Box_2points.png differ diff --git a/src/PrimitivesPlugin/doc/images/Box_dimensions.png b/src/PrimitivesPlugin/doc/images/Box_dimensions.png index 4ce8d31a8..8fee3ead8 100644 Binary files a/src/PrimitivesPlugin/doc/images/Box_dimensions.png and b/src/PrimitivesPlugin/doc/images/Box_dimensions.png differ diff --git a/src/PrimitivesPlugin/doc/images/box.png b/src/PrimitivesPlugin/doc/images/box.png new file mode 100644 index 000000000..2b0757b05 Binary files /dev/null and b/src/PrimitivesPlugin/doc/images/box.png differ diff --git a/src/PrimitivesPlugin/doc/images/box_2pt_32x32.png b/src/PrimitivesPlugin/doc/images/box_2pt_32x32.png new file mode 100644 index 000000000..1294e0391 Binary files /dev/null and b/src/PrimitivesPlugin/doc/images/box_2pt_32x32.png differ diff --git a/src/PrimitivesPlugin/doc/images/box_dxyz_32x32.png b/src/PrimitivesPlugin/doc/images/box_dxyz_32x32.png new file mode 100644 index 000000000..297c9a8e4 Binary files /dev/null and b/src/PrimitivesPlugin/doc/images/box_dxyz_32x32.png differ