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:`ResolverConfig <pooltool.physics.resolve.resolver.ResolverConfig>`
     - A structured form of the user resolver config
   * - :py:obj:`Resolver <pooltool.physics.resolve.resolver.Resolver>`
     - A physics engine component that characterizes event resolution



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

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


Classes
-------
.. autoclass:: ResolverConfig




   .. rubric:: Methods:
   .. py:method:: default() -> ResolverConfig
      :classmethod:

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



.. autoclass:: Resolver




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

      Resolve an event for a system





Attributes
----------
.. py:data:: RESOLVER_CONFIG_PATH

   The location of the resolver config path YAML.