.. begin-badges
|s-ci| |s-cov| |s-license|
|s-doi1|
|l-github| Repository_
|l-rtd| Documentation_
|l-pypi| PyPI_
.. begin-introduction
AABBTree is a pure Python implementation of a static d-dimensional
axis aligned bounding box (AABB) tree. It is inspired by
Introductory Guide to AABB Tree Collision Detection_
from Azure From The Trenches.
.. end-introduction
.. figure:: https://aabbtree.readthedocs.io/en/latest/_images/diagram.png :alt: AABB Tree :align: center
Left: An AABB tree, leaves numbered by insertion order.
Right: The AABBs and their bounding boxes.
.. begin-installation
AABBTree is available through PyPI and can be installed by running::
pip install aabbtree
To test that the package installed properly, run::
python -c "import aabbtree"
Alternatively, the package can be installed from source by downloading the
latest release from the AABBTree repository_ on GitHub. Extract the source
and, from the top-level directory, run::
pip install -e .
The --user flag may be needed, depending on permissions.
The following example shows how to build an AABB tree and test for overlap::
from aabbtree import AABB from aabbtree import AABBTree tree = AABBTree() aabb1 = AABB([(0, 0), (0, 0)]) aabb2 = AABB([(-1, 1), (-1, 1)]) aabb3 = AABB([(4, 5), (2, 3)]) tree.add(aabb1, 'box 1') tree.does_overlap(aabb2) True tree.overlap_values(aabb2) ['box 1'] tree.does_overlap(aabb3) False tree.add(aabb3) print(tree) AABB: [(0, 5), (0, 3)] Value: None Left: AABB: [(0, 0), (0, 0)] Value: box 1 Left: None Right: None Right: AABB: [(4, 5), (2, 3)] Value: None Left: None Right: None
.. begin-documentation
Documentation for the project is available at https://aabbtree.readthedocs.io.
.. end-documentation
Contributions to the project are welcome.
Please visit the AABBTree repository_ to clone the source files,
create a pull request, and submit issues.
If you use AABBTree in you work, please consider including this citation in your bibliography:
K. A. Hart and J. J. Rimoli, Generation of statistically representative
microstructures with direct grain geomety control,
Computer Methods in Applied Mechanics and Engineering, 370 (2020), 113242.
(BibTeX <https://github.com/kip-hart/MicroStructPy/raw/master/docs/publications/cmame2020.bib>)
(DOI <https://doi.org/10.1016/j.cma.2020.113242>)
The incremental insertion method is discussed in section 2.2.2 of the paper.
Copyright |copy| 2019-2021, Georgia Tech Research Corporation
AABBTree is open source and freely available under the terms of the MIT license.
.. |copy| unicode:: 0xA9 .. copyright sign
.. LINKS
.. _AABBTree repository : https://github.com/kip-hart/AABBTree
.. _Repository : https://github.com/kip-hart/AABBTree
.. _Documentation : https://aabbtree.readthedocs.io
.. _PyPI : https://pypi.org/project/aabbtree/
.. _Introductory Guide to AABB Tree Collision Detection : https://www.azurefromthetrenches.com/introductory-guide-to-aabb-tree-collision-detection/
.. SHIELDS
.. |s-license| image:: https://img.shields.io/pypi/l/aabbtree.svg :target: https://github.com/kip-hart/AABBTree/blob/master/LICENSE.rst :alt: License
.. |s-docs| image:: https://readthedocs.org/projects/aabbtree/badge/?version=latest :target: https://aabbtree.readthedocs.io :alt: Documentation Status
.. |s-ci| image:: https://img.shields.io/github/workflow/status/kip-hart/AABBTree/CI?labelColor=grey :target: https://github.com/kip-hart/AABBTree/actions :alt: Continuous Integration
.. |s-cov| image:: https://coveralls.io/repos/github/kip-hart/AABBTree/badge.svg?branch=master :target: https://coveralls.io/github/kip-hart/AABBTree?branch=master :alt: Coverage
.. |s-pver| image:: https://img.shields.io/pypi/v/aabbtree.svg :target: https://pypi.org/project/aabbtree/ :alt: PyPI
.. |s-doi1| image:: https://img.shields.io/badge/DOI-10.1016%2Fj.cma.2020.113242-blue :target: https://doi.org/10.1016/j.cma.2020.113242 :alt: CMAME DOI
.. ICONS
.. |l-github| image:: https://api.iconify.design/octicon:mark-github.svg?color=black0&inline=true&height=16 :target: https://github.com/kip-hart/AABBTree :alt: GitHub
.. |l-rtd| image:: https://api.iconify.design/simple-icons:readthedocs.svg?color=black&inline=true&height=16 :target: https://aabbtree.readthedocs.io :alt: ReadTheDocs
.. |l-pypi| image:: https://api.iconify.design/mdi:cube-outline.svg?color=black&inline=true&height=16 :target: https://pypi.org/project/aabbtree/ :alt: PyPI
FAQs
Pure Python implementation of d-dimensional AABB tree.
We found that aabbtree demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The ongoing npm phishing campaign escalates as attackers hijack the popular 'is' package, embedding malware in multiple versions.
Security News
A critical flaw in the popular npm form-data package could allow HTTP parameter pollution, affecting millions of projects until patched versions are adopted.
Security News
Bun 1.2.19 introduces isolated installs for smoother monorepo workflows, along with performance boosts, new tooling, and key compatibility fixes.
