Project icon

com.io7m.jspatial

Build status Maven Central Codacy Codecov

The jspatial package provides a set of spatial data structures.

Contents

Features

  • Quadtree implementations, including efficient area and raycast queries.
  • Octtree implementations, including efficient volume and raycast queries.
  • Numerous working examples, such as the octtree viewer pictured above.
  • Fully documented (Javadoc).
  • 97% automated unit test coverage.
  • ISC license.
  • OSGi-ready.
  • JPMS-ready
  • Platform independent: Written in pure Java 11.
  • Rendering system independent (the example viewers use Swing and JOGL, but neither are required to use the library).

Releases

The current release is 3.0.0-beta0003.

Source code and binaries are available from the repository.

Documentation

Documentation for the 3.0.0-beta0003 release is available for reading online.

Documentation for current and older releases is archived in the repository.

User documentation

Maven

The following is a complete list of the project's modules expressed as Maven dependencies: 

<dependency>
  <groupId>com.io7m.jspatial</groupId>
  <artifactId>com.io7m.jspatial</artifactId>
  <version>3.0.0-beta0003</version>
</dependency>

<dependency>
  <groupId>com.io7m.jspatial</groupId>
  <artifactId>com.io7m.jspatial.api</artifactId>
  <version>3.0.0-beta0003</version>
</dependency>

<dependency>
  <groupId>com.io7m.jspatial</groupId>
  <artifactId>com.io7m.jspatial.documentation</artifactId>
  <version>3.0.0-beta0003</version>
</dependency>

<dependency>
  <groupId>com.io7m.jspatial</groupId>
  <artifactId>com.io7m.jspatial.examples.swing</artifactId>
  <version>3.0.0-beta0003</version>
</dependency>

<dependency>
  <groupId>com.io7m.jspatial</groupId>
  <artifactId>com.io7m.jspatial.implementation</artifactId>
  <version>3.0.0-beta0003</version>
</dependency>

<dependency>
  <groupId>com.io7m.jspatial</groupId>
  <artifactId>com.io7m.jspatial.tests</artifactId>
  <version>3.0.0-beta0003</version>
</dependency>

Each release of the project is made available on Maven Central within ten minutes of the release announcement.

Changes

Subscribe to the releases atom feed.

2017-12-08 Release: com.io7m.jspatial 3.0.0
2014-11-28 Change: (Backwards incompatible) Remove *Config* classes and replace with static constructor functions and mutable builders
2014-11-28 Change: (Backwards incompatible) Rename and suffix all interface types with "Type", in line with io7m conventions
2014-11-28 Change: (Backwards incompatible) Replace use of jaux with the new jnull/junreachable packages
2014-11-28 Change: (Backwards incompatible) Use jtensors 6.0.1
2014-11-28 Change: Add all configurations of limiting/pruning/SD algorithms
2014-11-28 Change: Use launch4j for Windows executables
2014-11-28 Change: Rewrite viewers
2016-08-26 Change: (Backwards incompatible) Complete rewrite of all trees and viewers
2016-08-26 Change: (Backwards incompatible) Remove the static/dynamic object type interfaces
2016-08-26 Change: Add long integer/double precision tree types
2016-08-26 Change: (Backwards incompatible) Use jtensors 7.0.0-beta0011
2016-08-26 Change: The packages are now OSGi bundles
2017-04-25 Change: Rename project. Use the new primogenitor POM and 2017 project conventions.
2017-05-06 Change: (Backwards incompatible) Use jtensors [8.1.0, 9.0.0)
2017-05-09 Change: (Backwards incompatible) Replace all quadrant and octant handling with jregions. (tickets: 5 )
2017-12-08 Change: (Backwards incompatible) Use jtensors 9.0.0
2017-12-08 Change: (Backwards incompatible) Remove jnull and jfunctional dependencies
2017-12-08 Change: (Backwards incompatible) Publish Java 9 modules. JDK 9 is now required to build and run.
2013-06-15 Release: com.io7m.jspatial 2.0.0
2012-05-04 Change: (Backwards incompatible) Require Java 7 and update example Swing viewers to use JDK7 widgets (with generics)
2012-05-04 Change: (Backwards incompatible) Use jtensors 5.*
2012-05-04 Change: Explicitly demand a fixed-function OpenGL implementation in the Octtree viewer
2012-05-04 Change: (Backwards incompatible) Use jaux 2.4.* for more predictable unit test behaviour with floating point values
2012-12-09 Release: com.io7m.jspatial 1.3.0
2012-12-09 Change: Allow trees that are not rooted at (0,0,0). See OctTreeConfig.setPosition() and QuadTreeConfig.setPosition().
2012-11-24 Release: com.io7m.jspatial 1.2.0
2012-11-24 Change: Use jtensors 4.1.0
2012-11-24 Release: com.io7m.jspatial 1.1.0
2012-11-24 Change: Use jtensors 4.0.0
2012-11-21 Release: com.io7m.jspatial 1.0.0
2012-11-21 Change: Initial version

Sources

This project uses Git to manage source code.

Repository: https://github.com/io7m/jspatial

$ git clone https://github.com/io7m/jspatial

License

Copyright ⓒ 2019 Mark Raynsford <code@io7m.com> http://io7m.com

Permission to use, copy, modify, and/or distribute this software for
any purpose with or without fee is hereby granted, provided that the
above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR
BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
SOFTWARE.

Bug Tracker

The project uses GitHub Issues to track issues.