:mod:`woo.qt`
==========================

.. inheritance-diagram:: woo.qt
   :parts: 2

.. automodule:: woo.qt
   :members:
   :undoc-members:
   :exclude-members: SnapshotEngine,  UiPrefs


.. rst-class:: html-toggle


.. rst-class:: emphasized

UiPrefs
-------


:obj:`~woo.core.Object` → :obj:`~woo.qt.UiPrefs`

.. autoclass:: UiPrefs
   :members:
   :exclude-members: glRotCursorFreeze, prepShowVars, paraviewLike3d, defaultCmap, prefsFile, __init__, __getstate__, __setstate__
   :special-members:


   [:woosrc:`gui/qt/__init__.py <gui/qt/__init__.py#L98>`]

   .. attribute:: glRotCursorFreeze (= False)

      Freeze cursor when rotating things (moving with buttons pressed); useful for trackballs; not yet functional.

      [type: bool]

   .. attribute:: prepShowVars (= False)

      Show variable names rather than descriptions by default in the preprocessor interface

      [type: bool]

   .. attribute:: paraviewLike3d (= True)

      Paraview-like mouse bindings for the 3d view (requires restart): middle-drag to move, left-drag to zoom. IF false, use old (Yade) behavior, which is the opposite.

      [type: bool]

   .. attribute:: defaultCmap (= 'coolwarm')

      Default colormap for scales.

      [type: str, choices: coolwarm, 3gauss, 3saw, banded, blue_red, blu_red, bright, bw, default, detail, extrema, helix2, helix, hotres, jaisn2, jaisnb, jaisnc, jaisnd, jaison, jet, manga, rainbow, roullet, ssec, wheel, red-green-blue, viridis]

   .. attribute:: prefsFile (= '/home/eudoxos/.config/woo/uiPrefs.conf')

      Preferences will be loaded/saved from/to this file.

      [type: str, not dumped, read-only in python]

.. autoclass:: SnapshotEngine
   :members:
   :exclude-members: fileBase, format, counter, plot, snapshots, ignoreErrors, msecSleep, deadTimeout, tryOpenView, __init__, __getstate__, __setstate__
   :special-members:

   .. attribute:: fileBase (= '')

      Basename for snapshots

      [type: string]

   .. attribute:: format (= 'PNG')

      Format of snapshots (one of JPEG, PNG, EPS, PS, PPM, BMP) `QGLViewer documentation <http://www.libqglviewer.com/refManual/classQGLViewer.html#abbb1add55632dced395e2f1b78ef491c>`_. File extension will be lowercased :obj:`format`. Validity of format is not checked.

      [type: string, choices: JPEG, PNG, EPS, PS, PPM, BMP]

   .. attribute:: counter (= 0)

      Number that will be appended to fileBase when the next snapshot is saved (incremented at every save).

      [type: int, read-only in python]

   .. attribute:: plot (= '')

      Name of field in :obj:`woo.core.Plot.imgData` to which taken snapshots will be appended automatically.

      [type: string]

   .. rubric:: ► Saved files

   .. attribute:: snapshots (= [])

      Files that have been created so far

      [type: vector<string>, not shown in the UI, read-only in python]

   .. rubric:: ► Error handling

   .. attribute:: ignoreErrors (= True)

      Only report errors instead of throwing exceptions, in case of timeouts.

      [type: bool]

   .. attribute:: msecSleep (= 0)

      number of msec to sleep after snapshot (to prevent 3d hw problems) [ms]

      [type: int]

   .. attribute:: deadTimeout (= 3.0)

      Timeout for 3d operations (opening new view, saving snapshot); after timing out, throw exception (or only report error if :obj:`ignoreErrors`) and make myself :obj:`dead <Engine.dead>`. [s]

      [type: Real]

   .. attribute:: tryOpenView (= False)

      Attempt to open new view if there is none; this is very unreliable (off by default).

      [type: bool]

:mod:`woo._qt`
---------------------------

.. note:: This module is imported into the :obj:`woo.qt` module automatically; refer to its objects through :obj:`woo.qt`.

.. inheritance-diagram:: woo._qt
   :parts: 2

.. automodule:: woo._qt
   :members:
   :undoc-members:
   :exclude-members: SnapshotEngine,  UiPrefs


.. rst-class:: html-toggle


.. rst-class:: emphasized

SnapshotEngine
++++++++++++++


:obj:`~woo.core.Object` → :obj:`~woo.core.Engine` → :obj:`~woo.core.PeriodicEngine` → :obj:`~woo._qt.SnapshotEngine`

:mod:`woo._GLViewer`
---------------------------------

.. note:: This module is imported into the :obj:`woo.qt` module automatically; refer to its objects through :obj:`woo.qt`.

.. automodule:: woo._GLViewer
   :members:
   :undoc-members:
   :exclude-members: SnapshotEngine,  UiPrefs

:mod:`woo.qt.ExceptionDialog`
------------------------------------------

.. automodule:: woo.qt.ExceptionDialog
   :members:
   :undoc-members:
   :exclude-members: SnapshotEngine,  UiPrefs

:mod:`woo.qt.ObjectEditor`
---------------------------------------

.. automodule:: woo.qt.ObjectEditor
   :members:
   :undoc-members:
   :exclude-members: SnapshotEngine,  UiPrefs

:mod:`woo.qt.Inspector`
------------------------------------

.. automodule:: woo.qt.Inspector
   :members:
   :undoc-members:
   :exclude-members: SnapshotEngine,  UiPrefs

:mod:`woo.qt.img_rc`
---------------------------------

.. automodule:: woo.qt.img_rc
   :members:
   :undoc-members:
   :exclude-members: SnapshotEngine,  UiPrefs

:mod:`woo.qt.ui_controller`
----------------------------------------

.. automodule:: woo.qt.ui_controller
   :members:
   :undoc-members:
   :exclude-members: SnapshotEngine,  UiPrefs

:mod:`woo.qt.DisplayProfiles`
------------------------------------------

.. automodule:: woo.qt.DisplayProfiles
   :members:
   :undoc-members:
   :exclude-members: SnapshotEngine,  UiPrefs