.. _tui_create_zone:

La zone
=======

.. index:: single: zone
.. index:: single: boite
.. index:: single: sphere

Les variables sont dcrites dans :ref:`gui_create_zone`.

Mthodes de la classe homard
""""""""""""""""""""""""""""

+---------------------------------------------------------------+
+===============================================================+
| .. module:: CreateZone                                        |
|                                                               |
| **CreateZone(zone_name, zone_type)**                          |
|                                                               |
|     - ``zone_name`` : le nom de la zone                       |
|     - ``zone_type`` : entier prcisant le type de zone        |
|                                                               |
|         * 2 : paralllpipde                                 |
|         * 4 : sphre                                          |
+---------------------------------------------------------------+

Mthodes de la classe zone
""""""""""""""""""""""""""

+---------------------------------------------------------------+
+===============================================================+
| .. module:: GetName                                           |
|                                                               |
| **GetName()**                                                 |
|     Retourne le nom de la zone                                |
+---------------------------------------------------------------+
| .. module:: GetZoneType                                       |
|                                                               |
| **GetZoneType()**                                             |
|     Retourne le type de la zone                               |
+---------------------------------------------------------------+
| .. module:: SetBox                                            |
|                                                               |
| **SetBox(Xmin, Xmax, Ymin, Ymax, Zmin, Zmax)**                |
|                                                               |
|     - ``Xmin``, ``Xmax`` : X mini, X maxi                     |
|     - etc.                                                    |
+---------------------------------------------------------------+
| .. module:: SetSphere                                         |
|                                                               |
| **SetSphere(Xcen, Ycen, Zcen, R)**                            |
|                                                               |
|     - ``Xcen`` : X du centre                                  |
|     - ``Ycen`` : Y du centre                                  |
|     - ``Zcen`` : Z du centre                                  |
|     - ``R`` : rayon de la sphre                              |
+---------------------------------------------------------------+


Exemple
"""""""
La cration de l'objet zone_1 se fait ainsi : ::

    zone_1 = homard.CreateZone("Zone_2", 4)
    zone_1.SetSphere(12.3, 3.4, .56, 6.5)


