{"author":"Angus Johnson, Maxime Chalton, Lukas Treyer, Gregor Ratajc","author_email":"me@gregorratajc.com","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Environment :: Other Environment","Intended Audience :: Developers","License :: OSI Approved","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: C++","Programming Language :: Cython","Programming Language :: Python","Programming Language :: Python :: 3","Topic :: Multimedia :: Graphics","Topic :: Scientific/Engineering :: Mathematics","Topic :: Software Development :: Libraries :: Python Modules"],"description":"About\n=====\n\n.. image:: https://badge.fury.io/py/pyclipper.svg\n :target: https://badge.fury.io/py/pyclipper\n.. image:: https://github.com/fonttools/pyclipper/workflows/Build%20+%20Deploy/badge.svg\n :target: https://github.com/fonttools/pyclipper/actions?query=workflow%3A%22Build+%2B+Deploy%22\n\nPyclipper is a Cython wrapper exposing public functions and classes of\nthe C++ translation of the `Angus Johnson's Clipper library (ver.\n6.4.2) `__.\n\nPyclipper releases were tested with Python 2.7 and 3.4 on Linux (Ubuntu\n14.04, x64) and Windows (8.1, x64).\n\nSource code is available on\n`GitHub `__. The package is published on \n`PyPI `__.\n\n\nAbout Clipper\n-------------\n\n Clipper - an open source freeware library for clipping and\n offsetting lines and polygons.\n\n The Clipper library performs line & polygon clipping -\n intersection, union, difference & exclusive-or, and line &\n polygon offsetting. The library is based on Vatti's clipping\n algorithm.\n\n \\ `Angus Johnson's Clipper\n library `__\\ \n\nInstall\n=======\n\nDependencies\n------------\n\nCython dependency is optional. Cpp sources generated with Cython are\navailable in releases.\n\nNote on using the ``setup.py``:\n\n``setup.py`` operates in 2 modes that are based on the presence of the\n``dev`` file in the root of the project.\n\n- When ``dev`` is **present**, Cython will be used to compile the ``.pyx``\n sources. This is the *development mode* (as you get it in the git\n repository).\n- When ``dev`` is **absent**, C/C++ compiler will be used to compile the\n ``.cpp`` sources (that were prepared in in the development mode).\n This is the distribution mode (as you get it on PyPI).\n\nThis way the package can be used without or with an incompatible version\nof Cython.\n\nThe idea comes from `Matt Shannon's bandmat\nlibrary `__.\n\nFrom PyPI\n---------\n\nCython not required.\n\n::\n\n pip install pyclipper\n \n\nFrom source\n-----------\n\nCython required.\n\nClone the repository:\n\n::\n\n git clone git@github.com:fonttools/pyclipper.git\n \n\nInstall:\n\n::\n\n python setup.py install\n \n\nAfter every modification of ``.pyx`` files compile with Cython:\n\n::\n\n python setup.py build_ext --inplace\n \n\nClippers' preprocessor directives\n---------------------------------\nClipper can be compiled with the following preprocessor directives: ``use_int32``, ``use_xyz``, ``use_lines`` and ``use_deprecated``. \nAmong these the ``use_int32`` and ``use_lines`` can be used with Pyclipper.\n\n- ``use_int32`` - when enabled 32bit ints are used instead of 64bit ints. This improve performance but coordinate values are limited to the range +/- 46340. In Pyclipper this directive is **disabled** by default.\n\n- ``use_lines`` - enables line clipping. Adds a very minor cost to performance. In Pyclipper this directive is **enabled** by default (since version 0.9.2b0).\n\nIn case you would want to change these settings, clone this repository and change the ``define_macros`` collection (``setup.py``, pyclipper extension definition). Add a set like ``('use_int32', 1)`` to enable the directive, or remove the set to disable it. After that you need to rebuild the package.\n\nHow to use\n==========\n\nThis wrapper library tries to follow naming conventions of the original\nlibrary.\n\n- ``ClipperLib`` namespace is represented by the ``pyclipper`` module,\n- classes ``Clipper`` and ``ClipperOffset`` -> \n ``Pyclipper`` and ``PyclipperOffset``,\n- when Clipper is overloading functions with different number of\n parameters or different types (eg. ``Clipper.Execute``, one function\n fills a list of paths the other PolyTree) that becomes\n ``Pyclipper.Execute`` and ``Pyclipper.Execute2``.\n\nBasic clipping example (based on `Angus Johnson's Clipper\nlibrary `__):\n\n.. code:: python\n\n import pyclipper\n\n subj = (\n ((180, 200), (260, 200), (260, 150), (180, 150)),\n ((215, 160), (230, 190), (200, 190))\n )\n clip = ((190, 210), (240, 210), (240, 130), (190, 130))\n\n pc = pyclipper.Pyclipper()\n pc.AddPath(clip, pyclipper.PT_CLIP, True)\n pc.AddPaths(subj, pyclipper.PT_SUBJECT, True)\n\n solution = pc.Execute(pyclipper.CT_INTERSECTION, pyclipper.PFT_EVENODD, pyclipper.PFT_EVENODD) \n \n # solution (a list of paths): [[[240, 200], [190, 200], [190, 150], [240, 150]], [[200, 190], [230, 190], [215, 160]]]\n \n\nBasic offset example:\n\n.. code:: python\n\n import pyclipper\n\n subj = ((180, 200), (260, 200), (260, 150), (180, 150))\n\n pco = pyclipper.PyclipperOffset()\n pco.AddPath(subj, pyclipper.JT_ROUND, pyclipper.ET_CLOSEDPOLYGON)\n\n solution = pco.Execute(-7.0)\n \n # solution (a list of paths): [[[253, 193], [187, 193], [187, 157], [253, 157]]]\n\nThe Clipper library uses integers instead of floating point values to\npreserve numerical robustness. If you need to scale coordinates of your polygons, this library provides helper functions ``scale_to_clipper()`` and ``scale_from_clipper()`` to achieve that. \n\nMigrating from Pyclipper ``0.9.3b0``\n------------------------------------\n\nIn previous version of Pyclipper (``0.9.3b0``) polygons could be automatically scaled using the ``SCALING_FACTOR`` variable. This was removed in version ``1.0.0`` due to inexact conversions related to floating point operations. This way the library now provides the original numerical robustness of the base library.\n\nThe ``SCALING_FACTOR`` removal **breaks backward compatibility**. \nFor an explanation and help with migration, see https://github.com/fonttools/pyclipper/wiki/Deprecating-SCALING_FACTOR.\n\nAuthors\n=======\n\n- The Clipper library is written by `Angus\n Johnson `__,\n- This wrapper was initially written by `Maxime\n Chalton `__,\n- Adaptions to make it work with version 5 written by `Lukas\n Treyer `__,\n- Adaptions to make it work with version 6.2.1 and PyPI package written by `Gregor Ratajc `__,\n- ``SCALING_FACTOR`` removal and additions to documentation by Michael Schwarz (@Feuermurmel),\n- Bug fix `sympy.Zero` is not a collection by Jamie Bull (@jamiebull1),\n- Travis CI and Appveyor CI integration for continuous builds of wheel packages by Cosimo Lupo (@anthrotype).\n\nThe package is maintained by Cosimo Lupo (`@anthrotype `__).\n\nLicense\n=======\n\n- Pyclipper is available under `MIT\n license `__.\n- The core Clipper library is available under `Boost Software\n License `__. Freeware for both\n open source and commercial applications.\n\nChangelog\n=========\n\n1.1.0\n-------\n\n- Updated embedded Clipper library to version 6.4.2.\n\n1.0.6\n-------\n- Added support for Python 3.6.\n\n1.0.3\n-------\n- added Travis CI and Appveyor CI to build wheel packages (thanks to @anthrotype)\n\n1.0.2\n-------\n- bug fix: `sympy.Zero` recognized as a collection (thanks to @jamiebull1)\n\n1.0.0\n-------\n- **(breaks backwards compatibility)** removes SCALING_FACTOR (thanks to @Feuermurmel)\n\n0.9.3b0\n-------\n- Applied SCALING_FACTOR to the relevant function parameters and class properties\n- Refactored tests\n\n0.9.2b1\n-------\n- bug fix: Fix setting of the PyPolyNode.IsHole property\n\n0.9.2b0\n-------\n- enable preprocessor directive ``use_lines`` by default,\n- bug fix: PyPolyNode.Contour that is now one path and not a list of paths as it was previously.\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/greginvm/pyclipper","keywords":"polygon clipping, polygon intersection, polygon union, polygon offsetting, polygon boolean, polygon, clipping, clipper, vatti","license":"MIT","license_expression":null,"license_files":null,"maintainer":"Cosimo Lupo","maintainer_email":"cosimo@anthrotype.com","name":"pyclipper","package_url":"https://pypi.org/project/pyclipper/","platform":null,"project_url":"https://pypi.org/project/pyclipper/","project_urls":{"Homepage":"https://github.com/greginvm/pyclipper"},"provides_extra":null,"release_url":"https://pypi.org/project/pyclipper/1.3.0.post6/","requires_dist":null,"requires_python":null,"summary":"Cython wrapper for the C++ translation of the Angus Johnson's Clipper library (ver. 6.4.2)","version":"1.3.0.post6","yanked":false,"yanked_reason":null}

Package search

pyclipper

project_urls

Dependencies

All package metadata

Releases