:py:mod:`rtgs.utils.quaternion`
===============================

.. py:module:: rtgs.utils.quaternion

.. autodoc2-docstring:: rtgs.utils.quaternion
   :allowtitles:

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

Functions
~~~~~~~~~

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

   * - :py:obj:`mul <rtgs.utils.quaternion.mul>`
     - .. autodoc2-docstring:: rtgs.utils.quaternion.mul
          :summary:
   * - :py:obj:`conj <rtgs.utils.quaternion.conj>`
     - .. autodoc2-docstring:: rtgs.utils.quaternion.conj
          :summary:
   * - :py:obj:`inv <rtgs.utils.quaternion.inv>`
     - .. autodoc2-docstring:: rtgs.utils.quaternion.inv
          :summary:
   * - :py:obj:`from_axis_angle <rtgs.utils.quaternion.from_axis_angle>`
     - .. autodoc2-docstring:: rtgs.utils.quaternion.from_axis_angle
          :summary:
   * - :py:obj:`as_axis_angle <rtgs.utils.quaternion.as_axis_angle>`
     - .. autodoc2-docstring:: rtgs.utils.quaternion.as_axis_angle
          :summary:
   * - :py:obj:`rot_vec3 <rtgs.utils.quaternion.rot_vec3>`
     - .. autodoc2-docstring:: rtgs.utils.quaternion.rot_vec3
          :summary:
   * - :py:obj:`as_rotation_mat3 <rtgs.utils.quaternion.as_rotation_mat3>`
     - .. autodoc2-docstring:: rtgs.utils.quaternion.as_rotation_mat3
          :summary:
   * - :py:obj:`as_rotation_mat4 <rtgs.utils.quaternion.as_rotation_mat4>`
     - .. autodoc2-docstring:: rtgs.utils.quaternion.as_rotation_mat4
          :summary:

API
~~~

.. py:function:: mul(p, q)
   :canonical: rtgs.utils.quaternion.mul

   .. autodoc2-docstring:: rtgs.utils.quaternion.mul

.. py:function:: conj(q)
   :canonical: rtgs.utils.quaternion.conj

   .. autodoc2-docstring:: rtgs.utils.quaternion.conj

.. py:function:: inv(q)
   :canonical: rtgs.utils.quaternion.inv

   .. autodoc2-docstring:: rtgs.utils.quaternion.inv

.. py:function:: from_axis_angle(v)
   :canonical: rtgs.utils.quaternion.from_axis_angle

   .. autodoc2-docstring:: rtgs.utils.quaternion.from_axis_angle

.. py:function:: as_axis_angle(q)
   :canonical: rtgs.utils.quaternion.as_axis_angle

   .. autodoc2-docstring:: rtgs.utils.quaternion.as_axis_angle

.. py:function:: rot_vec3(q, v)
   :canonical: rtgs.utils.quaternion.rot_vec3

   .. autodoc2-docstring:: rtgs.utils.quaternion.rot_vec3

.. py:function:: as_rotation_mat3(q)
   :canonical: rtgs.utils.quaternion.as_rotation_mat3

   .. autodoc2-docstring:: rtgs.utils.quaternion.as_rotation_mat3

.. py:function:: as_rotation_mat4(q)
   :canonical: rtgs.utils.quaternion.as_rotation_mat4

   .. autodoc2-docstring:: rtgs.utils.quaternion.as_rotation_mat4