trigger.utils.shape_transfer.protocols
======================================

.. py:module:: trigger.utils.shape_transfer.protocols


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/trigger/utils/shape_transfer/protocols/delta/index
   /autoapi/trigger/utils/shape_transfer/protocols/proximity/index
   /autoapi/trigger/utils/shape_transfer/protocols/shapeTest/index
   /autoapi/trigger/utils/shape_transfer/protocols/uvdelta/index
   /autoapi/trigger/utils/shape_transfer/protocols/wrap/index


Attributes
----------

.. autoapisummary::

   trigger.utils.shape_transfer.protocols.classes
   trigger.utils.shape_transfer.protocols.exceptions
   trigger.utils.shape_transfer.protocols.file_name
   trigger.utils.shape_transfer.protocols.modules


Classes
-------

.. autoapisummary::

   trigger.utils.shape_transfer.protocols.ProtocolCore


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

.. py:class:: ProtocolCore

   Bases: :py:obj:`dict`


   Base class for protocols.


   .. py:method:: create_cluster()

      Create a cluster to be used for offsetting the target mesh.



   .. py:method:: create_protocol_group()

      Create the protocol group if it doesn't exist.



   .. py:method:: destroy()

      Destroy the protocol.



   .. py:method:: get_blend_attributes()

      Return the available blend attributes.



   .. py:method:: is_same_topology(source, target)
      :staticmethod:


      checks if the source and target shares the same topology



   .. py:method:: prepare()

      Prepare temporary meshes for the protocol.



   .. py:method:: qc_blendshapes(separation=1, force=False)

      Animate the blendshapes for preview.



   .. py:method:: refresh()

      Refresh the node state of the blendshape node.
      This is to fix the weird bug in blendshape node where it sometimes fails to update.



   .. py:method:: ui_refresh()

      Reinitialize the exposed (UI) properties.



   .. py:attribute:: display_name
      :value: ''



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



   .. py:attribute:: type
      :value: None



.. py:data:: classes
   :value: []


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


.. py:data:: file_name

.. py:data:: modules