doc/tui_create_zone.rst

   1 .. _tui_create_zone:
   2
   3 La zone
   4 =======
   5
   6 .. index:: single: zone
   7 .. index:: single: boite
   8 .. index:: single: sphere
   9
  10 Les variables sont décrites dans :ref:`gui_create_zone`.
  11
  12 Méthodes de la classe homard
  13 """"""""""""""""""""""""""""
  14
  15 +---------------------------------------------------------------+
  16 +===============================================================+
  17 | .. module:: CreateZone                                        |
  18 |                                                               |
  19 | **CreateZone(zone_name, zone_type)**                          |
  20 |                                                               |
  21 |     - ``zone_name`` : le nom de la zone                       |
  22 |     - ``zone_type`` : entier précisant le type de zone        |
  23 |                                                               |
  24 |         * 2 : parallélépipède                                 |
  25 |         * 4 : sphère                                          |
  26 +---------------------------------------------------------------+
  27
  28 Méthodes de la classe zone
  29 """"""""""""""""""""""""""
  30
  31 +---------------------------------------------------------------+
  32 +===============================================================+
  33 | .. module:: GetName                                           |
  34 |                                                               |
  35 | **GetName()**                                                 |
  36 |     Retourne le nom de la zone                                |
  37 +---------------------------------------------------------------+
  38 | .. module:: GetZoneType                                       |
  39 |                                                               |
  40 | **GetZoneType()**                                             |
  41 |     Retourne le type de la zone                               |
  42 +---------------------------------------------------------------+
  43 | .. module:: SetBox                                            |
  44 |                                                               |
  45 | **SetBox(Xmin, Xmax, Ymin, Ymax, Zmin, Zmax)**                |
  46 |                                                               |
  47 |     - ``Xmin``, ``Xmax`` : X mini, X maxi                     |
  48 |     - etc.                                                    |
  49 +---------------------------------------------------------------+
  50 | .. module:: SetSphere                                         |
  51 |                                                               |
  52 | **SetSphere(Xcen, Ycen, Zcen, R)**                            |
  53 |                                                               |
  54 |     - ``Xcen`` : X du centre                                  |
  55 |     - ``Ycen`` : Y du centre                                  |
  56 |     - ``Zcen`` : Z du centre                                  |
  57 |     - ``R`` : rayon de la sphère                              |
  58 +---------------------------------------------------------------+
  59
  60
  61 Exemple
  62 """""""
  63 La création de l'objet zone_1 se fait ainsi : ::
  64
  65     zone_1 = homard.CreateZone("Zone_2", 4)
  66     zone_1.SetSphere(12.3, 3.4, .56, 6.5)
  67
  68