]> SALOME platform Git repositories - modules/shaper.git/commitdiff
Salome HOME
Modification of build plugin documentation
authorvsv <vsv@opencascade.com>
Fri, 31 Aug 2018 12:54:18 +0000 (15:54 +0300)
committervsv <vsv@opencascade.com>
Fri, 31 Aug 2018 12:54:18 +0000 (15:54 +0300)
43 files changed:
src/BuildPlugin/doc/compoundFeature.rst
src/BuildPlugin/doc/compsolidFeature.rst
src/BuildPlugin/doc/edgeFeature.rst
src/BuildPlugin/doc/faceFeature.rst
src/BuildPlugin/doc/fillingFeature.rst
src/BuildPlugin/doc/images/Compound.png
src/BuildPlugin/doc/images/Compsolid.png
src/BuildPlugin/doc/images/CreateCompound.png
src/BuildPlugin/doc/images/CreateCompsolid.png
src/BuildPlugin/doc/images/CreateEdge.png
src/BuildPlugin/doc/images/CreateFace.png
src/BuildPlugin/doc/images/CreateFilling.png
src/BuildPlugin/doc/images/CreateInterpolation.png
src/BuildPlugin/doc/images/CreateShell.png
src/BuildPlugin/doc/images/CreateSolid.png
src/BuildPlugin/doc/images/CreateVertex.png
src/BuildPlugin/doc/images/CreateWire.png
src/BuildPlugin/doc/images/Edge.png
src/BuildPlugin/doc/images/Face.png
src/BuildPlugin/doc/images/Filling.png
src/BuildPlugin/doc/images/Interpolation.png
src/BuildPlugin/doc/images/Shell.png
src/BuildPlugin/doc/images/Solid.png
src/BuildPlugin/doc/images/Vertex.png
src/BuildPlugin/doc/images/Wire.png
src/BuildPlugin/doc/interpolationFeature.rst
src/BuildPlugin/doc/shellFeature.rst
src/BuildPlugin/doc/solidFeature.rst
src/BuildPlugin/doc/vertexFeature.rst
src/BuildPlugin/doc/wireFeature.rst
src/PrimitivesPlugin/doc/PrimitivesPlugin.rst
src/PrimitivesPlugin/doc/boxFeature.rst
src/PrimitivesPlugin/doc/coneFeature.rst
src/PrimitivesPlugin/doc/cylinderFeature.rst
src/PrimitivesPlugin/doc/images/Boxes.png
src/PrimitivesPlugin/doc/images/Cone_res.png
src/PrimitivesPlugin/doc/images/Cylinders.png
src/PrimitivesPlugin/doc/images/Sphere_res.png
src/PrimitivesPlugin/doc/images/Torus_res.png
src/PrimitivesPlugin/doc/images/cylinder_32x32.png [new file with mode: 0644]
src/PrimitivesPlugin/doc/images/cylinder_portion_32x32.png [new file with mode: 0644]
src/PrimitivesPlugin/doc/sphereFeature.rst
src/PrimitivesPlugin/doc/torusFeature.rst

index b3b535630789d46a32f9ae940ca2a583e0811d60..c3fc9761c59399313a12b4fadb241a29a1f4ec89 100644 (file)
@@ -2,6 +2,8 @@
 Compound
 ========
 
+The Compound feature creates a compound using already existing shapes in other objects.
+
 To create compound in the active part:
 
 #. select in the Main Menu *Build - > Compound* item  or
