From: vsv Date: Thu, 27 Sep 2018 14:13:40 +0000 (+0300) Subject: Modification of Construction plugin documentation X-Git-Tag: CEA_2018-2~63 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=d057f4312ee4eaf4946c697d010e7e742c26795a;p=modules%2Fshaper.git Modification of Construction plugin documentation --- diff --git a/src/ConstructionPlugin/doc/TUI_axis1Feature.rst b/src/ConstructionPlugin/doc/TUI_axis1Feature.rst new file mode 100644 index 000000000..18235b37f --- /dev/null +++ b/src/ConstructionPlugin/doc/TUI_axis1Feature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_axis_xyz: + +Create Axis by dimensions +========================= + +.. literalinclude:: examples/axis1.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/ConstructionPlugin/doc/TUI_axis2Feature.rst b/src/ConstructionPlugin/doc/TUI_axis2Feature.rst new file mode 100644 index 000000000..ecb2d2717 --- /dev/null +++ b/src/ConstructionPlugin/doc/TUI_axis2Feature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_axis_points: + +Create Axis by points +===================== + +.. literalinclude:: examples/axis2.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/ConstructionPlugin/doc/TUI_axis3Feature.rst b/src/ConstructionPlugin/doc/TUI_axis3Feature.rst new file mode 100644 index 000000000..1b6cb10d6 --- /dev/null +++ b/src/ConstructionPlugin/doc/TUI_axis3Feature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_axis_line: + +Create Axis by line +=================== + +.. literalinclude:: examples/axis3.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/ConstructionPlugin/doc/TUI_axis4Feature.rst b/src/ConstructionPlugin/doc/TUI_axis4Feature.rst new file mode 100644 index 000000000..7f5fa8c7e --- /dev/null +++ b/src/ConstructionPlugin/doc/TUI_axis4Feature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_axis_cylinder: + +Create Axis by cylinder +======================= + +.. literalinclude:: examples/axis4.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/ConstructionPlugin/doc/TUI_axis5Feature.rst b/src/ConstructionPlugin/doc/TUI_axis5Feature.rst new file mode 100644 index 000000000..669508f16 --- /dev/null +++ b/src/ConstructionPlugin/doc/TUI_axis5Feature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_axis_plane: + +Create Axis by plane and point +============================== + +.. literalinclude:: examples/axis5.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/ConstructionPlugin/doc/TUI_axis6Feature.rst b/src/ConstructionPlugin/doc/TUI_axis6Feature.rst new file mode 100644 index 000000000..fe41dedfa --- /dev/null +++ b/src/ConstructionPlugin/doc/TUI_axis6Feature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_axis_twoplanes: + +Create Axis by two planes +========================= + +.. literalinclude:: examples/axis6.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/ConstructionPlugin/doc/TUI_plane1Feature.rst b/src/ConstructionPlugin/doc/TUI_plane1Feature.rst new file mode 100644 index 000000000..7c9e358b7 --- /dev/null +++ b/src/ConstructionPlugin/doc/TUI_plane1Feature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_plane_points: + +Create Plane by points +====================== + +.. literalinclude:: examples/plane1.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/ConstructionPlugin/doc/TUI_plane2Feature.rst b/src/ConstructionPlugin/doc/TUI_plane2Feature.rst new file mode 100644 index 000000000..aca97ad70 --- /dev/null +++ b/src/ConstructionPlugin/doc/TUI_plane2Feature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_plane_line: + +Create Plane by line and point +============================== + +.. literalinclude:: examples/plane2.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/ConstructionPlugin/doc/TUI_plane3Feature.rst b/src/ConstructionPlugin/doc/TUI_plane3Feature.rst new file mode 100644 index 000000000..a8b0a56d2 --- /dev/null +++ b/src/ConstructionPlugin/doc/TUI_plane3Feature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_plane_plane: + +Create Plane by other plane +=========================== + +.. literalinclude:: examples/plane3.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/ConstructionPlugin/doc/TUI_plane4Feature.rst b/src/ConstructionPlugin/doc/TUI_plane4Feature.rst new file mode 100644 index 000000000..eed5e7dff --- /dev/null +++ b/src/ConstructionPlugin/doc/TUI_plane4Feature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_plane_parallel: + +Create Plane by two parallel planes +=================================== + +.. literalinclude:: examples/plane4.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/ConstructionPlugin/doc/TUI_planeFeature.rst b/src/ConstructionPlugin/doc/TUI_planeFeature.rst deleted file mode 100644 index e3e8684ab..000000000 --- a/src/ConstructionPlugin/doc/TUI_planeFeature.rst +++ /dev/null @@ -1,12 +0,0 @@ - - .. _tui_create_plane: - -Create Plane -============ - -.. literalinclude:: examples/plane.py - :linenos: - :language: python - -:download:`Download this script ` - diff --git a/src/ConstructionPlugin/doc/TUI_point1Feature.rst b/src/ConstructionPlugin/doc/TUI_point1Feature.rst new file mode 100644 index 000000000..9ab252625 --- /dev/null +++ b/src/ConstructionPlugin/doc/TUI_point1Feature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_point_xyz: + +Create Point by X,Y,Z +===================== + +.. literalinclude:: examples/point1.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/ConstructionPlugin/doc/TUI_point2Feature.rst b/src/ConstructionPlugin/doc/TUI_point2Feature.rst new file mode 100644 index 000000000..7468c3380 --- /dev/null +++ b/src/ConstructionPlugin/doc/TUI_point2Feature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_point_edge: + +Create Point on an edge +======================= + +.. literalinclude:: examples/point2.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/ConstructionPlugin/doc/TUI_point3Feature.rst b/src/ConstructionPlugin/doc/TUI_point3Feature.rst new file mode 100644 index 000000000..975cca552 --- /dev/null +++ b/src/ConstructionPlugin/doc/TUI_point3Feature.rst @@ -0,0 +1,11 @@ + + .. _tui_create_point_projection: + +Create Point by projection +========================== + +.. literalinclude:: examples/point3.py + :linenos: + :language: python + +:download:`Download this script ` diff --git a/src/ConstructionPlugin/doc/TUI_point4Feature.rst b/src/ConstructionPlugin/doc/TUI_point4Feature.rst new file mode 100644 index 000000000..e4a408b11 --- /dev/null +++ b/src/ConstructionPlugin/doc/TUI_point4Feature.rst @@ -0,0 +1,11 @@ + + .. _tui_create_point_intersection: + +Create Point by intersection +============================ + +.. literalinclude:: examples/point4.py + :linenos: + :language: python + +:download:`Download this script ` diff --git a/src/ConstructionPlugin/doc/TUI_point5Feature.rst b/src/ConstructionPlugin/doc/TUI_point5Feature.rst new file mode 100644 index 000000000..82fa596a7 --- /dev/null +++ b/src/ConstructionPlugin/doc/TUI_point5Feature.rst @@ -0,0 +1,11 @@ + + .. _tui_create_point_object: + +Create Point by object property +=============================== + +.. literalinclude:: examples/point5.py + :linenos: + :language: python + +:download:`Download this script ` diff --git a/src/ConstructionPlugin/doc/TUI_pointFeature.rst b/src/ConstructionPlugin/doc/TUI_pointFeature.rst deleted file mode 100644 index 4aec38749..000000000 --- a/src/ConstructionPlugin/doc/TUI_pointFeature.rst +++ /dev/null @@ -1,12 +0,0 @@ - - .. _tui_create_point: - -Create Point -============ - -.. literalinclude:: examples/point.py - :linenos: - :language: python - -:download:`Download this script ` - diff --git a/src/ConstructionPlugin/doc/axisFeature.rst b/src/ConstructionPlugin/doc/axisFeature.rst index 5be237cb9..bcca69e08 100644 --- a/src/ConstructionPlugin/doc/axisFeature.rst +++ b/src/ConstructionPlugin/doc/axisFeature.rst @@ -42,7 +42,7 @@ There are 6 algorithms for creation of an Axis: **By two planes** creates an axis as intersection of two planes. By three dimensions -""""""""""""""""""" +------------------- .. image:: images/Axis1.png :align: center @@ -56,8 +56,22 @@ In this case user has to define dX, dY, dZ values of a vector. **Arguments**: Part + 3 values (dX, dY, dZ values). +Result +"""""" + +The Result of the operation will be an axis defined by vector from origin: + +.. image:: images/CreatedAxis1.png + :align: center + +.. centered:: + **Axis by three dimensions** + +**See Also** a sample TUI Script of a :ref:`tui_create_axis_xyz` operation. + + By two points -""""""""""""" +------------- .. image:: images/Axis2.png :align: center @@ -71,8 +85,24 @@ In this case user has to select two points or vertices. **Arguments**: Part + 2 vertices. +**See Also** a sample TUI Script of a :ref:`tui_create_axis_points` operation. + +Result +"""""" + +The Result of the operation will be an axis based on two points: + +.. image:: images/CreatedAxis2.png + :align: center + +.. centered:: + **Axis by two points** + +**See Also** a sample TUI Script of a :ref:`tui_create_axis_points` operation. + + By line -""""""" +------- .. image:: images/Axis3.png :align: center @@ -86,8 +116,22 @@ In this case user has to select a linear edge. **Arguments**: Part + edge. +Result +"""""" + +The Result of the operation will be an axis based on selected line: + +.. image:: images/CreatedAxis3.png + :align: center + +.. centered:: + **Axis by line** + +**See Also** a sample TUI Script of a :ref:`tui_create_axis_line` operation. + + As an axis of cilindrical face -"""""""""""""""""""""""""""""" +------------------------------ .. image:: images/Axis4.png :align: center @@ -101,8 +145,22 @@ In this case user has to select a cylindrical face. Axis of the cylinder will de **Arguments**: Part + cylindrical face. +Result +"""""" + +The Result of the operation will be an axis by selected cylinder: + +.. image:: images/CreatedAxis4.png + :align: center + +.. centered:: + **Axis cylindrical face** + +**See Also** a sample TUI Script of a :ref:`tui_create_axis_cylinder` operation. + + By plane and point -"""""""""""""""""" +------------------ .. image:: images/Axis5.png :align: center @@ -116,8 +174,22 @@ In this case user has to select a point or vertex and plane (or planar face). Ax **Arguments**: Part + plane + point. +Result +"""""" + +The Result of the operation will be an axis: + +.. image:: images/CreatedAxis5.png + :align: center + +.. centered:: + **Axis by plane and point** + +**See Also** a sample TUI Script of a :ref:`tui_create_axis_plane` operation. + + By two planes -""""""""""""" +------------- .. image:: images/Axis6.png :align: center @@ -136,10 +208,10 @@ Result The Result of the operation will be an axis: -.. image:: images/CreatedAxis.png +.. image:: images/CreatedAxis6.png :align: center .. centered:: - Axis created + **Axis by two planes** -**See Also** a sample TUI Script of a :ref:`tui_create_axis` operation. +**See Also** a sample TUI Script of a :ref:`tui_create_axis_twoplanes` operation. diff --git a/src/ConstructionPlugin/doc/examples/axis.py b/src/ConstructionPlugin/doc/examples/axis.py deleted file mode 100644 index 7072fc265..000000000 --- a/src/ConstructionPlugin/doc/examples/axis.py +++ /dev/null @@ -1,18 +0,0 @@ -# -*- coding: utf-8 -*- - -from salome.shaper import model - -model.begin() -partSet = model.moduleDocument() -Part_1 = model.addPart(partSet) -Part_1_doc = Part_1.document() -Box_1 = model.addBox(Part_1_doc, 10, 10, 10) -Axis_4 = model.addAxis(Part_1_doc, 10, 10, 10) -Axis_5 = model.addAxis(Part_1_doc, model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Left&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Bottom")) -Axis_6 = model.addAxis(Part_1_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top")) -Cylinder_1 = model.addCylinder(Part_1_doc, model.selection("VERTEX", "PartSet/Origin"), model.selection("EDGE", "PartSet/OZ"), 5, 10) -Axis_7 = model.addAxis(Part_1_doc, model.selection("FACE", "Cylinder_1_1/Face_1")) -Axis_8 = model.addAxis(Part_1_doc, model.selection("FACE", "Box_1_1/Front"), model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Right&Box_1_1/Top")) -Axis_9 = model.addAxis(Part_1_doc, model.selection("FACE", "Box_1_1/Top"), 5, False, model.selection("FACE", "Box_1_1/Front"), 3, False) -model.do() -model.end() diff --git a/src/ConstructionPlugin/doc/examples/axis1.py b/src/ConstructionPlugin/doc/examples/axis1.py new file mode 100644 index 000000000..6e40ffc4c --- /dev/null +++ b/src/ConstructionPlugin/doc/examples/axis1.py @@ -0,0 +1,11 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Axis_4 = model.addAxis(Part_1_doc, 10, 10, 10) +model.do() +model.end() diff --git a/src/ConstructionPlugin/doc/examples/axis2.py b/src/ConstructionPlugin/doc/examples/axis2.py new file mode 100644 index 000000000..c832faa3e --- /dev/null +++ b/src/ConstructionPlugin/doc/examples/axis2.py @@ -0,0 +1,13 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Point_2 = model.addPoint(Part_1_doc, 10, 0, 0) +Point_3 = model.addPoint(Part_1_doc, 0, 10, 10) +Axis_4 = model.addAxis(Part_1_doc, model.selection("VERTEX", "Point_1"), model.selection("VERTEX", "Point_2")) +model.do() +model.end() diff --git a/src/ConstructionPlugin/doc/examples/axis3.py b/src/ConstructionPlugin/doc/examples/axis3.py new file mode 100644 index 000000000..8f48a1ee3 --- /dev/null +++ b/src/ConstructionPlugin/doc/examples/axis3.py @@ -0,0 +1,11 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Axis_4 = model.addAxis(Part_1_doc, model.selection("EDGE", "PartSet/OY")) +model.do() +model.end() diff --git a/src/ConstructionPlugin/doc/examples/axis4.py b/src/ConstructionPlugin/doc/examples/axis4.py new file mode 100644 index 000000000..748edc312 --- /dev/null +++ b/src/ConstructionPlugin/doc/examples/axis4.py @@ -0,0 +1,12 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Cylinder_1 = model.addCylinder(Part_1_doc, model.selection("VERTEX", "PartSet/Origin"), model.selection("EDGE", "PartSet/OZ"), 5, 10) +Axis_4 = model.addAxis(Part_1_doc, model.selection("FACE", "Cylinder_1_1/Face_1")) +model.do() +model.end() diff --git a/src/ConstructionPlugin/doc/examples/axis5.py b/src/ConstructionPlugin/doc/examples/axis5.py new file mode 100644 index 000000000..46101d939 --- /dev/null +++ b/src/ConstructionPlugin/doc/examples/axis5.py @@ -0,0 +1,11 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Axis_4 = model.addAxis(Part_1_doc, model.selection("FACE", "PartSet/XOY"), model.selection("VERTEX", "PartSet/Origin")) +model.do() +model.end() diff --git a/src/ConstructionPlugin/doc/examples/axis6.py b/src/ConstructionPlugin/doc/examples/axis6.py new file mode 100644 index 000000000..792bfdfe1 --- /dev/null +++ b/src/ConstructionPlugin/doc/examples/axis6.py @@ -0,0 +1,12 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Box_1 = model.addBox(Part_1_doc, 10, 10, 10) +Axis_4 = model.addAxis(Part_1_doc, model.selection("FACE", "Box_1_1/Top"), model.selection("FACE", "Box_1_1/Left")) +model.do() +model.end() diff --git a/src/ConstructionPlugin/doc/examples/plane.py b/src/ConstructionPlugin/doc/examples/plane.py deleted file mode 100644 index 31580ae1f..000000000 --- a/src/ConstructionPlugin/doc/examples/plane.py +++ /dev/null @@ -1,20 +0,0 @@ -# -*- coding: utf-8 -*- - -from salome.shaper import model - -model.begin() -partSet = model.moduleDocument() -Part_1 = model.addPart(partSet) -Part_1_doc = Part_1.document() -Box_1 = model.addBox(Part_1_doc, 10, 10, 10) -Plane_4 = model.addPlane(Part_1_doc, - model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Left&Box_1_1/Top"), - model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Top"), - model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Left&Box_1_1/Bottom")) -Plane_5 = model.addPlane(Part_1_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"), - model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Bottom"), False) -Plane_6 = model.addPlane(Part_1_doc, model.selection("FACE", "Box_1_1/Front"), 10, False) -Plane_7 = model.addPlane(Part_1_doc, model.selection("FACE", "Box_1_1/Left"), - model.selection("FACE", "Box_1_1/Right")) -model.do() -model.end() diff --git a/src/ConstructionPlugin/doc/examples/plane1.py b/src/ConstructionPlugin/doc/examples/plane1.py new file mode 100644 index 000000000..576189911 --- /dev/null +++ b/src/ConstructionPlugin/doc/examples/plane1.py @@ -0,0 +1,12 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Box_1 = model.addBox(Part_1_doc, 10, 10, 10) +Plane_4 = model.addPlane(Part_1_doc, model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Left&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Left&Box_1_1/Bottom")) +model.do() +model.end() diff --git a/src/ConstructionPlugin/doc/examples/plane2.py b/src/ConstructionPlugin/doc/examples/plane2.py new file mode 100644 index 000000000..fe351d87e --- /dev/null +++ b/src/ConstructionPlugin/doc/examples/plane2.py @@ -0,0 +1,12 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Box_1 = model.addBox(Part_1_doc, 10, 10, 10) +Plane_4 = model.addPlane(Part_1_doc, model.selection("EDGE", "Box_1_1/Front&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Right&Box_1_1/Top"), False) +model.do() +model.end() diff --git a/src/ConstructionPlugin/doc/examples/plane3.py b/src/ConstructionPlugin/doc/examples/plane3.py new file mode 100644 index 000000000..1a0b838c3 --- /dev/null +++ b/src/ConstructionPlugin/doc/examples/plane3.py @@ -0,0 +1,12 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Box_1 = model.addBox(Part_1_doc, 10, 10, 10) +Plane_4 = model.addPlane(Part_1_doc, model.selection("FACE", "Box_1_1/Top"), 10, False) +model.do() +model.end() diff --git a/src/ConstructionPlugin/doc/examples/plane4.py b/src/ConstructionPlugin/doc/examples/plane4.py new file mode 100644 index 000000000..ef7284fe3 --- /dev/null +++ b/src/ConstructionPlugin/doc/examples/plane4.py @@ -0,0 +1,12 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Box_1 = model.addBox(Part_1_doc, 10, 10, 10) +Plane_4 = model.addPlane(Part_1_doc, model.selection("FACE", "Box_1_1/Top"), model.selection("FACE", "Box_1_1/Bottom")) +model.do() +model.end() diff --git a/src/ConstructionPlugin/doc/examples/point.py b/src/ConstructionPlugin/doc/examples/point.py deleted file mode 100644 index 51465bd3f..000000000 --- a/src/ConstructionPlugin/doc/examples/point.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- - -from salome.shaper import model - -model.begin() -partSet = model.moduleDocument() -Part_1 = model.addPart(partSet) -Part_1_doc = Part_1.document() -Box_1 = model.addBox(Part_1_doc, 10, 10, 10) -Point_2 = model.addPoint(Part_1_doc, 50, 50, 50) -Point_3 = model.addPoint(Part_1_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"), 0.5, True, False) -Point_4 = model.addPoint(Part_1_doc, model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Left&Box_1_1/Top"), model.selection("EDGE", "Box_1_1/Right&Box_1_1/Top")) -Point_5 = model.addPoint(Part_1_doc, model.selection("EDGE", "Box_1_1/Front&Box_1_1/Top"), model.selection("FACE", "Box_1_1/Left"), 10, False) -Point_6 = model.addPoint(Part_1_doc, model.selection("SOLID", "Box_1_1")) -model.do() -model.end() diff --git a/src/ConstructionPlugin/doc/examples/point1.py b/src/ConstructionPlugin/doc/examples/point1.py new file mode 100644 index 000000000..04c03c421 --- /dev/null +++ b/src/ConstructionPlugin/doc/examples/point1.py @@ -0,0 +1,11 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Point_2 = model.addPoint(Part_1_doc, 5, 5, 5) +model.do() +model.end() diff --git a/src/ConstructionPlugin/doc/examples/point2.py b/src/ConstructionPlugin/doc/examples/point2.py new file mode 100644 index 000000000..41fa8768c --- /dev/null +++ b/src/ConstructionPlugin/doc/examples/point2.py @@ -0,0 +1,12 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Box_1 = model.addBox(Part_1_doc, 10, 10, 10) +Point_2 = model.addPoint(Part_1_doc, model.selection("EDGE", "Box_1_1/Front&Box_1_1/Left"), 0.4, True, False) +model.do() +model.end() diff --git a/src/ConstructionPlugin/doc/examples/point3.py b/src/ConstructionPlugin/doc/examples/point3.py new file mode 100644 index 000000000..759c569d7 --- /dev/null +++ b/src/ConstructionPlugin/doc/examples/point3.py @@ -0,0 +1,12 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Point_2 = model.addPoint(Part_1_doc, 10, 10, 10) +Point_3 = model.addPoint(Part_1_doc, model.selection("VERTEX", "Point_1"), model.selection("FACE", "PartSet/XOY")) +model.do() +model.end() diff --git a/src/ConstructionPlugin/doc/examples/point4.py b/src/ConstructionPlugin/doc/examples/point4.py new file mode 100644 index 000000000..0d2819227 --- /dev/null +++ b/src/ConstructionPlugin/doc/examples/point4.py @@ -0,0 +1,14 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Box_1 = model.addBox(Part_1_doc, 10, 10, 10) +Axis_4 = model.addAxis(Part_1_doc, model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Left&Box_1_1/Bottom"), model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Right&Box_1_1/Top")) +Axis_5 = model.addAxis(Part_1_doc, model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Left&Box_1_1/Bottom"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Top")) +Point_2 = model.addPoint(Part_1_doc, model.selection("EDGE", "Axis_1"), model.selection("EDGE", "Axis_2")) +model.do() +model.end() diff --git a/src/ConstructionPlugin/doc/examples/point5.py b/src/ConstructionPlugin/doc/examples/point5.py new file mode 100644 index 000000000..eaa588499 --- /dev/null +++ b/src/ConstructionPlugin/doc/examples/point5.py @@ -0,0 +1,12 @@ +# -*- coding: utf-8 -*- + +from salome.shaper import model + +model.begin() +partSet = model.moduleDocument() +Part_1 = model.addPart(partSet) +Part_1_doc = Part_1.document() +Cylinder_1 = model.addCylinder(Part_1_doc, model.selection("VERTEX", "PartSet/Origin"), model.selection("EDGE", "PartSet/OZ"), 5, 10) +Point_2 = model.addPoint(Part_1_doc, model.selection("FACE", "Cylinder_1_1/Face_1")) +model.do() +model.end() diff --git a/src/ConstructionPlugin/doc/images/Axis1.png b/src/ConstructionPlugin/doc/images/Axis1.png index b0d5a1a63..112d2cb2c 100644 Binary files a/src/ConstructionPlugin/doc/images/Axis1.png and b/src/ConstructionPlugin/doc/images/Axis1.png differ diff --git a/src/ConstructionPlugin/doc/images/Axis2.png b/src/ConstructionPlugin/doc/images/Axis2.png index f9f534363..81296c5c7 100644 Binary files a/src/ConstructionPlugin/doc/images/Axis2.png and b/src/ConstructionPlugin/doc/images/Axis2.png differ diff --git a/src/ConstructionPlugin/doc/images/Axis3.png b/src/ConstructionPlugin/doc/images/Axis3.png index ca6dd923b..20917c16f 100644 Binary files a/src/ConstructionPlugin/doc/images/Axis3.png and b/src/ConstructionPlugin/doc/images/Axis3.png differ diff --git a/src/ConstructionPlugin/doc/images/Axis4.png b/src/ConstructionPlugin/doc/images/Axis4.png index 10cf6c4b7..03f5ba617 100644 Binary files a/src/ConstructionPlugin/doc/images/Axis4.png and b/src/ConstructionPlugin/doc/images/Axis4.png differ diff --git a/src/ConstructionPlugin/doc/images/Axis5.png b/src/ConstructionPlugin/doc/images/Axis5.png index 46cab458e..36fd9452c 100644 Binary files a/src/ConstructionPlugin/doc/images/Axis5.png and b/src/ConstructionPlugin/doc/images/Axis5.png differ diff --git a/src/ConstructionPlugin/doc/images/Axis6.png b/src/ConstructionPlugin/doc/images/Axis6.png index 8d6baa5e4..02b57ea57 100644 Binary files a/src/ConstructionPlugin/doc/images/Axis6.png and b/src/ConstructionPlugin/doc/images/Axis6.png differ diff --git a/src/ConstructionPlugin/doc/images/CreatePoint.png b/src/ConstructionPlugin/doc/images/CreatePoint.png deleted file mode 100644 index a6822c85d..000000000 Binary files a/src/ConstructionPlugin/doc/images/CreatePoint.png and /dev/null differ diff --git a/src/ConstructionPlugin/doc/images/CreatePoint1.png b/src/ConstructionPlugin/doc/images/CreatePoint1.png new file mode 100644 index 000000000..7f2a05e33 Binary files /dev/null and b/src/ConstructionPlugin/doc/images/CreatePoint1.png differ diff --git a/src/ConstructionPlugin/doc/images/CreatePoint2.png b/src/ConstructionPlugin/doc/images/CreatePoint2.png new file mode 100644 index 000000000..7d4795c3b Binary files /dev/null and b/src/ConstructionPlugin/doc/images/CreatePoint2.png differ diff --git a/src/ConstructionPlugin/doc/images/CreatePoint3.png b/src/ConstructionPlugin/doc/images/CreatePoint3.png new file mode 100644 index 000000000..0e478c938 Binary files /dev/null and b/src/ConstructionPlugin/doc/images/CreatePoint3.png differ diff --git a/src/ConstructionPlugin/doc/images/CreatePoint4.png b/src/ConstructionPlugin/doc/images/CreatePoint4.png new file mode 100644 index 000000000..134cb450f Binary files /dev/null and b/src/ConstructionPlugin/doc/images/CreatePoint4.png differ diff --git a/src/ConstructionPlugin/doc/images/CreatePoint5.png b/src/ConstructionPlugin/doc/images/CreatePoint5.png new file mode 100644 index 000000000..0f99200f9 Binary files /dev/null and b/src/ConstructionPlugin/doc/images/CreatePoint5.png differ diff --git a/src/ConstructionPlugin/doc/images/CreatedAxis.png b/src/ConstructionPlugin/doc/images/CreatedAxis.png deleted file mode 100644 index ba2fc88d1..000000000 Binary files a/src/ConstructionPlugin/doc/images/CreatedAxis.png and /dev/null differ diff --git a/src/ConstructionPlugin/doc/images/CreatedAxis1.png b/src/ConstructionPlugin/doc/images/CreatedAxis1.png new file mode 100644 index 000000000..c426ea792 Binary files /dev/null and b/src/ConstructionPlugin/doc/images/CreatedAxis1.png differ diff --git a/src/ConstructionPlugin/doc/images/CreatedAxis2.png b/src/ConstructionPlugin/doc/images/CreatedAxis2.png new file mode 100644 index 000000000..02224d180 Binary files /dev/null and b/src/ConstructionPlugin/doc/images/CreatedAxis2.png differ diff --git a/src/ConstructionPlugin/doc/images/CreatedAxis3.png b/src/ConstructionPlugin/doc/images/CreatedAxis3.png new file mode 100644 index 000000000..58d7f24c9 Binary files /dev/null and b/src/ConstructionPlugin/doc/images/CreatedAxis3.png differ diff --git a/src/ConstructionPlugin/doc/images/CreatedAxis4.png b/src/ConstructionPlugin/doc/images/CreatedAxis4.png new file mode 100644 index 000000000..a0fb11b20 Binary files /dev/null and b/src/ConstructionPlugin/doc/images/CreatedAxis4.png differ diff --git a/src/ConstructionPlugin/doc/images/CreatedAxis5.png b/src/ConstructionPlugin/doc/images/CreatedAxis5.png new file mode 100644 index 000000000..923113e57 Binary files /dev/null and b/src/ConstructionPlugin/doc/images/CreatedAxis5.png differ diff --git a/src/ConstructionPlugin/doc/images/CreatedAxis6.png b/src/ConstructionPlugin/doc/images/CreatedAxis6.png new file mode 100644 index 000000000..10e4a0cb4 Binary files /dev/null and b/src/ConstructionPlugin/doc/images/CreatedAxis6.png differ diff --git a/src/ConstructionPlugin/doc/images/CreatedPlane1.png b/src/ConstructionPlugin/doc/images/CreatedPlane1.png new file mode 100644 index 000000000..e5b36d1b0 Binary files /dev/null and b/src/ConstructionPlugin/doc/images/CreatedPlane1.png differ diff --git a/src/ConstructionPlugin/doc/images/CreatedPlane2.png b/src/ConstructionPlugin/doc/images/CreatedPlane2.png new file mode 100644 index 000000000..64aa741d9 Binary files /dev/null and b/src/ConstructionPlugin/doc/images/CreatedPlane2.png differ diff --git a/src/ConstructionPlugin/doc/images/CreatedPlane3.png b/src/ConstructionPlugin/doc/images/CreatedPlane3.png new file mode 100644 index 000000000..46c564f6a Binary files /dev/null and b/src/ConstructionPlugin/doc/images/CreatedPlane3.png differ diff --git a/src/ConstructionPlugin/doc/images/CreatedPlane4.png b/src/ConstructionPlugin/doc/images/CreatedPlane4.png new file mode 100644 index 000000000..d280b7295 Binary files /dev/null and b/src/ConstructionPlugin/doc/images/CreatedPlane4.png differ diff --git a/src/ConstructionPlugin/doc/images/Plane1.png b/src/ConstructionPlugin/doc/images/Plane1.png index 6adfafbaf..9c7be9be5 100644 Binary files a/src/ConstructionPlugin/doc/images/Plane1.png and b/src/ConstructionPlugin/doc/images/Plane1.png differ diff --git a/src/ConstructionPlugin/doc/images/Plane2.png b/src/ConstructionPlugin/doc/images/Plane2.png index 23b4c7eea..9ff1ad95f 100644 Binary files a/src/ConstructionPlugin/doc/images/Plane2.png and b/src/ConstructionPlugin/doc/images/Plane2.png differ diff --git a/src/ConstructionPlugin/doc/images/Plane3.png b/src/ConstructionPlugin/doc/images/Plane3.png index 335139565..be4eddd0d 100644 Binary files a/src/ConstructionPlugin/doc/images/Plane3.png and b/src/ConstructionPlugin/doc/images/Plane3.png differ diff --git a/src/ConstructionPlugin/doc/images/Plane4.png b/src/ConstructionPlugin/doc/images/Plane4.png index 2c53d7a57..9e97daa0f 100644 Binary files a/src/ConstructionPlugin/doc/images/Plane4.png and b/src/ConstructionPlugin/doc/images/Plane4.png differ diff --git a/src/ConstructionPlugin/doc/images/Point1.png b/src/ConstructionPlugin/doc/images/Point1.png index f9172860e..40039e718 100644 Binary files a/src/ConstructionPlugin/doc/images/Point1.png and b/src/ConstructionPlugin/doc/images/Point1.png differ diff --git a/src/ConstructionPlugin/doc/images/Point2.png b/src/ConstructionPlugin/doc/images/Point2.png index e272ee752..217f6db5f 100644 Binary files a/src/ConstructionPlugin/doc/images/Point2.png and b/src/ConstructionPlugin/doc/images/Point2.png differ diff --git a/src/ConstructionPlugin/doc/images/Point3.png b/src/ConstructionPlugin/doc/images/Point3.png index fa9d4c95d..696ea9950 100644 Binary files a/src/ConstructionPlugin/doc/images/Point3.png and b/src/ConstructionPlugin/doc/images/Point3.png differ diff --git a/src/ConstructionPlugin/doc/images/Point4.png b/src/ConstructionPlugin/doc/images/Point4.png index 8072605cf..94d66b589 100644 Binary files a/src/ConstructionPlugin/doc/images/Point4.png and b/src/ConstructionPlugin/doc/images/Point4.png differ diff --git a/src/ConstructionPlugin/doc/images/Point5.png b/src/ConstructionPlugin/doc/images/Point5.png index fe7f84f4c..c65d05880 100644 Binary files a/src/ConstructionPlugin/doc/images/Point5.png and b/src/ConstructionPlugin/doc/images/Point5.png differ diff --git a/src/ConstructionPlugin/doc/planeFeature.rst b/src/ConstructionPlugin/doc/planeFeature.rst index eead2aeba..c1b54009a 100644 --- a/src/ConstructionPlugin/doc/planeFeature.rst +++ b/src/ConstructionPlugin/doc/planeFeature.rst @@ -4,7 +4,7 @@ Plane The feature Plane creates a new constructive plane. -Plane is a construction object and it can be created as in a part as in part set. To create a plane: +Plane is a construction object and it can be created as in a part as in a part set. To create a plane: #. select in the Main Menu *Construction - > Plane* item or #. click **Point** button in the toolbar @@ -33,8 +33,9 @@ There are 4 algorithms for creation of a Plane: :align: left **By two parallel planes** creates a plane between two parallel planes. + By three points -""""""""""""""" +--------------- .. image:: images/Plane1.png :align: center @@ -48,8 +49,22 @@ In this case user has to select three points in a viewer to define a new plane. **Arguments**: Part + 3 vertices. +Result +"""""" + +The Result of the operation will be a plane: + +.. image:: images/CreatedPlane1.png + :align: center + +.. centered:: + **A plane by three points** + +**See Also** a sample TUI Script of a :ref:`tui_create_plane_points` operation. + + By line and point -""""""""""""""""" +----------------- .. image:: images/Plane2.png :align: center @@ -63,8 +78,22 @@ In this case user has to select a linear edge and point to define a plane. It is **Arguments**: Part + line + point + is perpendicular to line flag. +Result +"""""" + +The Result of the operation will be a plane: + +.. image:: images/CreatedPlane2.png + :align: center + +.. centered:: + Plane created + +**See Also** a sample TUI Script of a :ref:`tui_create_plane_line` operation. + + By other plane -"""""""""""""" +-------------- .. image:: images/Plane3.png :align: center @@ -93,9 +122,22 @@ By rotation around an edge on a specified angle. **Arguments**: Part + a plane + offset + is reverse flag. - +Result +"""""" + +The Result of the operation will be a plane parallel to already existing one: + +.. image:: images/CreatedPlane3.png + :align: center + +.. centered:: + **Plane parallel to a planar face** + +**See Also** a sample TUI Script of a :ref:`tui_create_plane_plane` operation. + + By two parallel planes -"""""""""""""""""""""" +---------------------- .. image:: images/Plane4.png :align: center @@ -112,12 +154,12 @@ In this case user has to select two parallel planes. A new plane will be defined Result """""" -The Result of the operation will be a plane: +The Result of the operation will be a plane created between two selected planes: -.. image:: images/CreatedPlane.png +.. image:: images/CreatedPlane4.png :align: center .. centered:: - Plane created + **Plane created between others** -**See Also** a sample TUI Script of a :ref:`tui_create_plane` operation. +**See Also** a sample TUI Script of a :ref:`tui_create_plane_parallel` operation. diff --git a/src/ConstructionPlugin/doc/pointFeature.rst b/src/ConstructionPlugin/doc/pointFeature.rst index 64b642789..caeff7ca5 100644 --- a/src/ConstructionPlugin/doc/pointFeature.rst +++ b/src/ConstructionPlugin/doc/pointFeature.rst @@ -2,7 +2,7 @@ Point ===== -The feature Point creates a new constructive point. +The feature Point creates a new construction point. Point is a construction object and it can be created as in a part as in part set. To create a point: @@ -38,7 +38,7 @@ There are 5 algorithms for creation of a Point: **By geometrical property of object** creates a point in COG or center of arc or circle. By X,Y,Z -"""""""" +-------- .. image:: images/Point1.png :align: center @@ -52,8 +52,21 @@ In this case user has to input X, Y, and Z coordinates. **Arguments**: Part + 3 values (X, Y, Z coordinates). +Result +"""""" + +The Result of the operation will be a construction point: + +.. image:: images/CreatePoint1.png + :align: center + +.. centered:: + **Point by coordinates** + +**See Also** a sample TUI Script of a :ref:`tui_create_point_xyz` operation. + By distance on edge -""""""""""""""""""" +------------------- .. image:: images/Point2.png :align: center @@ -67,8 +80,21 @@ In this case user has to select an edge in a viewer and to define a distance alo **Arguments**: Part + edge + value + is by ratio flag + to reverce flag. +Result +"""""" + +The Result of the operation will be a construction point create on edge: + +.. image:: images/CreatePoint2.png + :align: center + +.. centered:: + **Point created on edge** + +**See Also** a sample TUI Script of a :ref:`tui_create_point_edge` operation. + By projection on edge or plane -"""""""""""""""""""""""""""""" +------------------------------ .. image:: images/Point3.png :align: center @@ -82,8 +108,21 @@ In this case user has to select an existing point or vertex and an edge or face. **Arguments**: Part + vertex + edge (or plane). +Result +"""""" + +The Result of the operation will be a construction point created by projection on a plane or an edge: + +.. image:: images/CreatePoint3.png + :align: center + +.. centered:: + **Point created by projection on a plane** + +**See Also** a sample TUI Script of a :ref:`tui_create_point_projection` operation. + By intersection of objects -"""""""""""""""""""""""""" +-------------------------- .. image:: images/Point4.png :align: center @@ -103,8 +142,21 @@ The new point will be defined by intersection of selected objects. **Arguments**: Part + edge + plane (planar face) + offset value + is offcet reversed. +Result +"""""" + +The Result of the operation will be a construction point created by intersection of objects: + +.. image:: images/CreatePoint4.png + :align: center + +.. centered:: + **Point created by intersection of axis** + +**See Also** a sample TUI Script of a :ref:`tui_create_point_intersection` operation. + By geometrical property of object -""""""""""""""""""""""""""""""""" +--------------------------------- .. image:: images/Point5.png :align: center @@ -121,12 +173,12 @@ In this case the new point can be defined as a center of gravity of selected obj Result """""" -The Result of the operation will be a construction point: +The Result of the operation will be a construction point defined by object property: -.. image:: images/CreatePoint.png +.. image:: images/CreatePoint5.png :align: center .. centered:: - Point created + **Point created in COG of a cylinder** -**See Also** a sample TUI Script of a :ref:`tui_create_point` operation. +**See Also** a sample TUI Script of a :ref:`tui_create_point_object` operation.