:::{note} **This is under construction (work in progress)!** ::: # Table Specification There are many ways to create a table object, each with varying levels of complexity and customizability. This resource will demonstrate each available option, least to most customizability. ## The `Table` object The endpoint for table generation is the {py:class}`Table ` object. :::{admonition} The Table Object :class: dropdown From the API docs: ```{eval-rst} .. autoclass:: pooltool.objects.Table :noindex: ``` ::: ## Using default and prebuilt tables There are several ways to build a table. This document will describe For pocket table specifications I have created a parametrization for table dimensions and cushion geometries involving several parameters. The point of this document is to make clear what each of these parameters does. The class that holds the table specs is {py:class}`PocketTableSpecs `: :::{admonition} PocketTableSpecs :class: dropdown ```{eval-rst} .. autoclass:: pooltool.objects.PocketTableSpecs :noindex: ``` ::: What do each of these parameters do? Let's go through it in detail ## Table dimensions **`l`** is the length of the surface playing area (direction parallel with the y-axis), measured cushion tip to cushion tip. **`w`** is the width of the surface playing area (direction parallel with the x-axis), measured cushion tip to cushion tip. **`cushion_width`** is the horizontal distance from the cushion tip to the edge of the cushion (where it is mounted onto the table framing). This has important implications for how long the cushion segments are in the pockets' openings. For example, here is a cushion width of 2 inches and then 4 inches:

**`cushion_height`** is the vertical distance between the cushion tip and the playing surface. It is supposed to be around 64% of a ball radius. ## Corner pockets **`corner_jaw_radius`** defines the curvature of the jaw tips. For example, snooker has curved jaws and has a large `corner_jaw_radius`. All jaw tips have at least some radius. Here is a small value followed by a large value:

**`corner_pocket_width`** is the opening width of the corner pockets. The distance is drawn from jaw tip to jaw tip in the scenario where `corner_jaw_radius` is set to 0. Here is a jaw width of 0.10 and then 0.05:

**`corner_pocket_depth`** defines how far back the pocket is from the pocket opening. Formally, I've parameterized things such that when `corner_pocket_depth` is 0, the pocket's center coincides with the intersection between the adjacent cushion lines. Here is a value of 0 followed by 0.0417:

**`corner_pocket_radius`** defines the curvature of the pocket lip. Here is a small pocket radius followed by a large pocket radius:

Note that you'll likely have to increase the `corner_pocket_depth` when you increase the `corner_pocket_radius` **`corner_pocket_angle`** defines the angle of the jaw cushions. 0 refers to jaw cushions that are 45 degrees from the adjacent table cushions. Here is 0 followed by 10 degrees:

## Side pockets **`side_pocket_width`** see `corner_pocket_width` **`side_pocket_depth`** see `corner_pocket_depth` **`side_pocket_radius`** see `corner_pocket_radius` **`side_jaw_radius`** see `corner_jaw_radius` **`side_pocket_angle`** is similar `corner_pocket_angle`, except 0 refers to jaw cushions that are 90 degrees from the adjacent table cushions. Here is 0 followed by 10 degrees: