]> SALOME platform Git repositories - modules/shaper.git/commitdiff
Salome HOME
Modify Box help page according to request
authorvsv <vsv@opencascade.com>
Wed, 29 Aug 2018 14:10:38 +0000 (17:10 +0300)
committervsv <vsv@opencascade.com>
Wed, 29 Aug 2018 14:10:38 +0000 (17:10 +0300)
src/PrimitivesPlugin/doc/boxFeature.rst
src/PrimitivesPlugin/doc/images/Box_2points.png
src/PrimitivesPlugin/doc/images/Box_dimensions.png
src/PrimitivesPlugin/doc/images/box.png [new file with mode: 0644]
src/PrimitivesPlugin/doc/images/box_2pt_32x32.png [new file with mode: 0644]
src/PrimitivesPlugin/doc/images/box_dxyz_32x32.png [new file with mode: 0644]

index a97423fb79e8ae9d6b4feac36713a05d68e90a9a..e1b7713c7d2b739b9a0e10954197482678be102f 100644 (file)
@@ -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.
 
index d5131cd024fabac0246423c238ed7bdcf47009ff..c8f88fff4fa0aeea6a0bd5c3adbe20ab28d2ba33 100644 (file)
Binary files a/src/PrimitivesPlugin/doc/images/Box_2points.png and b/src/PrimitivesPlugin/doc/images/Box_2points.png differ
index 4ce8d31a80cc6000a76862ec1db1dfe5ec940a63..8fee3ead8cf821908470c1bbab1465b51958d9ee 100644 (file)
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 (file)
index 0000000..2b0757b
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 (file)
index 0000000..1294e03
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 (file)
index 0000000..297c9a8
Binary files /dev/null and b/src/PrimitivesPlugin/doc/images/box_dxyz_32x32.png differ