{"id":15314016,"url":"https://github.com/vanruesc/sparse-octree","last_synced_at":"2025-04-06T04:11:05.859Z","repository":{"id":8574933,"uuid":"58883697","full_name":"vanruesc/sparse-octree","owner":"vanruesc","description":"A sparse octree data structure.","archived":false,"fork":false,"pushed_at":"2024-07-05T14:41:43.000Z","size":6073,"stargazers_count":124,"open_issues_count":0,"forks_count":20,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-30T02:08:11.743Z","etag":null,"topics":["3d","culling","octree","raycasting","sparse"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"zlib","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vanruesc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-05-15T20:49:31.000Z","updated_at":"2025-03-23T10:18:36.000Z","dependencies_parsed_at":"2024-06-18T15:36:04.027Z","dependency_job_id":"68e1b033-20df-467b-a6aa-c39df6a639cc","html_url":"https://github.com/vanruesc/sparse-octree","commit_stats":{"total_commits":637,"total_committers":4,"mean_commits":159.25,"dds":0.4427001569858713,"last_synced_commit":"47f18878d058fa3ec19af6a777384a2a9e8bfd1a"},"previous_names":[],"tags_count":39,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanruesc%2Fsparse-octree","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanruesc%2Fsparse-octree/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanruesc%2Fsparse-octree/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanruesc%2Fsparse-octree/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vanruesc","download_url":"https://codeload.github.com/vanruesc/sparse-octree/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247430870,"owners_count":20937874,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["3d","culling","octree","raycasting","sparse"],"created_at":"2024-10-01T08:44:10.984Z","updated_at":"2025-04-06T04:11:05.833Z","avatar_url":"https://github.com/vanruesc.png","language":"TypeScript","readme":"# Sparse Octree\n\n[![CI](https://github.com/vanruesc/sparse-octree/actions/workflows/ci.yml/badge.svg)](https://github.com/vanruesc/sparse-octree/actions/workflows/ci.yml)\n[![Version](https://badgen.net/npm/v/sparse-octree?color=green)](https://www.npmjs.com/package/sparse-octree)\n\nA sparse, pointer-based octree data structure. For a linear implementation see [linear-octree](https://github.com/vanruesc/linear-octree).\n\n*[Demo](https://vanruesc.github.io/sparse-octree/demo)\u0026ensp;\u0026middot;\u0026ensp;[Sandbox](https://codesandbox.io/s/sparse-octree-3yn8o)\u0026ensp;\u0026middot;\u0026ensp;[Documentation](https://vanruesc.github.io/sparse-octree/docs)*\n\n\n## Installation\n\nThis library requires the peer dependency [three](https://github.com/mrdoob/three.js/).\n\n```sh\nnpm install three sparse-octree\n``` \n\n\n## Usage\n\n##### Points\n\n```js\nimport { Vector3 } from \"three\";\nimport { PointOctree } from \"sparse-octree\";\n\nconst min = new Vector3(-1, -1, -1);\nconst max = new Vector3(1, 1, 1);\n\nconst octree = new PointOctree(min, max);\n\nconst myData = {};\nconst p1 = new Vector3(0, 0, 0);\nconst p2 = new Vector3(0, 0, 0.5);\n\noctree.set(p1, myData);\noctree.move(p1, p2);\noctree.get(p2); // =\u003e myData\n\noctree.remove(p2);\noctree.get(p2); // =\u003e null\n```\n\n##### Custom Octrees\n\n```js\nimport { Octree, CubicOctant } from \"sparse-octree\";\n\nexport class CubicOctree extends Octree {\n\n\tconstructor(min, size) {\n\n\t\tthis.root = new CubicOctant(min, size);\n\n\t}\n\n}\n```\n\n\n## Features\n\n- Pointer-based structure\n  - Handles octant splitting\n  - Supports cubic octrees for reduced memory usage\n  - Dynamic depth\n- Adheres to a [common octant layout](https://vanruesc.github.io/sparse-octree/docs/index.html#layout)\n- Supports raycasting\n- Supports culling\n- Can be extended to manage any data\n- Provides a point management implementation\n\n\n## Contributing\n\nMaintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvanruesc%2Fsparse-octree","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvanruesc%2Fsparse-octree","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvanruesc%2Fsparse-octree/lists"}