kigadgets.units

Attributes

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

Classes

BaseUnitTuple

Base class to provide mm, inch, mil properties.

Functions

inch_to_mm(→ Union[float, List])	Convert from inch to mm.
mm_to_inch(→ Union[float, List])	Convert from mm to inch.

Module Contents

type kigadgets.units.CoordinateLike = 'BaseUnitTuple' | Tuple[float, float]

kigadgets.units.nm = 1e-06

kigadgets.units.mm = 1.0

kigadgets.units.inch = 25.4

kigadgets.units.mil = 0.254

kigadgets.units.nm_ius = 1

kigadgets.units.mm_ius = 1000000

kigadgets.units.inch_ius = 254000000

kigadgets.units.mil_ius = 25400

kigadgets.units.deg = 1.0

kigadgets.units.rad = 57.29577951308232

kigadgets.units.DEFAULT_UNIT_IUS = 1000000

kigadgets.units.inch_to_mm(val: float | List | Tuple) → float | List

Convert from inch to mm.

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

kigadgets.units.mm_to_inch(val: float | List | Tuple) → float | List

Convert from mm to inch.

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

class kigadgets.units.BaseUnitTuple

Bases: object

Base class to provide mm, inch, mil properties.

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

classmethod wrap(instance: Any) → BaseUnitTuple

Wraps a point or size native object

property x: float

x coordinate.

property y: float

y coordinate.

property nm: Tuple[float, float]

Get the nanometers tuple.

property mm: Tuple[float, float]

Get the milimeters tuple.

Example:

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

property inch: Tuple[float, float]

Get the inches tuple.

property mil: Tuple[float, float]

Get the mils tuple.