trigger.core.module
===================

.. py:module:: trigger.core.module

.. autoapi-nested-parse::

   Core Class for all trigger modules.



Attributes
----------

.. autoapisummary::

   trigger.core.module.LIMB_DATA
   trigger.core.module.LOG


Classes
-------

.. autoapisummary::

   trigger.core.module.GuidesCore
   trigger.core.module.ModuleCore


Module 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:data:: LIMB_DATA

.. py:data:: LOG