src.tik
=======

.. py:module:: src.tik

.. autoapi-nested-parse::

   Controller shape library UI widget for TikWorks Maya tools.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/src/tik/tools/index
   /autoapi/src/tik/trigger/index
   /autoapi/src/tik/vendor/index


Attributes
----------

.. autoapisummary::

   src.tik.MOCK_DATA
   src.tik.cs_handler


Classes
-------

.. autoapisummary::

   src.tik.FlatLeafProxyModel
   src.tik.HoverOverlay
   src.tik.ShapeLibraryModel
   src.tik.ShapeLibraryWidget


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

.. py:class:: FlatLeafProxyModel(parent=None)

   Bases: :py:obj:`tik.vendor.Qt.QtCore.QAbstractProxyModel`


   A Proxy Model that recursively finds all leaf nodes (Shapes) in the source
   tree and maps them to a flat list (Row 0..N).
   Categories are ignored.


   .. py:method:: columnCount(parent=QtCore.QModelIndex())


   .. py:method:: index(row, column, parent=QtCore.QModelIndex())


   .. py:method:: mapFromSource(source_index)


   .. py:method:: mapToSource(proxy_index)


   .. py:method:: parent(index)


   .. py:method:: rebuild_mapping()

      Scans the source model and stores pointers to all leaf nodes.



   .. py:method:: rowCount(parent=QtCore.QModelIndex())


   .. py:method:: setSourceModel(source_model)


.. py:class:: HoverOverlay(parent=None)

   Bases: :py:obj:`tik.vendor.Qt.QtWidgets.QWidget`


   Floating thumbnail widget.


   .. py:method:: set_pixmap(pixmap)


   .. py:attribute:: label


.. py:class:: ShapeLibraryModel(data, parent=None)

   Bases: :py:obj:`tik.vendor.Qt.QtGui.QStandardItemModel`


   Standard Item Model organized as a Tree: Root -> Category -> Shape


   .. py:attribute:: RoleCategory


   .. py:attribute:: RolePath


   .. py:attribute:: RoleThumbnail


.. py:class:: ShapeLibraryWidget(shape_data, parent=None)

   Bases: :py:obj:`tik.vendor.Qt.QtWidgets.QWidget`


   Main widget for browsing and selecting controller shapes.


   .. py:method:: apply_style()


   .. py:method:: go_up_level()

      Go up one directory level in Icon Mode.



   .. py:method:: leaveEvent(event)


   .. py:method:: on_icon_double_clicked(index)

      Handle diving into folders in Icon Mode.



   .. py:method:: on_item_entered(index)


   .. py:method:: on_search_changed(text)


   .. py:method:: set_model_mode(flat)

      Swaps the models used by the views based on Flat vs Hierarchical.



   .. py:method:: show_context_menu(pos)


   .. py:attribute:: btn_back


   .. py:attribute:: hover_thumb_enabled
      :value: False



   .. py:attribute:: is_flat_mode
      :value: False



   .. py:attribute:: list_view


   .. py:attribute:: main_layout


   .. py:attribute:: overlay


   .. py:attribute:: proxy_flat_internal


   .. py:attribute:: proxy_flat_search


   .. py:attribute:: proxy_hierarchical


   .. py:attribute:: search_input


   .. py:attribute:: shape_data


   .. py:attribute:: source_model


   .. py:attribute:: stack


   .. py:attribute:: tree_view


.. py:data:: MOCK_DATA

.. py:data:: cs_handler