Skip to content

Latest commit

 

History

History
61 lines (35 loc) · 2.55 KB

README.md

File metadata and controls

61 lines (35 loc) · 2.55 KB
Raw

ofxSpatialHash

Description

A collection of 2D/3D spatial hashing algorithms. Useful for quick nearest neighbor calculations in 2-, 3-d and N-d.

Inspired by https://github.com/neilmendoza/ofxNearestNeighbour/ and others.

See class documentation and examples for more information.

2-D Hash 3-D Hash N-D Hash (example uses 3 dimensions for easy visualization)

Features

  • Allows for an all-in-one approach to spatially indexing existing point clouds for rapid 2D/3D search.
  • Supports easy use of ofVec2f, ofVec3f, ofVec2f, glm::vec2, glm::vec3, glm::vec4.
  • Supports N dimensional hash using std::array<float, N>. See example_kdtree_nd for a 3d version.

Getting Started

To get started, generate the example project files using the openFrameworks Project Generator.

Documentation

API documentation can be found here.

Build Status

Linux, macOS Build Status

Visual Studio, MSYS Build status

Compatibility

The stable branch of this repository is meant to be compatible with the openFrameworks stable branch, which corresponds to the latest official openFrameworks release.

The master branch of this repository is meant to be compatible with the openFrameworks master branch.

Some past openFrameworks releases are supported via tagged versions, but only stable and master branches are actively supported.

Versioning

This project uses Semantic Versioning, although strict adherence will only come into effect at version 1.0.0.

Licensing

See LICENSE.md.

Contributing

Pull Requests are always welcome, so if you make any improvements please feel free to float them back upstream :)

  1. Fork this repository.
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin my-new-feature).
  5. Create new Pull Request.