.. _constructionPoint:
+.. |point_button.icon| image:: images/point_button.png
Point
=====
-The feature Point creates a new construction point.
+Point feature 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:
+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:
.. image:: images/point_by_projection_32x32.png
:align: left
-**By projection on edge or plane** creates a point projecting of existing point on an edge or plane.
+**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
.. centered::
**By X,Y,Z coordinates**
-In this case user has to input X, Y, and Z coordinates.
+A point is created by X, Y, and Z coordinates.
+
+**TUI Commands**:
-**TUI Commands**: *model.addPoint(Part_doc, 50, 50, 50)*
+.. py:function:: model.addPoint(Part_doc, 50, 50, 50)
-**Arguments**: Part + 3 values (X, Y, Z coordinates).
+ :param part: The current part object.
+ :param real: X value.
+ :param real: Y value.
+ :param real: Z value.
+ :return: Result object.
Result
""""""
.. centered::
**Point by coordinates**
-**See Also** a sample TUI Script of a :ref:`tui_create_point_xyz` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_point_xyz` operation.
By distance on edge
-------------------
.. centered::
**Along an edge**
-In this case user has to select an edge in a viewer and to define a distance along the edge where point will be defined. This distance can be defined as by an absolute value as by relative as a ratio to the edge length. The direction of the edge can be reverced 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 corresponded check box.
-**TUI Commands**: *model.addPoint(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"), 0.5, True, False)*
+**TUI Commands**:
-**Arguments**: Part + edge + value + is by ratio flag + to reverce flag.
+.. py:function:: model.addPoint(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"), 0.5, True, False)
+
+ :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
""""""
-The Result of the operation will be a construction point create on edge:
+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 a :ref:`tui_create_point_edge` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_point_edge` operation.
By projection on edge or plane
------------------------------
.. centered::
**By projection**
-In this case user has to 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.
+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**:
-**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"))*
+.. 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"))
-**Arguments**: Part + vertex + edge (or plane).
+ :param part: The current part object.
+ :param object: A vertex.
+ :param object: An edge or plane.
+ :return: Result object.
Result
""""""
.. centered::
**Point created by projection on a plane**
-**See Also** a sample TUI Script of a :ref:`tui_create_point_projection` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_point_projection` operation.
By intersection of objects
--------------------------
.. centered::
**Intersection of objects**
-In this case user has to select:
+To create a point, select:
#. two edges,
#. edge and plane,
#. three planes
-The new point will be defined by intersection of selected objects.
+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 offcet 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
""""""
.. centered::
**Point created by intersection of axis**
-**See Also** a sample TUI Script of a :ref:`tui_create_point_intersection` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_point_intersection` operation.
By geometrical property of object
---------------------------------
.. centered::
**By geometrical property**
-In this case the new point can be defined as a center of gravity of selected object or as a center of a circle. User has to select 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
""""""
.. centered::
**Point created in COG of a cylinder**
-**See Also** a sample TUI Script of a :ref:`tui_create_point_object` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_point_object` operation.
