trigger.tools.face_mocap.main
=============================

.. py:module:: trigger.tools.face_mocap.main

.. autoapi-nested-parse::

   Mapper module to import the csv and json files (livelink and audio2face)

   from importlib import reload
   from trigger.tools.face_mocap import decode
   reload(decode)
   from trigger.tools.face_mocap import a2f
   reload(a2f)
   from trigger.tools.face_mocap import main as focap
   reload(focap)

   handler = focap.FaceMocap()

   # test_path = "D:/PROJECT_AND_ARGE/Elf_Facial_Collaboration/_TRANSFER/LiveLinkFace_20240531_MySlate_4_iPhone/20240531_MySlate_4/"
   test_path = "D:/PROJECT_AND_ARGE/Elf_Facial_Collaboration/_TRANSFER/LiveLinkFace_20240531_MySlate_3_iPhone/20240531_MySlate_3"
   handler.import_livelinkface_package(test_path)



Attributes
----------

.. autoapisummary::

   trigger.tools.face_mocap.main.LOG


Classes
-------

.. autoapisummary::

   trigger.tools.face_mocap.main.FaceMocap


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

.. py:class:: FaceMocap

   Mocap handler for importing motion capture data from json and csv files.


   .. py:method:: import_audio2face_data(json_file, set_fps=True, set_ranges=True)

      Import the audio2face data.

      Args:
          json_file (str): Path to the json file.



   .. py:method:: import_livelinkface_data(csv_file, fps=60, set_fps=True, set_ranges=True)

      Import the LiveLinkFace data.

      Args:
          csv_file (str): Path to the csv file.



   .. py:method:: import_livelinkface_package(livelinkface_folder, import_livelink=True, import_a2f=True, use_calibrated=True, bake_a2f=False, bake_livelink=False)

      Bring the full package.



   .. py:method:: list_mappings()

      List the available mappings.



   .. py:method:: set_a2f_mocap_layer(mocap_layer)

      Set the a2f mocap layer.



   .. py:method:: set_bake_on_controllers(value)

      Set the bake on controllers flag.

      Args:
          value (bool): If True, the mocap data is getting applied
              directly to the controllers. Otherwise, it will be added to
              the morph hook values with a separate controller.



   .. py:method:: set_controller(controller)

      Set the controller.



   .. py:method:: set_enable_neutralize(value)

      Set the enable neutralize flag.



   .. py:method:: set_livelink_mocap_layer(mocap_layer)

      Set the livelink mocap layer.



   .. py:method:: set_mapping(mapping_name)

      Set the mapping from the list of available mappings.

      Args:
          mapping_name (str): Name of the mapping.




   .. py:method:: set_neutralize_frame(neutralize_frame)

      Set the neutralize frame.



   .. py:method:: set_ranges(range_list)
      :staticmethod:


      Set the timeline ranges.
      Args:
          range_list: list of ranges as [<animation start>, <user min>, <user max>,
                                          <animation end>]

      Returns: None



   .. py:method:: set_scene_fps(fps_value)
      :staticmethod:


      Set the FPS value in DCC if supported.
      Args:
          fps_value: (integer) fps value

      Returns: None




   .. py:method:: set_start_frame(start_frame)

      Set the start frame.



   .. py:method:: validations(file_path)

      Run some validations before starting and return the result.



   .. py:property:: a2f_mocap_layer
      Get the a2f mocap layer.



   .. py:property:: bake_on_controllers
      Get the bake on controllers flag.



   .. py:property:: controller
      Get the controller.



   .. py:property:: enable_neutralize
      Get the enable neutralize flag.



   .. py:property:: livelink_mocap_layer
      Get the livelink mocap layer.



   .. py:property:: lower_face_mappings
      Return the mappings data depending on the controller type.



   .. py:property:: mapping
      Get the mapping.



   .. py:property:: neutralize_frame
      Get the neutralize frame.



   .. py:property:: start_frame
      Get the start frame.



   .. py:property:: upper_face_mappings
      Return the mappings data depending on the controller type.



.. py:data:: LOG