--- /dev/null
+
+ .. _tui_create_axis_xyz:
+
+Create Axis by dimensions
+=========================
+
+.. literalinclude:: examples/axis1.py
+ :linenos:
+ :language: python
+
+:download:`Download this script <examples/axis1.py>`
+
--- /dev/null
+
+ .. _tui_create_axis_points:
+
+Create Axis by points
+=====================
+
+.. literalinclude:: examples/axis2.py
+ :linenos:
+ :language: python
+
+:download:`Download this script <examples/axis2.py>`
+
--- /dev/null
+
+ .. _tui_create_axis_line:
+
+Create Axis by line
+===================
+
+.. literalinclude:: examples/axis3.py
+ :linenos:
+ :language: python
+
+:download:`Download this script <examples/axis3.py>`
+
--- /dev/null
+
+ .. _tui_create_axis_cylinder:
+
+Create Axis by cylinder
+=======================
+
+.. literalinclude:: examples/axis4.py
+ :linenos:
+ :language: python
+
+:download:`Download this script <examples/axis4.py>`
+
--- /dev/null
+
+ .. _tui_create_axis_plane:
+
+Create Axis by plane and point
+==============================
+
+.. literalinclude:: examples/axis5.py
+ :linenos:
+ :language: python
+
+:download:`Download this script <examples/axis5.py>`
+
--- /dev/null
+
+ .. _tui_create_axis_twoplanes:
+
+Create Axis by two planes
+=========================
+
+.. literalinclude:: examples/axis6.py
+ :linenos:
+ :language: python
+
+:download:`Download this script <examples/axis6.py>`
+
--- /dev/null
+
+ .. _tui_create_plane_points:
+
+Create Plane by points
+======================
+
+.. literalinclude:: examples/plane1.py
+ :linenos:
+ :language: python
+
+:download:`Download this script <examples/plane1.py>`
+
--- /dev/null
+
+ .. _tui_create_plane_line:
+
+Create Plane by line and point
+==============================
+
+.. literalinclude:: examples/plane2.py
+ :linenos:
+ :language: python
+
+:download:`Download this script <examples/plane2.py>`
+
--- /dev/null
+
+ .. _tui_create_plane_plane:
+
+Create Plane by other plane
+===========================
+
+.. literalinclude:: examples/plane3.py
+ :linenos:
+ :language: python
+
+:download:`Download this script <examples/plane3.py>`
+
--- /dev/null
+
+ .. _tui_create_plane_parallel:
+
+Create Plane by two parallel planes
+===================================
+
+.. literalinclude:: examples/plane4.py
+ :linenos:
+ :language: python
+
+:download:`Download this script <examples/plane4.py>`
+
+++ /dev/null
-
- .. _tui_create_plane:
-
-Create Plane
-============
-
-.. literalinclude:: examples/plane.py
- :linenos:
- :language: python
-
-:download:`Download this script <examples/plane.py>`
-
--- /dev/null
+
+ .. _tui_create_point_xyz:
+
+Create Point by X,Y,Z
+=====================
+
+.. literalinclude:: examples/point1.py
+ :linenos:
+ :language: python
+
+:download:`Download this script <examples/point1.py>`
+
--- /dev/null
+
+ .. _tui_create_point_edge:
+
+Create Point on an edge
+=======================
+
+.. literalinclude:: examples/point2.py
+ :linenos:
+ :language: python
+
+:download:`Download this script <examples/point2.py>`
+
--- /dev/null
+
+ .. _tui_create_point_projection:
+
+Create Point by projection
+==========================
+
+.. literalinclude:: examples/point3.py
+ :linenos:
+ :language: python
+
+:download:`Download this script <examples/point3.py>`
--- /dev/null
+
+ .. _tui_create_point_intersection:
+
+Create Point by intersection
+============================
+
+.. literalinclude:: examples/point4.py
+ :linenos:
+ :language: python
+
+:download:`Download this script <examples/point4.py>`
--- /dev/null
+
+ .. _tui_create_point_object:
+
+Create Point by object property
+===============================
+
+.. literalinclude:: examples/point5.py
+ :linenos:
+ :language: python
+
+:download:`Download this script <examples/point5.py>`
+++ /dev/null
-
- .. _tui_create_point:
-
-Create Point
-============
-
-.. literalinclude:: examples/point.py
- :linenos:
- :language: python
-
-:download:`Download this script <examples/point.py>`
-
**By two planes** creates an axis as intersection of two planes.
By three dimensions
-"""""""""""""""""""
+-------------------
.. image:: images/Axis1.png
:align: center
**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
**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
**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
**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
**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
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.
+++ /dev/null
-# -*- 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()
--- /dev/null
+# -*- 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()
--- /dev/null
+# -*- 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()
--- /dev/null
+# -*- 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()
--- /dev/null
+# -*- 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()
--- /dev/null
+# -*- 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()
--- /dev/null
+# -*- 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()
+++ /dev/null
-# -*- 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()
--- /dev/null
+# -*- 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()
--- /dev/null
+# -*- 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()
--- /dev/null
+# -*- 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()
--- /dev/null
+# -*- 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()
+++ /dev/null
-# -*- 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()
--- /dev/null
+# -*- 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()
--- /dev/null
+# -*- 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()
--- /dev/null
+# -*- 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()
--- /dev/null
+# -*- 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()
--- /dev/null
+# -*- 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()
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
:align: left
**By two parallel planes** creates a plane between two parallel planes.
+
By three points
-"""""""""""""""
+---------------
.. image:: images/Plane1.png
:align: center
**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
**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
**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
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.
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:
**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
**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
**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
**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
**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
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.
