src/ConstructionPlugin/doc/pointFeature.rst

   1
   2 Point
   3 =====
   4
   5 The feature Point creates a new constructive point.
   6
   7 Point is a construction object and it can be created as in a part as in part set. To create a point:
   8
   9 #. select in the Main Menu *Construction - > Point* item  or
  10 #. click **Point** button in the toolbar
  11
  12 .. image:: images/point_button.png
  13   :align: center
  14
  15 .. centered::
  16   **Point** button
  17
  18 There are 5 algorithms for creation of a Point:
  19
  20 .. image:: images/point_by_xyz_32x32.png
  21    :align: left
  22 **By X,Y,Z** creates a point by three coordinates.
  23
  24 .. image:: images/point_by_distance_on_edge_32x32.png
  25    :align: left
  26 **By distance on edge** creates a point on an edge.
  27
  28 .. image:: images/point_by_projection_32x32.png
  29    :align: left
  30 **By projection on edge or plane** creates a point projecting of existing point on an edge or plane.
  31
  32 .. image:: images/point_by_intersection_32x32.png
  33    :align: left
  34 **By intersection of objects** creates a point by intersection of planes or/ and edges.
  35
  36 .. image:: images/point_by_geometrical_property_32x32.png
  37    :align: left
  38 **By geometrical property of object** creates a point in COG or center of arc or circle.
  39
  40 By X,Y,Z
  41 """"""""
  42
  43 .. image:: images/Point1.png
  44    :align: center
  45
  46 .. centered::
  47    **By X,Y,Z coordinates**
  48
  49 In this case user has to input X, Y, and Z coordinates.
  50
  51 **TUI Commands**: *model.addPoint(Part_doc, 50, 50, 50)*
  52
  53 **Arguments**: Part + 3 values (X, Y, Z coordinates).
  54
  55 By distance on edge
  56 """""""""""""""""""
  57
  58 .. image:: images/Point2.png
  59    :align: center
  60
  61 .. centered::
  62    **Along an edge**
  63
  64 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.
  65
  66 **TUI Commands**: *model.addPoint(Part_doc, model.selection("EDGE", "Box_1_1/Left&Box_1_1/Top"), 0.5, True, False)*
  67
  68 **Arguments**: Part + edge + value + is by ratio flag + to reverce flag.
  69
  70 By projection on edge or plane
  71 """"""""""""""""""""""""""""""
  72
  73 .. image:: images/Point3.png
  74    :align: center
  75
  76 .. centered::
  77    **By projection**
  78
  79 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.
  80
  81 **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"))*
  82
  83 **Arguments**: Part + vertex + edge (or plane).
  84
  85 By intersection of objects
  86 """"""""""""""""""""""""""
  87
  88 .. image:: images/Point4.png
  89    :align: center
  90
  91 .. centered::
  92    **Intersection of objects**
  93
  94 In this case user has to select:
  95
  96 #. two edges,
  97 #. edge and plane,
  98 #. three planes
  99
 100 The new point will be defined by intersection of selected objects.
 101
 102 **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)*
 103
 104 **Arguments**: Part + edge + plane (planar face) + offset value + is offcet reversed.
 105
 106 By geometrical property of object
 107 """""""""""""""""""""""""""""""""
 108
 109 .. image:: images/Point5.png
 110    :align: center
 111
 112 .. centered::
 113    **By geometrical property**
 114
 115 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.
 116
 117 **TUI Commands**:  *model.addPoint(Part_1_doc, model.selection("SOLID", "Box_1_1"))*
 118
 119 **Arguments**: Part + solid
 120
 121 Result
 122 """"""
 123
 124 The Result of the operation will be a construction point:
 125
 126 .. image:: images/CreatePoint.png
 127            :align: center
 128
 129 .. centered::
 130    Point created
 131
 132 **See Also** a sample TUI Script of a :ref:`tui_create_point` operation.