clipping 0.7.1

Polygons clipping based on algorithm by F. Martinez et al.

clipping

In what follows

• python is an alias for python3.5 or any later version (python3.6 and so on),
• pypy is an alias for pypy3.5 or any later version (pypy3.6 and so on).

Installation

Install the latest pip & setuptools packages versions:

• with CPython

  python -m pip install --upgrade pip setuptools
  

• with PyPy

  pypy -m pip install --upgrade pip setuptools
  

User

Download and install the latest stable version from PyPI repository:

• with CPython

  python -m pip install --upgrade clipping
  

• with PyPy

  pypy -m pip install --upgrade clipping
  

Developer

Download the latest version from GitHub repository

git clone https://github.com/lycantropos/clipping.git
cd clipping

Install dependencies:

• with CPython

  python -m pip install --force-reinstall -r requirements.txt
  

• with PyPy

  pypy -m pip install --force-reinstall -r requirements.txt
  

Install:

• with CPython

  python setup.py install
  

• with PyPy

  pypy setup.py install
  

Usage

>>> left_edge = ((0, 0), (0, 1))
>>> right_edge = ((1, 0), (1, 1))
>>> bottom_edge = ((0, 0), (1, 0))
>>> top_edge = ((0, 1), (1, 1))
>>> main_diagonal = ((0, 0), (1, 1))
>>> trident = [left_edge, main_diagonal, bottom_edge]
>>> square_edges = [bottom_edge, right_edge, top_edge, left_edge]
>>> from clipping.planar import intersect_multisegments
>>> (intersect_multisegments(trident, square_edges)
...  == intersect_multisegments(square_edges, trident)
...  == [left_edge, bottom_edge])
True
>>> from clipping.planar import complete_intersect_multisegments
>>> (complete_intersect_multisegments(trident, square_edges)
...  == complete_intersect_multisegments(square_edges, trident)
...  == ([(1, 1)], intersect_multisegments(trident, square_edges), []))
True
>>> from clipping.planar import unite_multisegments
>>> (unite_multisegments(trident, square_edges)
...  == unite_multisegments(square_edges, trident)
...  == [left_edge, bottom_edge, main_diagonal, top_edge, right_edge])
True
>>> from clipping.planar import subtract_multisegments
>>> subtract_multisegments(trident, square_edges) == [main_diagonal]
True
>>> subtract_multisegments(square_edges, trident) == [top_edge, right_edge]
True
>>> from clipping.planar import symmetric_subtract_multisegments
>>> (symmetric_subtract_multisegments(trident, square_edges)
...  == symmetric_subtract_multisegments(square_edges, trident)
...  == [main_diagonal, top_edge, right_edge])
True
>>> left_triangle = [([(0, 0), (1, 0), (0, 1)], [])]
>>> right_triangle = [([(0, 1), (1, 0), (1, 1)], [])]
>>> square = [([(0, 0), (1, 0), (1, 1), (0, 1)], [])]
>>> from clipping.planar import intersect_multipolygons
>>> all(intersect_multipolygons(square, triangle)
...     == intersect_multipolygons(triangle, square) == triangle
...     for triangle in (left_triangle, right_triangle))
True
>>> intersect_multipolygons(left_triangle, right_triangle) == []
True
>>> from clipping.planar import complete_intersect_multipolygons
>>> all(complete_intersect_multipolygons(square, triangle)
...     == ([], [], intersect_multipolygons(square, triangle))
...     for triangle in (left_triangle, right_triangle))
True
>>> (complete_intersect_multipolygons(left_triangle, right_triangle)
...  == ([], [((0, 1), (1, 0))], []))
True
>>> from clipping.planar import unite_multipolygons
>>> all(unite_multipolygons(square, triangle)
...     == unite_multipolygons(triangle, square)
...     == square
...     for triangle in (left_triangle, right_triangle))
True
>>> (unite_multipolygons(left_triangle, right_triangle)
...  == unite_multipolygons(right_triangle, left_triangle)
...  == square)
True
>>> from clipping.planar import subtract_multipolygons
>>> all(subtract_multipolygons(triangle, square) == []
...     for triangle in (left_triangle, right_triangle))
True
>>> subtract_multipolygons(square, left_triangle) == right_triangle
True
>>> subtract_multipolygons(square, right_triangle) == left_triangle
True
>>> from clipping.planar import symmetric_subtract_multipolygons
>>> symmetric_subtract_multipolygons(left_triangle, right_triangle) == square
True
>>> symmetric_subtract_multipolygons(square, left_triangle) == right_triangle
True
>>> symmetric_subtract_multipolygons(square, right_triangle) == left_triangle
True

Development

Bumping version

Preparation

Install bump2version.

Pre-release

Choose which version number category to bump following semver specification.

Test bumping version

bump2version --dry-run --verbose $CATEGORY

where $CATEGORY is the target version number category name, possible values are patch/minor/major.

Bump version

bump2version --verbose $CATEGORY

This will set version to major.minor.patch-alpha.

Release

Test bumping version

bump2version --dry-run --verbose release

Bump version

bump2version --verbose release

This will set version to major.minor.patch.

Running tests

Install dependencies:

• with CPython

  python -m pip install --force-reinstall -r requirements-tests.txt
  

• with PyPy

  pypy -m pip install --force-reinstall -r requirements-tests.txt
  

Plain

pytest

Inside Docker container:

• with CPython

  docker-compose --file docker-compose.cpython.yml up
  

• with PyPy

  docker-compose --file docker-compose.pypy.yml up
  

Bash script (e.g. can be used in Git hooks):

• with CPython

  ./run-tests.sh
  

  or

  ./run-tests.sh cpython
  

• with PyPy

  ./run-tests.sh pypy
  

PowerShell script (e.g. can be used in Git hooks):

• with CPython

  .\run-tests.ps1
  

  or

  .\run-tests.ps1 cpython
  

• with PyPy

  .\run-tests.ps1 pypy