:py:mod:`vendor_fabric.meshy.animate`
=====================================

.. py:module:: vendor_fabric.meshy.animate

.. autodoc2-docstring:: vendor_fabric.meshy.animate
   :parser: myst
   :allowtitles:

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

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`create <vendor_fabric.meshy.animate.create>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.animate.create
          :parser: myst
          :summary:
   * - :py:obj:`get <vendor_fabric.meshy.animate.get>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.animate.get
          :parser: myst
          :summary:
   * - :py:obj:`poll <vendor_fabric.meshy.animate.poll>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.animate.poll
          :parser: myst
          :summary:
   * - :py:obj:`apply <vendor_fabric.meshy.animate.apply>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.animate.apply
          :parser: myst
          :summary:

API
~~~

.. py:function:: create(request: vendor_fabric.meshy.models.AnimationRequest) -> extended_data.containers.ExtendedString
   :canonical: vendor_fabric.meshy.animate.create

   .. autodoc2-docstring:: vendor_fabric.meshy.animate.create
      :parser: myst

.. py:function:: get(task_id: str) -> extended_data.containers.ExtendedDict
   :canonical: vendor_fabric.meshy.animate.get

   .. autodoc2-docstring:: vendor_fabric.meshy.animate.get
      :parser: myst

.. py:function:: poll(task_id: str, interval: float = 5.0, timeout: float = 600.0) -> extended_data.containers.ExtendedDict
   :canonical: vendor_fabric.meshy.animate.poll

   .. autodoc2-docstring:: vendor_fabric.meshy.animate.poll
      :parser: myst

.. py:function:: apply(rigged_task_id: str, animation_id: int, *, loop: bool = True, frame_rate: int = 30, wait: bool = True) -> extended_data.containers.ExtendedDict | extended_data.containers.ExtendedString
   :canonical: vendor_fabric.meshy.animate.apply

   .. autodoc2-docstring:: vendor_fabric.meshy.animate.apply
      :parser: myst