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 .. image:: images/Sphere.png
  16   :align: center
  17
  18 .. centered::
  19    Sphere property panel
  20
  21 Input fields:
  22
  23 - **Point** defines the center of the sphere selected in 3D OCC  viewer or object browser;
  24 - **Radius** defines the radius.
  25
  26 **TUI Command**:
  27
  28 .. py:function:: model.addSphere(Part_doc, Point, Radius)
  29
  30     :param part: The current part object.
  31     :param object: Vertex.
  32     :param real: Radius.
  33     :return: Result object.
  34
  35 Result
  36 """"""
  37
  38 An example is shown below.
  39
  40 .. image:: images/Sphere_res.png
  41            :align: center
  42
  43 .. centered::
  44    Sphere created
  45
  46 **See Also** a sample TUI Script of :ref:`tui_create_sphere` operation.