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 .. image:: images/ellips_btn.png
  13    :align: center
  14
  15 .. centered::
  16    **Ellipsoid**  button
  17
  18 The following property panel will be opened:
  19
  20 .. image:: images/Ellipsoid.png
  21    :align: center
  22
  23 .. centered::
  24    **Ellipsoid property panel**
  25
  26 The property panel contains an image, which explains the meaning of input values:
  27
  28 - **ax** - ellipsoid size along X axis.
  29 - **by** - ellipsoid size along Y axis.
  30 - **cz** - ellipsoid size along Z axis.
  31 - **zcut1** - z-coordinate of a lower cut plane.
  32 - **zcut2** - z-coordinate of an upper cut plane.
  33
  34 **TUI Command**:  *model.addEllipsoid(Part_doc, ax, by, cz)*
  35
  36 **Arguments**:    Part + ax + by + cz.
  37
  38 Result
  39 """"""
  40
  41 The Result of the operation will be a SOLID.
  42
  43 .. image:: images/CreatedEllipsoid.png
  44            :align: center
  45
  46 .. centered::
  47    Ellipsoid created
  48
  49 **See Also** a sample TUI Script of :ref:`tui_create_ellipsoid` operation.