@@ -31,6 +33,9 @@ Select one or several shapes in a viewer. Selected shapes can be of any type (ve
 
 **Arguments**:   Part document + list of shapes.
 
+Result
+""""""
+
 The result of the operation will be a compound created from selected shapes:
 
 .. image:: images/CreateCompound.png
index 2688bf0d1618ef28cc9862ff292181552efbbff3..4ec24428af824128c6abdcf8419061b14b7016fe 100644 (file)
@@ -2,6 +2,8 @@
 CompSolid
 =========
 
+The Compsolid feature creates a compsolid using already existing shapes in other objects.
+
 To create compsolid in the active part:
 
 #. select in the Main Menu *Build - > CompSolid* item  or
@@ -31,6 +33,9 @@ Select one or several shapes in a viewer.
 
 **Arguments**:   Part document + list of shapes.
 
+Result
+""""""
+
 The result of the operation will be a compsolid created from the selected shapes:
 
 .. image:: images/CreateCompsolid.png
index c524f3fb78318d85150af779accf51813e04fb19..2fcdf762004cc671dbd0ec172b641cf0113ea4ee 100644 (file)
@@ -2,6 +2,8 @@
 Edge
 ====
 
+The Edge feature creates one or several edges using already existing edges in other objects.
+
 To create edges in the active part:
 
 #. select in the Main Menu *Build - > Edge* item  or
@@ -31,6 +33,9 @@ Select one or several edges in viewer.
 
 **Arguments**:   Part document + list of shapes.
 
+Result
+""""""
+
 The result of the operation will be set of edges created from selected shapes:
 
 .. image:: images/CreateEdge.png
index a2e16e0628541b5104131f834b4f555934e7f04e..ea1332265e1876f88a33fe9281da45bee6f8d05b 100644 (file)
@@ -2,6 +2,8 @@
 Face
 ====
 
+The Face feature creates one or several faces using already existing faces in other objects.
+
 To create face in the active part:
 
 #. select in the Main Menu *Build - > Face* item  or
@@ -31,6 +33,9 @@ Select one or several faces in viewer.
 
 **Arguments**:   Part document + list of shapes.
 
+Result
+""""""
+
 The result of the operation will be set of faces created from selected shapes:
 
 .. image:: images/CreateFace.png
index 175ef837959ba955eda19cd3b5307664a709eebc..dd68b770908c6ce1b4a655fd1fdc0d9cb1b63294 100644 (file)
@@ -2,6 +2,8 @@
 Filling
 =======
 
+The Filling feature creates one or several faces using already existing edges or wires in other objects.
+
 To create filling in the active part:
 
 #. select in the Main Menu *Build - > Filling* item  or
@@ -33,6 +35,9 @@ Select two or more edges in a viewer.
 
 **Arguments**:   Part document + list of edges.
 
+Result
+""""""
+
 The result of the operation will be set of faces created from selected shapes:
 
 .. image:: images/CreateFilling.png
index 800c1bd34d11be57a3cc71e15a8d3cbbb45316e1..a5a398d645599c1126ed27d0c8fc77886b7836c0 100644 (file)
Binary files a/src/BuildPlugin/doc/images/Compound.png and b/src/BuildPlugin/doc/images/Compound.png differ
index 71b68c49188478a17d97f4dd71a17aca85d48ea0..eee45f0a7d3ac160047dfb70bcc07753c26f5c1a 100644 (file)
Binary files a/src/BuildPlugin/doc/images/Compsolid.png and b/src/BuildPlugin/doc/images/Compsolid.png differ
index 41f9066dbb23a57959186fcbf7e74ea10a61bb6f..f3dab8e913dc411f438532f2c9ccfcad8f680d6c 100644 (file)
Binary files a/src/BuildPlugin/doc/images/CreateCompound.png and b/src/BuildPlugin/doc/images/CreateCompound.png differ
index ffb2894183eff993989a5346579c0a02a4de9c8b..9fc90bf21d3f916ed9f345992c380ad6a94bab66 100644 (file)
Binary files a/src/BuildPlugin/doc/images/CreateCompsolid.png and b/src/BuildPlugin/doc/images/CreateCompsolid.png differ
index 3d4b980ff2f095f401275592c4a5499d0622683b..b6d9aa8e54af467ff002f26ffb715636ab3b85b9 100644 (file)
Binary files a/src/BuildPlugin/doc/images/CreateEdge.png and b/src/BuildPlugin/doc/images/CreateEdge.png differ
index 9601a7997e25570ac5b78b1361dc4bd11957b3b7..071f1066ee8f3d65d6d0dd4ab4d1ade844dd466b 100644 (file)
Binary files a/src/BuildPlugin/doc/images/CreateFace.png and b/src/BuildPlugin/doc/images/CreateFace.png differ
index 927973c0398997711ceb9c54d51be3dc660e69dd..ae162057dd07bb9ab96c95b27cad29fc3885c206 100644 (file)
Binary files a/src/BuildPlugin/doc/images/CreateFilling.png and b/src/BuildPlugin/doc/images/CreateFilling.png differ
index 40d4456f55ee8d90cbe9dd01163f24e2a4f9e6e6..0b96ff74c0046420cbbc6911a88fbf08e04d8f44 100644 (file)
Binary files a/src/BuildPlugin/doc/images/CreateInterpolation.png and b/src/BuildPlugin/doc/images/CreateInterpolation.png differ
index 3622ab4ce582497a923bf84397d0a7132610c1e9..68a2e49418cc2d4bc871f9cf70160960cec78b3b 100644 (file)
Binary files a/src/BuildPlugin/doc/images/CreateShell.png and b/src/BuildPlugin/doc/images/CreateShell.png differ
index 830283adebdfdde509900ab2308ed0cc0f4dda93..0ff1555fc8f2a7b0bf42792a5da1c5515045e9ad 100644 (file)
Binary files a/src/BuildPlugin/doc/images/CreateSolid.png and b/src/BuildPlugin/doc/images/CreateSolid.png differ
index 3391f09284848c20bc00abd89c78d3ef0593772c..fac21a86852b78b0a3e70f85b0f3c539da522b8f 100644 (file)
Binary files a/src/BuildPlugin/doc/images/CreateVertex.png and b/src/BuildPlugin/doc/images/CreateVertex.png differ
index c773dd6daab0d77f5640009836440d3cf0870428..0e488aac0540ba5384a74ee495e39f54b19360a7 100644 (file)
Binary files a/src/BuildPlugin/doc/images/CreateWire.png and b/src/BuildPlugin/doc/images/CreateWire.png differ
index 7f714594a7846fd9476575c4ad2c880c0459b523..834d4806626df0a6a23be02eacc48af5c690a998 100644 (file)
Binary files a/src/BuildPlugin/doc/images/Edge.png and b/src/BuildPlugin/doc/images/Edge.png differ
index 64cdf06543458e406308989d777c1559af16e3f2..8b05dfd0c68df768b63e4768d3ffd57a45d682f5 100644 (file)
Binary files a/src/BuildPlugin/doc/images/Face.png and b/src/BuildPlugin/doc/images/Face.png differ
index 2e79123265eb84f8625de82b24911ace5af4c54f..efbb41182d429747059405e8b176c64a2e1b1e98 100644 (file)
Binary files a/src/BuildPlugin/doc/images/Filling.png and b/src/BuildPlugin/doc/images/Filling.png differ
index c7a41627c4f293877c031a77f4bbdf694db60e7f..451452fbb00b7b31266042c3711f3f9b42da818a 100644 (file)
Binary files a/src/BuildPlugin/doc/images/Interpolation.png and b/src/BuildPlugin/doc/images/Interpolation.png differ
index b16eda7a2fb390c395880b19396dac65e605b0b9..c338f7cea1cc9d0e37f0da96efc230f74606e687 100644 (file)
Binary files a/src/BuildPlugin/doc/images/Shell.png and b/src/BuildPlugin/doc/images/Shell.png differ
index 1c6894d5b9323fb0ff6850a3c1419e82fa393821..049009247e582ffd8e8f69d21b44b1555cf09267 100644 (file)
Binary files a/src/BuildPlugin/doc/images/Solid.png and b/src/BuildPlugin/doc/images/Solid.png differ
index a7a820b6673eda3e0be803b8ba4d47cc221d335e..0c95ea3830a7f301e4799a1b1159103d84244f28 100644 (file)
Binary files a/src/BuildPlugin/doc/images/Vertex.png and b/src/BuildPlugin/doc/images/Vertex.png differ
index d147495d8ebb17df98b25f41b180467c9a348396..eeaabe3de7958ab6a354e4383478dcacdbbd9f8c 100644 (file)
Binary files a/src/BuildPlugin/doc/images/Wire.png and b/src/BuildPlugin/doc/images/Wire.png differ
index 98885782a3d275c30d4db5580ff08a9315753d56..8b61969df807e8c3d373f346ac8bc1841c51858b 100644 (file)
@@ -2,6 +2,8 @@
 Interpolation
 =============
 
+The Interpolation feature creates curve (wire) using already existing vertices in other objects.
+
 To create interpolation in the active part:
 
 #. select in the Main Menu *Build - > Interpolation* item  or
@@ -43,6 +45,9 @@ Select one or several vertices or points in a viewer.
 
 **Arguments**:   Part document + list of points + start edge + end edge + is closed + is reordered.
 
+Result
+""""""
+
 The result of the operation will be a curve created from selected shapes:
 
 .. image:: images/CreateInterpolation.png
index 18d40fd74e4a76930115de77e95d2e35ff327d9f..b9fd21cd0a2ca2c6290c5523943f875d1438e2ac 100644 (file)
@@ -2,6 +2,8 @@
 Shell
 =====
 
+The Shell feature creates a shell using already existing faces in other objects.
+
 To create shell in the active part:
 
 #. select in the Main Menu *Build - > Shell* item  or
@@ -31,6 +33,9 @@ Select one or several faces in viewer.
 
 **Arguments**:   Part document + list of shapes.
 
+Result
+""""""
+
 The result of the operation will be shell created from selected shapes:
 
 .. image:: images/CreateShell.png
index 193491a7bdae3486283569b1907e1c09ccfd80df..63cf6693a5c81a14cc103c7b6343e1b2fb22e870 100644 (file)
@@ -2,6 +2,8 @@
 Solid
 =====
 
+The Solid feature creates a solid using already existing faces in other objects.
+
 To create solid in the active part:
 
 #. select in the Main Menu *Build - > Solid* item  or
@@ -31,6 +33,9 @@ Select one or several faces in viewer. Selected faces have to define a closed vo
 
 **Arguments**:   Part document + list of shapes.
 
+Result
+""""""
+
 The result of the operation will be a solid created from selected shapes:
 
 .. image:: images/CreateSolid.png
index 0ce4412911c4dfd27196ed6d744155a1538dc7b1..e2fdbbe3ae5cc07fc05191b512a485b2f3cd5c15 100644 (file)
@@ -2,6 +2,8 @@
 Vertex
 ======
 
+The Vertex feature creates one or several vertices using already existing vertices in other objects.
+
 To create vertices in the active part:
 
 #. select in the Main Menu *Build - > Vertex* item  or
@@ -31,6 +33,9 @@ Select one or several vertices in viewer.
 
 **Arguments**:   Part document + list of shapes.
 
+Result
+""""""
+
 The result of the operation will be set of vertices created from selected shapes:
 
 .. image:: images/CreateVertex.png
index 6f3a6d32efa7de40bbcd621d8fe5e358b7a9ee10..0cf5bc4087212994235113b52c7882bf0b779bad 100644 (file)
@@ -2,6 +2,8 @@
 Wire
 ====
 
+The Wire feature creates a wire using already existing edges in other objects.
+
 To create wire in the active part:
 
 #. select in the Main Menu *Build - > Wire* item  or
@@ -31,6 +33,9 @@ Select one or several edges in viewer. For automatic selection of closed contour
 
 **Arguments**:   Part document + list of shapes.
 
+Result
+""""""
+
 The result of the operation will be a wire created from selected shapes:
 
 .. image:: images/CreateWire.png
index c85fc9b86607e4ca9fa38f6a47093be7e41c73ec..d6da26e54a2c8bc38e0850849283a14235fa7f73 100644 (file)
@@ -4,6 +4,8 @@
 Primitives plug-in
 ==================
 
+The Primitives plug-in contains features dedicated to creation of geometrical primitives. Result of each feature is a solid. The plug-in includes following features:
+
 .. toctree::
    :titlesonly:
    :maxdepth: 1
@@ -13,12 +15,3 @@ Primitives plug-in
    cylinderFeature.rst
    sphereFeature.rst
    torusFeature.rst
-
-
-The Main Menu *Primitives* creates volumical geometrical objects.
-   
-Each item of  Main Menu *Primitives* opens corresponding property panel.
-
-**Apply** button in  property panel creates object with defined parameters.
-  
-**Cancel** button cancels operation.
index e1b7713c7d2b739b9a0e10954197482678be102f..a79496926f582dc470376f281775d2c3615722ae 100644 (file)
@@ -3,7 +3,7 @@
 Box
 ===
 
-The feature Box lets to create a solid of a box shape.
+The feature Box creates a box solid.
 
 To create a Box in the active part:
 
index d4461739d39578d84df8de8666f104bf9b962fe6..47d33818d0447e1452ab52ae8b4c7a388a67d103 100644 (file)
@@ -2,6 +2,8 @@
 Cone
 ====
 
+The feature Cone creates a cone solid.
+
 To create a Cone in the active part:
 
 #. select in the Main Menu *Primitives - > Cone* item  or
@@ -34,6 +36,9 @@ The description of input fields is given below:
 
 **Arguments**:  1 Part + 1 vertex + 1 vector + 3 values (Dimensions: base and top radii, heght).
 
+Result
+""""""
+
 The Result of operation will be a SOLID.
 
 If both radii are non-zero, then the cone will be truncated.
index e689d52d9eee1ad04adf78e354b4497b36c0335b..131f3113f39337d101d5ae9d55df7461d93485f2 100644 (file)
@@ -2,6 +2,8 @@
 Cylinder
 ========
 
+The feature Cylinder creates a cylinder solid.
+
 To create a Cylinder in the active part:
 
 #. select in the Main Menu *Primitives - > Cylinder* item  or
@@ -15,20 +17,23 @@ To create a Cylinder in the active part:
 
 There are 2 algorithms for creation of a Cylinder:
 
+.. image:: images/cylinder_32x32.png
+   :align: left
+**Cylinder** creates a cylinder.
+
+.. image:: images/cylinder_portion_32x32.png
+   :align: left
+**Portion of cylinder** creates a one segment of cylinder.
+
+Cylinder
+""""""""
+
 .. image:: images/Cylinder.png
    :align: center
        
 .. centered::
    **Cylinder**
 
-and 
-
-.. image:: images/Portion_cylinder.png
-          :align: center
-                  
-.. centered::
-   **Portion of cylinder**  
-
 The description of input fields for **Cylinder** tab is given below:
 
 - selected **Point** defines center of the cylinder base;
@@ -37,14 +42,31 @@ The description of input fields for **Cylinder** tab is given below:
    - **Radius**;
    - **Height**.    
 
+**TUI Commands**:
+
+* *model.addCylinder(Part_doc, Point, Axis, Radius, Height)*
+
+**Arguments**:   1 Part + 1 vertex +1 vector +  2 values (dimensions: radius, height).
+
+Portion of cylinder
+"""""""""""""""""""
+
+.. image:: images/Portion_cylinder.png
+          :align: center
+                  
+.. centered::
+   **Portion of cylinder**  
+
 Input fields for ***Portion of cylinder** tab includes in addition **Angle** to create a portion of cylinder.
 
 **TUI Commands**:
 
-* *model.addCylinder(Part_doc, Point, Axis, Radius, Height)*
 * *model.addCylinder(Part_doc, Point, Axis, Radius, Height,Angle)*
   
-**Arguments**:   1 Part + 1 vertex +1 vector +  2 or 3 values (dimensions: radius, height and angle).
+**Arguments**:   1 Part + 1 vertex +1 vector +  3 values (dimensions: radius, height and angle).
+
+Result
+""""""
 
 The Result of operation will be a SOLID.
 
index 5bc6dc9393146e2419976025fcf8d4180ab676bf..dec906f118fdc822200c9cb268720137caec15d2 100644 (file)
Binary files a/src/PrimitivesPlugin/doc/images/Boxes.png and b/src/PrimitivesPlugin/doc/images/Boxes.png differ
index 35ef6805ad1dae6e03dadfaa198557b5f0a730cd..6ad50cce902a292afcc91a13820f80e96a3f02e1 100755 (executable)
Binary files a/src/PrimitivesPlugin/doc/images/Cone_res.png and b/src/PrimitivesPlugin/doc/images/Cone_res.png differ
index da841675fb3eb0524794e0dcd3adcd0931ed0829..9c5bb84c9dbb9a8d0064a49d424ab7422725c701 100644 (file)
Binary files a/src/PrimitivesPlugin/doc/images/Cylinders.png and b/src/PrimitivesPlugin/doc/images/Cylinders.png differ
index 93c6f73dc206c44d0d78216a9c5ba3379908cc26..5cb5dc051e3c4f617c9a5cbb99c6527596c91e5c 100644 (file)
Binary files a/src/PrimitivesPlugin/doc/images/Sphere_res.png and b/src/PrimitivesPlugin/doc/images/Sphere_res.png differ
index 0a86b47e0a73d276dec8502e353cf19432eb8115..661c3c559858c21d005b82b40d22a9cdf1d52559 100644 (file)
Binary files a/src/PrimitivesPlugin/doc/images/Torus_res.png and b/src/PrimitivesPlugin/doc/images/Torus_res.png differ
diff --git a/src/PrimitivesPlugin/doc/images/cylinder_32x32.png b/src/PrimitivesPlugin/doc/images/cylinder_32x32.png
new file mode 100644 (file)
index 0000000..6de9c1c
Binary files /dev/null and b/src/PrimitivesPlugin/doc/images/cylinder_32x32.png differ
diff --git a/src/PrimitivesPlugin/doc/images/cylinder_portion_32x32.png b/src/PrimitivesPlugin/doc/images/cylinder_portion_32x32.png
new file mode 100644 (file)
index 0000000..790d6ab
Binary files /dev/null and b/src/PrimitivesPlugin/doc/images/cylinder_portion_32x32.png differ
index cba9309ebb9d591ebf6f7f8c4a248e2749b06d3d..12e418a4da7831832ee3620c16f7a537d9f4994d 100644 (file)
@@ -2,6 +2,8 @@
 Sphere
 ======
 
+The feature Sphere creates a sphere solid.
+
 To create a Sphere in the active part:
 
 #. select in the Main Menu *Primitives - > Sphere* item  or
@@ -30,6 +32,9 @@ The description of input fields is given below:
 
 **Arguments**:  1 Part + 1 vertex +1 value (radius).
 
+Result
+""""""
+
 The Result of operation will be a SOLID.
 
 Name is assigned automatically:
index 2678da430bd7fcfb80ec8491bf501b316547b0e5..b739527d2e7c99af777703fd07a5b8612480ad4a 100644 (file)
@@ -2,6 +2,8 @@
 Torus
 =====
 
+The feature Torus creates a torus solid.
+
 To create a Torus in the active part:
 
 #. select in the Main Menu *Primitives - > Torus* item  or
@@ -33,6 +35,9 @@ The following property panel appears.
 
 **Arguments**:  1 Part + 1 vertex + 1 vector + 2 values (Dimensions: first and second radii).
 
+Result
+""""""
+
 The Result of operation will be a SOLID.
 
 Name is assigned automatically: