trigger.utils.shape_transfer.main
=================================

.. py:module:: trigger.utils.shape_transfer.main

.. autoapi-nested-parse::

   Main module for the shape transfer tool.



Attributes
----------

.. autoapisummary::

   trigger.utils.shape_transfer.main.LOG


Classes
-------

.. autoapisummary::

   trigger.utils.shape_transfer.main.ShapeTransfer


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

.. py:class:: ShapeTransfer

   Bases: :py:obj:`object`


   Shape Transfer Main Class.


   .. py:method:: get_offset_x()

      Get the offset x value.



   .. py:method:: get_offset_y()

      Get the offset y value.



   .. py:method:: get_offset_z()

      Get the offset z value.



   .. py:method:: preview_mode(turn_on=True)

      Make the preparations for the preview the transfer.



   .. py:method:: set_active_protocol(protocol)

      Set the protocol.



   .. py:method:: set_active_protocol_by_name(protocol_name)

      Set the active protocol.



   .. py:method:: set_offset_x(value)

      Set the offset x value.



   .. py:method:: set_offset_y(value)

      Set the offset y value.



   .. py:method:: set_offset_z(value)

      Set the offset z value.



   .. py:method:: set_source_blendshape_grp(source_blendshape_grp)

      Set the source blendshape group and update the message attribute.



   .. py:method:: set_source_mesh(source_mesh)

      Set the source mesh and update the message attribute.



   .. py:method:: set_target_mesh(target_mesh)

      Set the target mesh and update the message attribute.



   .. py:method:: transfer(q_progressbar=None)

      Bake the QC into a shape pack.



   .. py:method:: validate_variables()

      Validate if the variables are set correctly.
      Return the LOG message if not.



   .. py:property:: all_protocols
      Return all the protocols.



   .. py:property:: shape_protocols
      Return the shape protocols.



   .. py:property:: topology_protocols
      Return the topology protocols.



.. py:data:: LOG