From: vsv Date: Fri, 31 Aug 2018 12:54:18 +0000 (+0300) Subject: Modification of build plugin documentation X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=0f9f886f51d57233804cdcac185cd7568ae4cc83;p=modules%2Fshaper.git Modification of build plugin documentation --- diff --git a/src/BuildPlugin/doc/compoundFeature.rst b/src/BuildPlugin/doc/compoundFeature.rst index b3b535630..c3fc9761c 100644 --- a/src/BuildPlugin/doc/compoundFeature.rst +++ b/src/BuildPlugin/doc/compoundFeature.rst @@ -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 diff --git a/src/BuildPlugin/doc/compsolidFeature.rst b/src/BuildPlugin/doc/compsolidFeature.rst index 2688bf0d1..4ec24428a 100644 --- a/src/BuildPlugin/doc/compsolidFeature.rst +++ b/src/BuildPlugin/doc/compsolidFeature.rst @@ -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 diff --git a/src/BuildPlugin/doc/edgeFeature.rst b/src/BuildPlugin/doc/edgeFeature.rst index c524f3fb7..2fcdf7620 100644 --- a/src/BuildPlugin/doc/edgeFeature.rst +++ b/src/BuildPlugin/doc/edgeFeature.rst @@ -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 diff --git a/src/BuildPlugin/doc/faceFeature.rst b/src/BuildPlugin/doc/faceFeature.rst index a2e16e062..ea1332265 100644 --- a/src/BuildPlugin/doc/faceFeature.rst +++ b/src/BuildPlugin/doc/faceFeature.rst @@ -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 diff --git a/src/BuildPlugin/doc/fillingFeature.rst b/src/BuildPlugin/doc/fillingFeature.rst index 175ef8379..dd68b7709 100644 --- a/src/BuildPlugin/doc/fillingFeature.rst +++ b/src/BuildPlugin/doc/fillingFeature.rst @@ -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 diff --git a/src/BuildPlugin/doc/images/Compound.png b/src/BuildPlugin/doc/images/Compound.png index 800c1bd34..a5a398d64 100644 Binary files a/src/BuildPlugin/doc/images/Compound.png and b/src/BuildPlugin/doc/images/Compound.png differ diff --git a/src/BuildPlugin/doc/images/Compsolid.png b/src/BuildPlugin/doc/images/Compsolid.png index 71b68c491..eee45f0a7 100644 Binary files a/src/BuildPlugin/doc/images/Compsolid.png and b/src/BuildPlugin/doc/images/Compsolid.png differ diff --git a/src/BuildPlugin/doc/images/CreateCompound.png b/src/BuildPlugin/doc/images/CreateCompound.png index 41f9066db..f3dab8e91 100644 Binary files a/src/BuildPlugin/doc/images/CreateCompound.png and b/src/BuildPlugin/doc/images/CreateCompound.png differ diff --git a/src/BuildPlugin/doc/images/CreateCompsolid.png b/src/BuildPlugin/doc/images/CreateCompsolid.png index ffb289418..9fc90bf21 100644 Binary files a/src/BuildPlugin/doc/images/CreateCompsolid.png and b/src/BuildPlugin/doc/images/CreateCompsolid.png differ diff --git a/src/BuildPlugin/doc/images/CreateEdge.png b/src/BuildPlugin/doc/images/CreateEdge.png index 3d4b980ff..b6d9aa8e5 100644 Binary files a/src/BuildPlugin/doc/images/CreateEdge.png and b/src/BuildPlugin/doc/images/CreateEdge.png differ diff --git a/src/BuildPlugin/doc/images/CreateFace.png b/src/BuildPlugin/doc/images/CreateFace.png index 9601a7997..071f1066e 100644 Binary files a/src/BuildPlugin/doc/images/CreateFace.png and b/src/BuildPlugin/doc/images/CreateFace.png differ diff --git a/src/BuildPlugin/doc/images/CreateFilling.png b/src/BuildPlugin/doc/images/CreateFilling.png index 927973c03..ae162057d 100644 Binary files a/src/BuildPlugin/doc/images/CreateFilling.png and b/src/BuildPlugin/doc/images/CreateFilling.png differ diff --git a/src/BuildPlugin/doc/images/CreateInterpolation.png b/src/BuildPlugin/doc/images/CreateInterpolation.png index 40d4456f5..0b96ff74c 100644 Binary files a/src/BuildPlugin/doc/images/CreateInterpolation.png and b/src/BuildPlugin/doc/images/CreateInterpolation.png differ diff --git a/src/BuildPlugin/doc/images/CreateShell.png b/src/BuildPlugin/doc/images/CreateShell.png index 3622ab4ce..68a2e4941 100644 Binary files a/src/BuildPlugin/doc/images/CreateShell.png and b/src/BuildPlugin/doc/images/CreateShell.png differ diff --git a/src/BuildPlugin/doc/images/CreateSolid.png b/src/BuildPlugin/doc/images/CreateSolid.png index 830283ade..0ff1555fc 100644 Binary files a/src/BuildPlugin/doc/images/CreateSolid.png and b/src/BuildPlugin/doc/images/CreateSolid.png differ diff --git a/src/BuildPlugin/doc/images/CreateVertex.png b/src/BuildPlugin/doc/images/CreateVertex.png index 3391f0928..fac21a868 100644 Binary files a/src/BuildPlugin/doc/images/CreateVertex.png and b/src/BuildPlugin/doc/images/CreateVertex.png differ diff --git a/src/BuildPlugin/doc/images/CreateWire.png b/src/BuildPlugin/doc/images/CreateWire.png index c773dd6da..0e488aac0 100644 Binary files a/src/BuildPlugin/doc/images/CreateWire.png and b/src/BuildPlugin/doc/images/CreateWire.png differ diff --git a/src/BuildPlugin/doc/images/Edge.png b/src/BuildPlugin/doc/images/Edge.png index 7f714594a..834d48066 100644 Binary files a/src/BuildPlugin/doc/images/Edge.png and b/src/BuildPlugin/doc/images/Edge.png differ diff --git a/src/BuildPlugin/doc/images/Face.png b/src/BuildPlugin/doc/images/Face.png index 64cdf0654..8b05dfd0c 100644 Binary files a/src/BuildPlugin/doc/images/Face.png and b/src/BuildPlugin/doc/images/Face.png differ diff --git a/src/BuildPlugin/doc/images/Filling.png b/src/BuildPlugin/doc/images/Filling.png index 2e7912326..efbb41182 100644 Binary files a/src/BuildPlugin/doc/images/Filling.png and b/src/BuildPlugin/doc/images/Filling.png differ diff --git a/src/BuildPlugin/doc/images/Interpolation.png b/src/BuildPlugin/doc/images/Interpolation.png index c7a41627c..451452fbb 100644 Binary files a/src/BuildPlugin/doc/images/Interpolation.png and b/src/BuildPlugin/doc/images/Interpolation.png differ diff --git a/src/BuildPlugin/doc/images/Shell.png b/src/BuildPlugin/doc/images/Shell.png index b16eda7a2..c338f7cea 100644 Binary files a/src/BuildPlugin/doc/images/Shell.png and b/src/BuildPlugin/doc/images/Shell.png differ diff --git a/src/BuildPlugin/doc/images/Solid.png b/src/BuildPlugin/doc/images/Solid.png index 1c6894d5b..049009247 100644 Binary files a/src/BuildPlugin/doc/images/Solid.png and b/src/BuildPlugin/doc/images/Solid.png differ diff --git a/src/BuildPlugin/doc/images/Vertex.png b/src/BuildPlugin/doc/images/Vertex.png index a7a820b66..0c95ea383 100644 Binary files a/src/BuildPlugin/doc/images/Vertex.png and b/src/BuildPlugin/doc/images/Vertex.png differ diff --git a/src/BuildPlugin/doc/images/Wire.png b/src/BuildPlugin/doc/images/Wire.png index d147495d8..eeaabe3de 100644 Binary files a/src/BuildPlugin/doc/images/Wire.png and b/src/BuildPlugin/doc/images/Wire.png differ diff --git a/src/BuildPlugin/doc/interpolationFeature.rst b/src/BuildPlugin/doc/interpolationFeature.rst index 98885782a..8b61969df 100644 --- a/src/BuildPlugin/doc/interpolationFeature.rst +++ b/src/BuildPlugin/doc/interpolationFeature.rst @@ -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 diff --git a/src/BuildPlugin/doc/shellFeature.rst b/src/BuildPlugin/doc/shellFeature.rst index 18d40fd74..b9fd21cd0 100644 --- a/src/BuildPlugin/doc/shellFeature.rst +++ b/src/BuildPlugin/doc/shellFeature.rst @@ -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 diff --git a/src/BuildPlugin/doc/solidFeature.rst b/src/BuildPlugin/doc/solidFeature.rst index 193491a7b..63cf6693a 100644 --- a/src/BuildPlugin/doc/solidFeature.rst +++ b/src/BuildPlugin/doc/solidFeature.rst @@ -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 diff --git a/src/BuildPlugin/doc/vertexFeature.rst b/src/BuildPlugin/doc/vertexFeature.rst index 0ce441291..e2fdbbe3a 100644 --- a/src/BuildPlugin/doc/vertexFeature.rst +++ b/src/BuildPlugin/doc/vertexFeature.rst @@ -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 diff --git a/src/BuildPlugin/doc/wireFeature.rst b/src/BuildPlugin/doc/wireFeature.rst index 6f3a6d32e..0cf5bc408 100644 --- a/src/BuildPlugin/doc/wireFeature.rst +++ b/src/BuildPlugin/doc/wireFeature.rst @@ -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 diff --git a/src/PrimitivesPlugin/doc/PrimitivesPlugin.rst b/src/PrimitivesPlugin/doc/PrimitivesPlugin.rst index c85fc9b86..d6da26e54 100644 --- a/src/PrimitivesPlugin/doc/PrimitivesPlugin.rst +++ b/src/PrimitivesPlugin/doc/PrimitivesPlugin.rst @@ -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. diff --git a/src/PrimitivesPlugin/doc/boxFeature.rst b/src/PrimitivesPlugin/doc/boxFeature.rst index e1b7713c7..a79496926 100644 --- a/src/PrimitivesPlugin/doc/boxFeature.rst +++ b/src/PrimitivesPlugin/doc/boxFeature.rst @@ -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: diff --git a/src/PrimitivesPlugin/doc/coneFeature.rst b/src/PrimitivesPlugin/doc/coneFeature.rst index d4461739d..47d33818d 100644 --- a/src/PrimitivesPlugin/doc/coneFeature.rst +++ b/src/PrimitivesPlugin/doc/coneFeature.rst @@ -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. diff --git a/src/PrimitivesPlugin/doc/cylinderFeature.rst b/src/PrimitivesPlugin/doc/cylinderFeature.rst index e689d52d9..131f3113f 100644 --- a/src/PrimitivesPlugin/doc/cylinderFeature.rst +++ b/src/PrimitivesPlugin/doc/cylinderFeature.rst @@ -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. diff --git a/src/PrimitivesPlugin/doc/images/Boxes.png b/src/PrimitivesPlugin/doc/images/Boxes.png index 5bc6dc939..dec906f11 100644 Binary files a/src/PrimitivesPlugin/doc/images/Boxes.png and b/src/PrimitivesPlugin/doc/images/Boxes.png differ diff --git a/src/PrimitivesPlugin/doc/images/Cone_res.png b/src/PrimitivesPlugin/doc/images/Cone_res.png index 35ef6805a..6ad50cce9 100755 Binary files a/src/PrimitivesPlugin/doc/images/Cone_res.png and b/src/PrimitivesPlugin/doc/images/Cone_res.png differ diff --git a/src/PrimitivesPlugin/doc/images/Cylinders.png b/src/PrimitivesPlugin/doc/images/Cylinders.png index da841675f..9c5bb84c9 100644 Binary files a/src/PrimitivesPlugin/doc/images/Cylinders.png and b/src/PrimitivesPlugin/doc/images/Cylinders.png differ diff --git a/src/PrimitivesPlugin/doc/images/Sphere_res.png b/src/PrimitivesPlugin/doc/images/Sphere_res.png index 93c6f73dc..5cb5dc051 100644 Binary files a/src/PrimitivesPlugin/doc/images/Sphere_res.png and b/src/PrimitivesPlugin/doc/images/Sphere_res.png differ diff --git a/src/PrimitivesPlugin/doc/images/Torus_res.png b/src/PrimitivesPlugin/doc/images/Torus_res.png index 0a86b47e0..661c3c559 100644 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 index 000000000..6de9c1c6b 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 index 000000000..790d6abe9 Binary files /dev/null and b/src/PrimitivesPlugin/doc/images/cylinder_portion_32x32.png differ diff --git a/src/PrimitivesPlugin/doc/sphereFeature.rst b/src/PrimitivesPlugin/doc/sphereFeature.rst index cba9309eb..12e418a4d 100644 --- a/src/PrimitivesPlugin/doc/sphereFeature.rst +++ b/src/PrimitivesPlugin/doc/sphereFeature.rst @@ -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: diff --git a/src/PrimitivesPlugin/doc/torusFeature.rst b/src/PrimitivesPlugin/doc/torusFeature.rst index 2678da430..b739527d2 100644 --- a/src/PrimitivesPlugin/doc/torusFeature.rst +++ b/src/PrimitivesPlugin/doc/torusFeature.rst @@ -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: