@jgphilpott/polytree 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +34 -0
- package/package.json +56 -0
- package/polytree.js +2938 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025-present Polytree Contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img width="320" height="320" src="https://raw.githubusercontent.com/jgphilpott/polytree/polytree/icon.png" alt="Polytree Logo">
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
# Intro
|
|
6
|
+
|
|
7
|
+
**Polytree** is a modern, modular Constructive Solid Geometry (CSG) library for JavaScript and Node.js, built to utilize the efficiencies of Octree data structure. It is designed for robust 3D modeling, spatial queries, and seamless integration with [three.js](https://github.com/mrdoob/three.js).
|
|
8
|
+
|
|
9
|
+
## Getting Started
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install polytree
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
```js
|
|
16
|
+
import * as THREE from 'three';
|
|
17
|
+
import { Polytree } from 'polytree';
|
|
18
|
+
|
|
19
|
+
// Example usage coming soon!
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Applications
|
|
23
|
+
|
|
24
|
+
- 3D modeling and design for 3D printing.
|
|
25
|
+
- Integration with [Polyslice](https://github.com/jgphilpott/polyslice) FDM slicer.
|
|
26
|
+
- General-purpose spatial querying and mesh manipulation.
|
|
27
|
+
|
|
28
|
+
## Contributing
|
|
29
|
+
|
|
30
|
+
Contributions, issues, and feature requests are welcome! Please [open an issue](https://github.com/jgphilpott/polytree/issues) or submit a [pull request](https://github.com/jgphilpott/polytree/pulls).
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
**Polytree** is developed and maintained by [@jgphilpott](https://github.com/jgphilpott).
|
package/package.json
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@jgphilpott/polytree",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "A Constructive Solid Geometry (CSG) library using Octree data structure.",
|
|
5
|
+
"funding": "https://github.com/sponsors/jgphilpott",
|
|
6
|
+
"main": "polytree.js",
|
|
7
|
+
"exports": {
|
|
8
|
+
".": {
|
|
9
|
+
"require": "./polytree.js"
|
|
10
|
+
}
|
|
11
|
+
},
|
|
12
|
+
"files": [
|
|
13
|
+
"polytree.js",
|
|
14
|
+
"README.md",
|
|
15
|
+
"LICENSE"
|
|
16
|
+
],
|
|
17
|
+
"directories": {
|
|
18
|
+
"example": "examples"
|
|
19
|
+
},
|
|
20
|
+
"scripts": {
|
|
21
|
+
"test": "jest",
|
|
22
|
+
"pretest": "npm run compile",
|
|
23
|
+
"compile": "coffee -cb .",
|
|
24
|
+
"compile:watch": "coffee -cbw . &",
|
|
25
|
+
"build": "npm run compile && npm test",
|
|
26
|
+
"prepare": "npm run build",
|
|
27
|
+
"prepublishOnly": "npm run build"
|
|
28
|
+
},
|
|
29
|
+
"repository": {
|
|
30
|
+
"type": "git",
|
|
31
|
+
"url": "https://github.com/jgphilpott/polytree"
|
|
32
|
+
},
|
|
33
|
+
"keywords": [
|
|
34
|
+
"polytree",
|
|
35
|
+
"octree",
|
|
36
|
+
"CSG",
|
|
37
|
+
"BVH"
|
|
38
|
+
],
|
|
39
|
+
"author": {
|
|
40
|
+
"name": "Jacob Philpott",
|
|
41
|
+
"email": "jacob.philpott@gmx.com"
|
|
42
|
+
},
|
|
43
|
+
"license": "MIT",
|
|
44
|
+
"bugs": {
|
|
45
|
+
"url": "https://github.com/jgphilpott/polytree/issues"
|
|
46
|
+
},
|
|
47
|
+
"homepage": "https://github.com/jgphilpott/polytree#readme",
|
|
48
|
+
"devDependencies": {
|
|
49
|
+
"coffeescript": "^2.7.0",
|
|
50
|
+
"jest": "^30.1.3"
|
|
51
|
+
},
|
|
52
|
+
"peerDependencies": {
|
|
53
|
+
"three": "^0.180.0"
|
|
54
|
+
},
|
|
55
|
+
"dependencies": {}
|
|
56
|
+
}
|