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

.. py:module:: vendor_fabric.meshy.rigging

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

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

Functions
~~~~~~~~~

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

   * - :py:obj:`create <vendor_fabric.meshy.rigging.create>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.rigging.create
          :parser: myst
          :summary:
   * - :py:obj:`get <vendor_fabric.meshy.rigging.get>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.rigging.get
          :parser: myst
          :summary:
   * - :py:obj:`poll <vendor_fabric.meshy.rigging.poll>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.rigging.poll
          :parser: myst
          :summary:
   * - :py:obj:`rig <vendor_fabric.meshy.rigging.rig>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.rigging.rig
          :parser: myst
          :summary:
   * - :py:obj:`rig_from_url <vendor_fabric.meshy.rigging.rig_from_url>`
     - .. autodoc2-docstring:: vendor_fabric.meshy.rigging.rig_from_url
          :parser: myst
          :summary:

API
~~~

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

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

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

   .. autodoc2-docstring:: vendor_fabric.meshy.rigging.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.rigging.poll

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

.. py:function:: rig(model_task_id: str, *, height_meters: float = 1.7, wait: bool = True) -> extended_data.containers.ExtendedDict | extended_data.containers.ExtendedString
   :canonical: vendor_fabric.meshy.rigging.rig

   .. autodoc2-docstring:: vendor_fabric.meshy.rigging.rig
      :parser: myst

.. py:function:: rig_from_url(model_url: str, *, height_meters: float = 1.7, texture_url: str | None = None, wait: bool = True) -> extended_data.containers.ExtendedDict | extended_data.containers.ExtendedString
   :canonical: vendor_fabric.meshy.rigging.rig_from_url

   .. autodoc2-docstring:: vendor_fabric.meshy.rigging.rig_from_url
      :parser: myst