``animation_examples``
=======================================================

.. py:module:: optimeed.visualize.onclick.animation_examples


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

Classes
~~~~~~~

.. autoapisummary::

   optimeed.visualize.onclick.animation_examples.Animate_openGL
   optimeed.visualize.onclick.animation_examples.Animate_openGL_and_text
   optimeed.visualize.onclick.animation_examples.Animate_lines
   optimeed.visualize.onclick.animation_examples.Animate_lines_and_text




.. py:class:: Animate_openGL(theOpenGLWidget, theId=0, window_title='Animation')


   Bases: :py:obj:`optimeed.visualize.onclick.animationGUI.AnimationGUI`

   Implements :class:`~DataAnimationVisuals` to show opengl drawing

   .. py:method:: update_widget_w_animation(key, index, the_data_animation)

      What to do when a new element has to be animated. Example: self.theOpenGLWidget.set_deviceToDraw(the_data_animation.get_element_animations(0, index))

      :param key: key of the trace that has to be animated
      :param index: index that has to be animated
      :param the_data_animation: :class:`~DataAnimationTrace` that has to be animated


   .. py:method:: export_widget(painter)

      Render scene with a painter

      :param painter: PyQt painter


   .. py:method:: delete_key_widgets(key)

      What to do when a key has to be deleted

      :param key: key of the trace that has to be deleted



.. py:class:: Animate_openGL_and_text(*args, is_light=True, **kwargs)


   Bases: :py:obj:`Animate_openGL`

   Implements :class:`~DataAnimationVisuals` to show opengl drawing and text

   .. py:method:: update_widget_w_animation(key, index, the_data_animation)

      What to do when a new element has to be animated. Example: self.theOpenGLWidget.set_deviceToDraw(the_data_animation.get_element_animations(0, index))

      :param key: key of the trace that has to be animated
      :param index: index that has to be animated
      :param the_data_animation: :class:`~DataAnimationTrace` that has to be animated


   .. py:method:: get_interesting_elements(devices_list)

      Function called upon new trace creation. From a list, takes the interesting elements for animation
      :param element_list:
      :return: new_element_list



.. py:class:: Animate_lines(get_lines_method, is_light=True, theId=0, window_title='Animation')


   Bases: :py:obj:`optimeed.visualize.onclick.animationGUI.AnimationGUI`

   Implements :class:`~DataAnimationVisuals` to show drawing made out of lines (:class:`~optimeed.visualize.gui.widgets.widget_line_drawer`)

   .. py:method:: export_widget(painter)

      Render scene with a painter

      :param painter: PyQt painter


   .. py:method:: delete_key_widgets(key)

      What to do when a key has to be deleted

      :param key: key of the trace that has to be deleted


   .. py:method:: update_widget_w_animation(key, index, the_data_animation)

      What to do when a new element has to be animated. Example: self.theOpenGLWidget.set_deviceToDraw(the_data_animation.get_element_animations(0, index))

      :param key: key of the trace that has to be animated
      :param index: index that has to be animated
      :param the_data_animation: :class:`~DataAnimationTrace` that has to be animated


   .. py:method:: get_interesting_elements(devices_list)

      Function called upon new trace creation. From a list, takes the interesting elements for animation
      :param element_list:
      :return: new_element_list



.. py:class:: Animate_lines_and_text(*args, **kwargs)


   Bases: :py:obj:`Animate_lines`

   Same as :class:`~DataAnimationLines` but also with text

   .. py:method:: update_widget_w_animation(key, index, the_data_animation)

      What to do when a new element has to be animated. Example: self.theOpenGLWidget.set_deviceToDraw(the_data_animation.get_element_animations(0, index))

      :param key: key of the trace that has to be animated
      :param index: index that has to be animated
      :param the_data_animation: :class:`~DataAnimationTrace` that has to be animated