Mesh selections
===============

Helpers for building, saving and replaying triangle selections on a
``pyvcad.SurfaceMesh`` without opening a window. A selection file records the
triangle IDs together with a fingerprint of the mesh they belong to, so it can
refuse to load onto changed geometry, and the recipe that made it, so a point or
ray seed can be rerun after a deliberate remesh. Use
:func:`~pyvcad_rendering.select_mesh_patch` (see :doc:`interactive`) to pick a
selection by hand. See the :doc:`/guides/imports/mesh-selection` guide for a
walkthrough.

.. currentmodule:: pyvcad_rendering

.. autofunction:: resolve_selection_mesh

.. autofunction:: mesh_selection_recipe

.. autofunction:: apply_mesh_selection_recipe

.. autofunction:: save_mesh_selection

.. autofunction:: load_mesh_selection

.. autofunction:: replay_mesh_selection

.. py:data:: SELECTION_FILE_FORMAT
   :type: str
   :value: 'openvcad-mesh-selection'

   Value of the ``format`` field in a saved mesh-selection JSON file.

.. py:data:: SELECTION_FILE_VERSION
   :type: int
   :value: 1

   Version of the mesh-selection file format written by :func:`save_mesh_selection`.