:py:mod:`wolfhece.PyConfig`
===========================

.. py:module:: wolfhece.PyConfig

.. autoapi-nested-parse::

   Author: HECE - University of Liege, Pierre Archambeau
   Date: 2024

   Copyright (c) 2024 University of Liege. All rights reserved.

   This script and its content are protected by copyright law. Unauthorized
   copying or distribution of this file, via any medium, is strictly prohibited.



Module Contents
---------------

.. py:class:: ConfigurationKeys


   Bases: :py:obj:`enum.Enum`

   .. autoapi-inheritance-diagram:: wolfhece.PyConfig.ConfigurationKeys
      :parts: 1
      :private-bases:

   Using enumerated keys make sure we
   can check value names at code write time
   (i.e. we don't use string which are brittle)

   .. py:attribute:: VERSION
      :value: 'Version'

      

   .. py:attribute:: PLAY_WELCOME_SOUND
      :value: 'PlayWelcomeSound'

      

   .. py:attribute:: TICKS_SIZE
      :value: 'TicksSize'

      

   .. py:attribute:: TICKS_BOUNDS
      :value: 'TicksBounds'

      

   .. py:attribute:: TICKS_XROTATION
      :value: 'TicksXRotation'

      

   .. py:attribute:: TICKS_FONTSIZE
      :value: 'TicksFontSize'

      

   .. py:attribute:: COLOR_BACKGROUND
      :value: 'ColorBackground'

      

   .. py:attribute:: ACTIVE_ARRAY_PALETTE_FOR_IMAGE
      :value: 'Use active array palette for image'

      

   .. py:attribute:: ACTIVE_RES2D_PALETTE_FOR_IMAGE
      :value: 'Use active result palette for image'

      

   .. py:attribute:: ASSEMBLY_IMAGES
      :value: 'AssemblyImages'

      

   .. py:attribute:: DIRECTORY_DEM
      :value: 'Default DEM directory'

      

   .. py:attribute:: DIRECTORY_DTM
      :value: 'Default DTM directory'

      

   .. py:attribute:: DIRECTORY_LAZ
      :value: 'Default LAZ directory'

      


.. py:class:: WolfConfiguration(path=None)


   Holds the PyWolf configuration

   .. py:property:: path
      :type: pathlib.Path

      Where the configuration is read/saved.

   .. py:method:: set_default_config()


   .. py:method:: _check_config()


   .. py:method:: load()


   .. py:method:: save()



.. py:class:: GlobalOptionsDialog(*args, **kw)


   Bases: :py:obj:`wx.Dialog`

   .. autoapi-inheritance-diagram:: wolfhece.PyConfig.GlobalOptionsDialog
      :parts: 1
      :private-bases:

   A dialog to set global options for a WolfMapViewer.

   .. py:method:: push_configuration(configuration)


   .. py:method:: pull_configuration(configuration)


   .. py:method:: InitUI()


   .. py:method:: OnChooseDem(e)

      Choose a directory for DEM files


   .. py:method:: OnChooseDtm(e)

      Choose a directory for DTM files


   .. py:method:: OnChooseLaz(e)

      Choose a directory for LAZ files


   .. py:method:: OnOk(e)


   .. py:method:: OnClose(e)



.. py:function:: handle_configuration_dialog(wxparent, configuration)


.. py:data:: cfg