Cell maps
=========

A cell map is an immutable coordinate layout: a box, a cylinder, a spherical
band, or a curvilinear volume on top of a surface. Every structure builder
takes one. The returned objects are ``pyvcad.CellMap`` or
``pyvcad.CellMapCollection`` instances.

.. currentmodule:: pyvcad_metamaterials

Analytic maps
-------------

.. autofunction:: rectangular_cell_map

.. autofunction:: cylindrical_cell_map

.. autofunction:: spherical_cell_map

Surface maps
------------

.. autofunction:: cell_map_from_surface

.. autofunction:: cell_map_from_cad_face

.. autofunction:: cell_map_between_surfaces

.. autofunction:: cell_map_between_cad_faces

Map tools
---------

.. autofunction:: warp_cell_map

.. autofunction:: rim

.. autofunction:: surface_gap

.. autofunction:: domain

.. autofunction:: map_node

Raw OCP shapes
--------------

CadQuery shapes are converted with ``pyvcad.CADModel.from_cadquery``. Raw
OCP shapes use the optional ``pyvcad_metamaterials.occ`` adapters, which need
the ``cad`` extra (``pip install "pyvcad-metamaterials[cad]"``).

.. autofunction:: pyvcad_metamaterials.occ.body

.. autofunction:: pyvcad_metamaterials.occ.face

.. autofunction:: pyvcad_metamaterials.occ.faces