pyrcf.components.callback_handlers.tkinter_gui_callbacks
========================================================

.. py:module:: pyrcf.components.callback_handlers.tkinter_gui_callbacks


Classes
-------

.. autoapisummary::

   pyrcf.components.callback_handlers.tkinter_gui_callbacks.TkGUICallback
   pyrcf.components.callback_handlers.tkinter_gui_callbacks.TkGUISliderCallback
   pyrcf.components.callback_handlers.tkinter_gui_callbacks.TkMultiGUISliderSingleCallback
   pyrcf.components.callback_handlers.tkinter_gui_callbacks.TkGUIButtonCallback


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

.. py:class:: TkGUICallback

   Bases: :py:obj:`pyrcf.components.callback_handlers.base_callbacks.CustomCallbackBase`


   Abstraction for all GUICallbacks defined using Tkinter widgets.


.. py:class:: TkGUISliderCallback(slider_name: str, slider_lower_lim: float, slider_upper_lim: float, slider_default_val: float, callback: Callable[[float], None], tk_master: pyrcf.utils.gui_utils.tkinter_gui_utils.TkinterWidgetMaster = None, mapping_function: Callable[[float], float] = lambda x: x, slider_resolution: float = 0.1)

   Bases: :py:obj:`TkGUICallback`


   Create a slider in pybullet and specify the callback to apply the slider value to.


   .. py:attribute:: _slider


   .. py:attribute:: _callback


   .. py:method:: run_once() -> None

      This method has to be called for the callback to be executed.



   .. py:method:: remove_gui_object()


.. py:class:: TkMultiGUISliderSingleCallback(slider_names: List[str], slider_lower_lims: List[float], slider_upper_lims: List[float], slider_default_vals: List[float], callback: Callable[[List[float]], None], tk_master: pyrcf.utils.gui_utils.tkinter_gui_utils.TkinterWidgetMaster = None, mapping_functions: Callable[[float], float] | List[Callable[[float], float]] = lambda x: x, slider_resolutions: List[float] | float = 0.1)

   Bases: :py:obj:`TkGUICallback`


   Create multiple sliders and use values from all the sliders in a single callback.


   .. py:attribute:: _sliders
      :type:  List[pyrcf.utils.gui_utils.tkinter_gui_utils.TkinterGUISlider]
      :value: []



   .. py:attribute:: _callback


   .. py:method:: run_once()

      This method has to be called for the callback to be executed.



   .. py:method:: remove_gui_object()


   .. py:method:: get_sliders() -> List[pyrcf.utils.gui_utils.tkinter_gui_utils.TkinterGUISlider]


.. py:class:: TkGUIButtonCallback(button_name: str, callback: Callable[[], None], tk_master: pyrcf.utils.gui_utils.tkinter_gui_utils.TkinterWidgetMaster = None)

   Bases: :py:obj:`TkGUICallback`


   Create a button in Tk and specify the callback to call when button is pressed.


   .. py:attribute:: _button


   .. py:attribute:: _callback


   .. py:method:: run_once()

      This method has to be called for checking button press and for the
      callback to be executed.



   .. py:method:: remove_gui_object()