pooltool.physics.resolve.resolver
=================================

.. py:module:: pooltool.physics.resolve.resolver

    Resolve collisions and transitions
    ----------------------------------
    
    

Overview
--------

.. list-table:: Classes
   :header-rows: 0
   :widths: auto
   :class: summarytable

   * - :py:obj:`Resolver <pooltool.physics.resolve.resolver.Resolver>`
     - A physics engine component that characterizes event resolution


.. list-table:: Function
   :header-rows: 0
   :widths: auto
   :class: summarytable

   * - :py:obj:`default_resolver <pooltool.physics.resolve.resolver.default_resolver>`\ ()
     - The default resolver.


.. list-table:: Attributes
   :header-rows: 0
   :widths: auto
   :class: summarytable

   * - :py:obj:`RESOLVER_PATH <pooltool.physics.resolve.resolver.RESOLVER_PATH>`
     - The location of the resolver path YAML.


Classes
-------
.. autoclass:: Resolver




   .. rubric:: Methods:
   .. py:method:: resolve(shot: pooltool.system.datatypes.System, event: pooltool.events.datatypes.Event) -> None

      Resolve an event for a system


   .. py:method:: default() -> Resolver
      :classmethod:

      Load ~/.config/pooltool/physics/resolver.yaml if exists, create otherwise




Functions
---------
.. py:function:: default_resolver() -> Resolver

   The default resolver.

   This default resolver will be used and written to the resolver YAML if:

       1. There is no resolver YAML
       2. The resolver YAML is corrupt
       3. The resolver YAML version doesn't match `VERSION`

   The resolver YAML is found at `RESOLVER_PATH`.



Attributes
----------
.. py:data:: RESOLVER_PATH

   The location of the resolver path YAML.