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 or a part of 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 There are 2 algorithms for creation of a Sphere
  14
  15 .. figure:: images/sphere_32x32.png
  16    :align: left
  17    :height: 24px
  18
  19 **By a center and a radius**
  20
  21 .. figure:: images/sphere_part_32x32.png
  22    :align: left
  23    :height: 24px
  24
  25 **By radii (inner and outer) and angle limits (theta and phi)**
  26
  27 --------------------------------------------------------------------------------
  28
  29 By a center and a radius
  30 ------------------------
  31
  32 Sphere is created by a center (origin by default) and a radius.
  33
  34 .. figure:: images/Sphere_full.png
  35    :align: center
  36
  37 Input fields:
  38
  39 - **Point** defines the center of the sphere selected in 3D OCC  viewer or object browser;
  40 - **Radius** defines the radius.
  41
  42 **TUI Command**:
  43
  44 .. py:function:: model.addSphere(Part_doc, Point, Radius)
  45
  46     :param part: The current part object.
  47     :param object: Vertex.
  48     :param real: Radius.
  49     :return: Result object.
  50
  51 Result
  52 """"""
  53
  54 A solid sphere based on the origin and a radius.
  55
  56 .. figure:: images/Sphere1.png
  57    :align: center
  58
  59 **See Also** a sample TUI Script of a :ref:`tui_create_sphere` operation.
  60
  61 By radii (inner and outer) and angle limits (theta and phi)
  62 -----------------------------------------------------------
  63
  64 Part of sphere is created by radii (inner and outer) and angle limits (phi and theta).
  65
  66 .. figure:: images/Sphere_part.png
  67    :align: center
  68
  69 Input fields:
  70
  71 - **RMin** defines the inner radius;
  72 - **RMax** defines the outer radius;
  73 - **PhiMin** defines the lower phi limit;
  74 - **PhiMax** defines the higher phi limit;
  75 - **ThetaMin** defines the lower theta limit;
  76 - **ThetaMax** defines the higher theta limit.
  77
  78 **TUI Command**:
  79
  80 .. py:function:: model.addSphere(Part_doc, RMin, RMax, PhiMin, PhiMax, ThetaMin, ThetaMax)
  81
  82     :param part: The current part object.
  83     :param real: Inner radius.
  84     :param real: Outer radius.
  85     :param real: Lower phi.
  86     :param real: Hiher phi.
  87     :param real: Lower theta.
  88     :param real: Hiher theta.
  89     :return: Result object.
  90
  91 Result
  92 """"""
  93
  94 A solid sphere based on the origin with radii (inner and outer) and angles (phi and theta).
  95
  96 .. figure:: images/Sphere2.png
  97    :align: center
  98
  99 **See Also** a sample TUI Script of a :ref:`tui_create_part_sphere` operation.
 100
 101
 102