kigadgets.units
===============

.. py:module:: kigadgets.units


Attributes
----------

.. autoapisummary::

   kigadgets.units.CoordinateLike
   kigadgets.units.nm
   kigadgets.units.mm
   kigadgets.units.inch
   kigadgets.units.mil
   kigadgets.units.nm_ius
   kigadgets.units.mm_ius
   kigadgets.units.inch_ius
   kigadgets.units.mil_ius
   kigadgets.units.deg
   kigadgets.units.rad
   kigadgets.units.DEFAULT_UNIT_IUS


Classes
-------

.. autoapisummary::

   kigadgets.units.BaseUnitTuple


Functions
---------

.. autoapisummary::

   kigadgets.units.inch_to_mm
   kigadgets.units.mm_to_inch


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

.. py:type:: CoordinateLike
   :canonical: Union['BaseUnitTuple', Tuple[float, float]]


.. py:data:: nm
   :value: 1e-06


.. py:data:: mm
   :value: 1.0


.. py:data:: inch
   :value: 25.4


.. py:data:: mil
   :value: 0.254


.. py:data:: nm_ius
   :value: 1


.. py:data:: mm_ius
   :value: 1000000


.. py:data:: inch_ius
   :value: 254000000


.. py:data:: mil_ius
   :value: 25400


.. py:data:: deg
   :value: 1.0


.. py:data:: rad
   :value: 57.29577951308232


.. py:data:: DEFAULT_UNIT_IUS
   :value: 1000000


.. py:function:: inch_to_mm(val: Union[float, List, Tuple]) -> Union[float, List]

   Convert from inch to mm.

   Handles single values, sequences, sequences of sequences, etc.


.. py:function:: mm_to_inch(val: Union[float, List, Tuple]) -> Union[float, List]

   Convert from mm to inch.

   Handles single values, sequences, sequences of sequences, etc.


.. py:class:: BaseUnitTuple

   Bases: :py:obj:`object`


   Base class to provide mm, inch, mil properties.

   It's a class to be used just by Point and Size.


   .. py:method:: wrap(instance: Any) -> BaseUnitTuple
      :classmethod:


      Wraps a point or size native object



   .. py:property:: x
      :type: float


      x coordinate.


   .. py:property:: y
      :type: float


      y coordinate.


   .. py:property:: nm
      :type: Tuple[float, float]


      Get the nanometers tuple.


   .. py:property:: mm
      :type: Tuple[float, float]


      Get the milimeters tuple.

      :Example:

      >>> import kigadgets
      >>> p = kigadgets.Point(1, 2)
      >>> p.mm
      (1, 2)


   .. py:property:: inch
      :type: Tuple[float, float]


      Get the inches tuple.


   .. py:property:: mil
      :type: Tuple[float, float]


      Get the mils tuple.