From: vsv Date: Wed, 15 Aug 2018 15:45:36 +0000 (+0300) Subject: Create Construction plugin help pages X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=95af7a65757afee48adf70778cc5a4c4a9071d18;p=modules%2Fshaper.git Create Construction plugin help pages --- diff --git a/src/GDMLPlugin/doc/TUI_coneFeature.rst b/src/GDMLPlugin/doc/TUI_coneFeature.rst new file mode 100644 index 000000000..d8268fc94 --- /dev/null +++ b/src/GDMLPlugin/doc/TUI_coneFeature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_conesegment: + +Create Cone +=========== + +.. literalinclude:: examples/cone.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/GDMLPlugin/doc/TUI_ellipsoidFeature.rst b/src/GDMLPlugin/doc/TUI_ellipsoidFeature.rst new file mode 100644 index 000000000..54b85d6b0 --- /dev/null +++ b/src/GDMLPlugin/doc/TUI_ellipsoidFeature.rst @@ -0,0 +1,12 @@ + + .. _tui_create_ellipsoid: + +Create Cone +=========== + +.. literalinclude:: examples/ellipsoid.py + :linenos: + :language: python + +:download:`Download this script ` + diff --git a/src/GDMLPlugin/doc/coneFeature.rst b/src/GDMLPlugin/doc/coneFeature.rst index 5041deccf..9760c29b9 100644 --- a/src/GDMLPlugin/doc/coneFeature.rst +++ b/src/GDMLPlugin/doc/coneFeature.rst @@ -1,3 +1,36 @@ Cone ==== + +To create a Cone in the active part: + +#. select in the Main Menu *GDML - > Cone segment* item or +#. click **Cone segment** button in the toolbar. + +.. image:: images/cone_btn.png + :align: center + +.. centered:: + **Cone segment** button + +The following property panel will be opened: + +.. image:: images/Cone_panel.png + :align: center + +.. centered:: + **Cone property panel** + +**TUI Command**: *model.addConeSegment(Part_doc, 7, 11, 5, 8, 12, 0 , 270)* + +**Arguments**: Part + Rmin of base + Rmax of base + Rmin of top + Rmax of top + height + start angle + end angle. + +The Result of the operation will be a SOLID. + +.. image:: images/CreatedCone.png + :align: center + +.. centered:: + Cone created + +**See Also** a sample TUI Script of a :ref:`tui_create_conesegment` operation. diff --git a/src/GDMLPlugin/doc/ellipsoidFeature.rst b/src/GDMLPlugin/doc/ellipsoidFeature.rst index 65ce69e85..a8bd95158 100644 --- a/src/GDMLPlugin/doc/ellipsoidFeature.rst +++ b/src/GDMLPlugin/doc/ellipsoidFeature.rst @@ -1,3 +1,36 @@ Ellipsoid ========= + +To create a Ellipsoid in the active part: + +#. select in the Main Menu *GDML - > Ellipsoid* item or +#. click **Ellipsoid** button in the toolbar. + +.. image:: images/ellips_btn.png + :align: center + +.. centered:: + **Ellipsoid** button + +The following property panel will be opened: + +.. image:: images/Ellipsoid.png + :align: center + +.. centered:: + **Ellipsoid property panel** + +**TUI Command**: *model.addEllipsoid(Part_doc, 10, 20, 40)* + +**Arguments**: Part + ax + by + cz. + +The Result of the operation will be a SOLID. + +.. image:: images/CreatedEllipsoid.png + :align: center + +.. centered:: + Ellipsoid created + +**See Also** a sample TUI Script of a :ref:`tui_create_ellipsoid` operation. diff --git a/src/GDMLPlugin/doc/examples/cone.py b/src/GDMLPlugin/doc/examples/cone.py new file mode 100644 index 000000000..4ad110612 --- /dev/null +++ b/src/GDMLPlugin/doc/examples/cone.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() +ConeSegment_1 = model.addConeSegment(Part_1_doc, 7, 11, 5, 8, 12, 0 , 270) +model.do() +model.end() diff --git a/src/GDMLPlugin/doc/examples/ellipsoid.py b/src/GDMLPlugin/doc/examples/ellipsoid.py new file mode 100644 index 000000000..68ada19a2 --- /dev/null +++ b/src/GDMLPlugin/doc/examples/ellipsoid.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() +Ellipsoid_1 = model.addEllipsoid(Part_1_doc, 10, 20, 40) +model.do() +model.end() diff --git a/src/GDMLPlugin/doc/images/Cone_panel.png b/src/GDMLPlugin/doc/images/Cone_panel.png new file mode 100644 index 000000000..8e5a92bd0 Binary files /dev/null and b/src/GDMLPlugin/doc/images/Cone_panel.png differ diff --git a/src/GDMLPlugin/doc/images/CreatedCone.png b/src/GDMLPlugin/doc/images/CreatedCone.png new file mode 100644 index 000000000..be2bb3a0d Binary files /dev/null and b/src/GDMLPlugin/doc/images/CreatedCone.png differ diff --git a/src/GDMLPlugin/doc/images/CreatedEllipsoid.png b/src/GDMLPlugin/doc/images/CreatedEllipsoid.png new file mode 100644 index 000000000..51340712c Binary files /dev/null and b/src/GDMLPlugin/doc/images/CreatedEllipsoid.png differ diff --git a/src/GDMLPlugin/doc/images/Ellipsoid.png b/src/GDMLPlugin/doc/images/Ellipsoid.png new file mode 100644 index 000000000..c0b5c4f1a Binary files /dev/null and b/src/GDMLPlugin/doc/images/Ellipsoid.png differ diff --git a/src/GDMLPlugin/doc/images/cone_btn.png b/src/GDMLPlugin/doc/images/cone_btn.png new file mode 100644 index 000000000..12378d4ee Binary files /dev/null and b/src/GDMLPlugin/doc/images/cone_btn.png differ diff --git a/src/GDMLPlugin/doc/images/ellips_btn.png b/src/GDMLPlugin/doc/images/ellips_btn.png new file mode 100644 index 000000000..4af212bcd Binary files /dev/null and b/src/GDMLPlugin/doc/images/ellips_btn.png differ