src/GDMLPlugin/doc/ellipsoidFeature.rst

   1
   2 Ellipsoid
   3 =========
   4
   5 Ellipsoid feature creates a 3d ellipsoid or its part using GDML language.
   6
   7 To create an Ellipsoid in the active part:
   8
   9 #. select in the Main Menu *GDML - > Ellipsoid* item  or
  10 #. click **Ellipsoid** button in the toolbar.
  11
  12 .. figure:: images/ellips_btn.png
  13    :align: center
  14
  15    **Ellipsoid**  button
  16
  17 The following property panel will be opened:
  18
  19 .. figure:: images/Ellipsoid.png
  20    :align: center
  21
  22    **Ellipsoid property panel**
  23
  24 The property panel contains an image, which explains the meaning of input values:
  25
  26 - **ax** - ellipsoid size along X axis.
  27 - **by** - ellipsoid size along Y axis.
  28 - **cz** - ellipsoid size along Z axis.
  29 - **zcut1** - z-coordinate of a lower cut plane.
  30 - **zcut2** - z-coordinate of an upper cut plane.
  31
  32 **TUI Command**:  *model.addEllipsoid(Part_doc, ax, by, cz)*
  33
  34 **Arguments**:    Part + ax + by + cz.
  35
  36 Result
  37 """"""
  38
  39 The Result of the operation will be a SOLID.
  40
  41 .. figure:: images/CreatedEllipsoid.png
  42            :align: center
  43
  44    Ellipsoid created
  45
  46 **See Also** a sample TUI Script of :ref:`tui_create_ellipsoid` operation.