.. _constructionPoint:
+.. |point_button.icon| image:: images/point_button.png
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
+#. click |point_button.icon| **Point** button in the toolbar
There are 5 algorithms for creation of a Point:
A point is created by X, Y, and Z coordinates.
-**TUI Commands**: *model.addPoint(Part_doc, 50, 50, 50)*
+**TUI Commands**:
-**Arguments**: Part + 3 values (X, Y, Z coordinates).
+.. py:function:: model.addPoint(Part_doc, 50, 50, 50)
+
+ :param part: The current part object.
+ :param real: X value.
+ :param real: Y value.
+ :param real: Z value.
+ :return: Result object.
Result
""""""
.. 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.
+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 corresponding check-box.
+
+**TUI Commands**:
-**TUI Commands**: *model.addPoint(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"), 0.5, True, False)*
+.. py:function:: 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.
+ :param part: The current part object.
+ :param object: An edge.
+ :param real: A value.
+ :param boolean: Is by ratio.
+ :param boolean: Is reversed.
+ :return: Result object.
Result
""""""
By projection on edge or plane
------------------------------
+To create a point by projection it is necessary to select an existing point or wertex which will be projected and an edge or a plane (planar face) on which it will be projected:
+
+**On an edge:**
+
.. image:: images/Point3.png
:align: center
.. centered::
- **By projection**
+ **By projection on an edge**
-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.
+**On a plane:**
-**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"))*
+.. image:: images/Point3-1.png
+ :align: center
+
+.. centered::
+ **By projection on a plane**
+
+
+The new point will be created by projection of the selected point on the selected object.
+
+**TUI Commands**:
-**Arguments**: Part + vertex + edge (or plane).
+.. py:function:: 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"))
+
+ :param part: The current part object.
+ :param object: A vertex.
+ :param object: An edge or plane.
+ :return: Result object.
Result
""""""
By intersection of objects
--------------------------
+A point can be created by intersection of selected objects:
+
+**Two edges**
+
.. image:: images/Point4.png
:align: center
.. centered::
- **Intersection of objects**
+ **Intersection of edges**
-To create a point, select:
+**Edge and plane**
-#. two edges,
-#. edge and plane,
-#. three planes
+.. image:: images/Point4-1.png
+ :align: center
+
+.. centered::
+ **Intersection of and edge and a plane**
+
+In this case it is possible to define an offset from a plane along the plane normal for the created point.
+
+**Three planes**
+
+.. image:: images/Point4-2.png
+ :align: center
+
+.. centered::
+ **Intersection of 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)*
+**TUI Commands**:
-**Arguments**: Part + edge + plane (planar face) + offset value + is offset reversed.
+.. py:function:: model.addPoint(Part_doc, model.selection("EDGE", "Box_1_1/Front&Box_1_1/Top"), model.selection("FACE", "Box_1_1/Left"), 10, False)
+
+ :param part: The current part object.
+ :param object: An edge.
+ :param object: A plane.
+ :param real: Offset.
+ :param boolean: Is offset reversed.
+ :return: Result object.
Result
""""""
By geometrical property of object
---------------------------------
+It is possible to use the following property of selected object:
+
+**A center of gravity**
+
.. image:: images/Point5.png
:align: center
.. centered::
- **By geometrical property**
+ **By center of gravity**
+
+**A center of circle or arc**
+
+.. image:: images/Point5-1.png
+ :align: center
+
+.. centered::
+ **By center of a circle**
+
+To create a point, select a desirable object.
-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**:
-**TUI Commands**: *model.addPoint(Part_1_doc, model.selection("SOLID", "Box_1_1"))*
+.. py:function:: model.addPoint(Part_1_doc, model.selection("SOLID", "Box_1_1"))
-**Arguments**: Part + solid
+ :param part: The current part object.
+ :param object: Solid.
+ :return: Result object.
Result
""""""
