Salome HOME
Corrections for the user's manual from the English language point of view
[modules/shaper.git] / src / ConstructionPlugin / doc / pointFeature.rst
index 64f21b1673f60c4da77846432d451395d41db088..e2bc9d1ef43beb03c82dcf99c9af813f0019f5d7 100644 (file)
@@ -1,3 +1,185 @@
+.. _constructionPoint:
 
 Point
 =====
+
+Point feature creates a new construction point.
+
+Point is a construction object and it can be created in a part or in a partset. To create a point:
+
+#. select in the Main Menu *Construction - > Point* item  or
+#. click **Point** button in the toolbar
+
+.. image:: images/point_button.png
+  :align: center
+
+.. centered::
+  **Point** button
+
+There are 5 algorithms for creation of a Point:
+
+.. image:: images/point_by_xyz_32x32.png
+   :align: left
+**By X,Y,Z** creates a point by three coordinates.
+
+.. image:: images/point_by_distance_on_edge_32x32.png
+   :align: left
+**By distance on edge** creates a point on an edge.
+
+.. image:: images/point_by_projection_32x32.png
+   :align: left
+**By projection on edge or plane** creates a point by projecting an existing point on an edge or plane.
+
+.. image:: images/point_by_intersection_32x32.png
+   :align: left
+**By intersection of objects** creates a point by intersection of planes or/ and edges.
+
+.. image:: images/point_by_geometrical_property_32x32.png
+   :align: left
+**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
+       
+.. centered::
+   **By X,Y,Z coordinates**
+
+A point is created by X, Y, and Z coordinates.
+
+**TUI Commands**: *model.addPoint(Part_doc, 50, 50, 50)*
+
+**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 :ref:`tui_create_point_xyz` operation.
+
+By distance on edge
+-------------------
+
+.. image:: images/Point2.png
+   :align: center
+       
+.. centered::
+   **Along an edge**
+
+To create a point, select an edge in a viewer and define a distance along the edge, where point will be defined. This distance can be defined by an absolute value or by a relative one as a ratio to the edge length. The direction of the edge can be reversed by the corresponded check box.
+
+**TUI Commands**: *model.addPoint(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"), 0.5, True, False)*
+
+**Arguments**: Part + edge + value + is by ratio flag + to reverse flag.
+
+Result
+""""""
+
+The Result of the operation will be a construction point created on edge:
+
+.. image:: images/CreatePoint2.png
+          :align: center
+
+.. centered::
+   **Point created on edge**
+
+**See Also** a sample TUI Script of :ref:`tui_create_point_edge` operation.
+
+By projection on edge or plane
+------------------------------
+
+.. image:: images/Point3.png
+   :align: center
+       
+.. centered::
+   **By projection**
+
+To create a point, select an existing point or vertex and an edge or face. The new point will be created by projection of the selected point on the edge or face.
+
+**TUI Commands**: *model.addPoint(Part_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"))*
+
+**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 :ref:`tui_create_point_projection` operation.
+
+By intersection of objects
+--------------------------
+
+.. image:: images/Point4.png
+   :align: center
+       
+.. centered::
+   **Intersection of objects**
+
+To create a point, select:
+
+#. two edges,
+#. edge and plane,
+#. three planes
+
+The new point will be defined by intersection of the selected objects.
+
+**TUI Commands**: *model.addPoint(Part_doc, model.selection("EDGE", "Box_1_1/Front&Box_1_1/Top"), model.selection("FACE", "Box_1_1/Left"), 10, False)*
+
+**Arguments**: Part + edge + plane (planar face) + offset value + is offset 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 :ref:`tui_create_point_intersection` operation.
+
+By geometrical property of object
+---------------------------------
+
+.. image:: images/Point5.png
+   :align: center
+       
+.. centered::
+   **By geometrical property**
+
+In this case the new point can be defined as a center of gravity of the selected object or as a center of a circle. To create a point, select the desirable object.
+
+**TUI Commands**:  *model.addPoint(Part_1_doc, model.selection("SOLID", "Box_1_1"))*
+
+**Arguments**: Part + solid
+
+Result
+""""""
+
+The Result of the operation will be a construction point defined by object property:
+
+.. image:: images/CreatePoint5.png
+          :align: center
+
+.. centered::
+   **Point created in COG of a cylinder**
+
+**See Also** a sample TUI Script of :ref:`tui_create_point_object` operation.