trigger.modules
===============

.. py:module:: trigger.modules


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/trigger/modules/arm/index
   /autoapi/trigger/modules/base/index
   /autoapi/trigger/modules/connector/index
   /autoapi/trigger/modules/eye/index
   /autoapi/trigger/modules/finger/index
   /autoapi/trigger/modules/fkik/index
   /autoapi/trigger/modules/head/index
   /autoapi/trigger/modules/hindleg/index
   /autoapi/trigger/modules/leg/index
   /autoapi/trigger/modules/singleton/index
   /autoapi/trigger/modules/spine/index
   /autoapi/trigger/modules/surface/index
   /autoapi/trigger/modules/tail/index
   /autoapi/trigger/modules/tentacle/index


Attributes
----------

.. autoapisummary::

   trigger.modules.class_data
   trigger.modules.exceptions
   trigger.modules.file_name
   trigger.modules.modules


Classes
-------

.. autoapisummary::

   trigger.modules.GuidesCore
   trigger.modules.ModuleCore


Functions
---------

.. autoapisummary::

   trigger.modules.get_module_classes


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

.. py:class:: GuidesCore(side='L', suffix='', segments=None, tMatrix=None, upVector=(0, 1, 0), mirrorVector=(1, 0, 0), lookVector=(0, 0, 1), *args, **kwargs)

   Bases: :py:obj:`object`


   .. py:method:: convertJoints(joints_list)

      Convert regular joints into guide joints.



   .. py:method:: createGuides()

      Create the guides.



   .. py:method:: define_attributes()

      Define the attributes for the module.



   .. py:method:: define_guides()

      Define the guide joints. This method will be overridden for each module.



   .. py:method:: draw_joints()

      Draw the guide joints and set Joint types/sides. This method will be overridden for each module.



   .. py:attribute:: limb_data


   .. py:attribute:: name
      :value: ''



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

   Bases: :py:obj:`object`


   .. py:method:: additional_groups()

      Create additional groups for the module. This method will be overridden for each module.



   .. py:method:: createLimb()

      Create the limb rig.



   .. py:method:: create_groups()

      Create essential groups for the module. Mandatory for all modules.



   .. py:method:: execute()

      Execute the rig creation. This method will be overridden for each module.



   .. py:method:: finalize()

      Finalize the rig creation. This method will be overridden for each module.



   .. py:attribute:: name
      :value: ''



.. py:function:: get_module_classes(module)

.. py:data:: class_data

.. py:data:: exceptions
   :value: ['__init__.py']


.. py:data:: file_name

.. py:data:: modules