src/PrimitivesPlugin/doc/sphereFeature.rst

   1 .. |Sphere_button.icon|    image:: images/Sphere_button.png
   2
   3 Sphere
   4 ======
   5
   6 Sphere feature creates a sphere solid.
   7
   8 To create a Sphere in the active part:
   9
  10 #. select in the Main Menu *Primitives - > Sphere* item  or
  11 #. click |Sphere_button.icon| **Sphere** button in the toolbar
  12
  13 The following property panel appears.
  14
  15 .. figure:: images/Sphere.png
  16    :align: center
  17
  18    Sphere property panel
  19
  20 Input fields:
  21
  22 - **Point** defines the center of the sphere selected in 3D OCC  viewer or object browser;
  23 - **Radius** defines the radius.
  24
  25 **TUI Command**:
  26
  27 .. py:function:: model.addSphere(Part_doc, Point, Radius)
  28
  29     :param part: The current part object.
  30     :param object: Vertex.
  31     :param real: Radius.
  32     :return: Result object.
  33
  34 Result
  35 """"""
  36
  37 An example is shown below.
  38
  39 .. figure:: images/Sphere_res.png
  40    :align: center
  41
  42    Sphere created
  43
  44 **See Also** a sample TUI Script of :ref:`tui_create_sphere` operation.