Karana.KUtils.MultibodyTUI
==========================

.. py:module:: Karana.KUtils.MultibodyTUI

.. autoapi-nested-parse::

   A TUI used to inspect a Multibody.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /generated/python_api/Karana/KUtils/MultibodyTUI/base/index
   /generated/python_api/Karana/KUtils/MultibodyTUI/constants/index
   /generated/python_api/Karana/KUtils/MultibodyTUI/dialog/index
   /generated/python_api/Karana/KUtils/MultibodyTUI/graph/index
   /generated/python_api/Karana/KUtils/MultibodyTUI/graphics/index
   /generated/python_api/Karana/KUtils/MultibodyTUI/history/index
   /generated/python_api/Karana/KUtils/MultibodyTUI/loopdb/index
   /generated/python_api/Karana/KUtils/MultibodyTUI/mbody/index
   /generated/python_api/Karana/KUtils/MultibodyTUI/mode/index
   /generated/python_api/Karana/KUtils/MultibodyTUI/notify/index
   /generated/python_api/Karana/KUtils/MultibodyTUI/swing/index
   /generated/python_api/Karana/KUtils/MultibodyTUI/terminal/index
   /generated/python_api/Karana/KUtils/MultibodyTUI/view/index


Classes
-------

.. autoapisummary::

   Karana.KUtils.MultibodyTUI.MultibodyTUI


Package Contents
----------------

.. py:class:: MultibodyTUI(multibody, *, run: bool = True, highlight: Karana.Scene.Scene_types.MaterialType | Karana.Scene.Color = Color.YELLOW, axes_size: float = 10)

   Bases: :py:obj:`Karana.KUtils.MultibodyTUI.base.TUIBase`


   A terminal user interface (TUI) to examine a multibody.


   .. py:attribute:: multibody


   .. py:attribute:: graph_adapters
      :type:  collections.abc.Mapping[ViewTag, GraphAdapter]


   .. py:attribute:: loopdb


   .. py:attribute:: hist


   .. py:attribute:: notify


   .. py:attribute:: highlighter


   .. py:attribute:: highlighter2


   .. py:attribute:: loop_lines


   .. py:attribute:: frame_lines


   .. py:attribute:: frame_axes


   .. py:attribute:: swing_manager


   .. py:property:: state
      :type: State


      The current state.


   .. py:method:: redraw()

      Redraw the MultibodyTUI view.



   .. py:method:: handleKey(key: str) -> bool

      Handle a single key press from the user.