pooltool.constants
==================

.. py:module:: pooltool.constants

    Constants
    ---------
    
    
    .. admonition:: Notes
    
       - **Developer note**: This should really be dissolved into config and motion state
         sections of code
    

Overview
--------




Attributes
----------
.. py:data:: stationary
   :type: int
   :value: '0'

   The stationary motion state label

   A ball with this motion state is both motionless and not in a pocket.

.. py:data:: spinning
   :type: int
   :value: '1'

   The spinning motion state label

   A ball with this motion state is spinning in place.

.. py:data:: sliding
   :type: int
   :value: '2'

   The sliding motion state label

   A ball with this motion state is sliding. For details on what this means precisely, see
   this `blog <https://ekiefl.github.io/2020/04/24/pooltool-theory/#case-4-sliding>`_.

.. py:data:: rolling
   :type: int
   :value: '3'

   The rolling motion state label

   A ball with this motion state is rolling. For details on what this means precisely, see
   this `blog <https://ekiefl.github.io/2020/04/24/pooltool-theory/#case-3-rolling>`_.

.. py:data:: pocketed
   :type: int
   :value: '4'

   The pocketed motion state label

   A ball with this motion state is in a pocket.