https://github.com/swift502/octarr

Dynamic array-like octree written in C#.
https://github.com/swift502/octarr

array csharp dynamic octree

Last synced: 7 days ago
JSON representation

Dynamic array-like octree written in C#.

• Host: GitHub
• URL: https://github.com/swift502/octarr
• Owner: swift502
• License: mit
• Created: 2021-04-21T19:38:58.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-09-10T18:01:11.000Z (about 2 years ago)
• Last Synced: 2023-03-10T10:21:02.306Z (over 1 year ago)
• Topics: array, csharp, dynamic, octree
• Language: C#
• Homepage: https://jblaha.art/projects/octarr/
• Size: 33.2 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


	

	


	Example of using Octarr to store voxels and visualizing octree nodes using the DrawTree debug function



# Octarr

Stands for octree based 3D array.

Octarr is a dynamic cubic octree capable of storing class data, accessed via indexers. Written in C#, based on the C++ [Cubic-octree](https://github.com/markusgod/cubic-octree).

Basically a generic endless 3D array, which can be accessed like regular arrays and grows and shrinks depending on how much space needs to be allocated. Location index can be positive or negative in any direction. Octarr is centered around the zero coordinate (0, 0, 0), and grows and shrinks _from_ and _to_ this zero coordinate.

Unlike multidimensional or jagged arrays, octarr is memory friendly. You can write a data block at the `[2^64, 2^64, 2^64]` position and not run out of memory. It will then take roughly 64 octree node lookups (logarithmic complexity) to find that data, or anything near it. Octarr is internally using the [BigInteger](https://docs.microsoft.com/dotnet/api/system.numerics.biginteger) data type to allow for unconstrained data location.

```cs

// Usage

public Octarr octarr = new Octarr();	// Create an octarr

octarr[10, -20, 30] = new Data();			// Write

Data data = octarr[10, -20, 30];			// Read assigned, returns your object

data = octarr[1, 2, 3];					// Read unassigned, returns null

// Debug

int nodeCount = octarr.GetNodeCount();	// Count all octree nodes

octarr.DrawTree((float x, float y, float z, float halfSize) =>

{

	DrawBox(x, y, z, halfSize);	// Draw the octree using your own box drawing function

});

```

## Limitations

Data is currently required to be classes. If you want to store structs (int, string, etc.) it'll require some simple modifications and a definition of a default data value other than null.