three-zoo 0.5.0 → 0.5.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/README.md +18 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,14 +1,22 @@
|
|
|
1
|
-
# three-zoo
|
|
1
|
+
# 🦁 three-zoo
|
|
2
|
+
|
|
3
|
+
<p align="center">
|
|
4
|
+
<a href="https://www.npmjs.com/package/three-zoo"><img src="https://img.shields.io/npm/v/three-zoo.svg" alt="npm version"></a>
|
|
5
|
+
<a href="https://bundlephobia.com/package/three-zoo"><img src="https://badgen.net/bundlephobia/min/three-zoo" alt="bundle size (min)"></a>
|
|
6
|
+
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
|
|
7
|
+
<a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/TypeScript-%5E5.8.0-blue" alt="TypeScript"></a>
|
|
8
|
+
<a href="https://threejs.org/"><img src="https://img.shields.io/badge/Three.js-%5E0.175.0-green" alt="Three.js"></a>
|
|
9
|
+
</p>
|
|
2
10
|
|
|
3
11
|
A modest collection of Three.js utilities designed to simplify common 3D development tasks.
|
|
4
12
|
|
|
5
|
-
## Install
|
|
13
|
+
## 📦 Install
|
|
6
14
|
|
|
7
15
|
```bash
|
|
8
16
|
npm install three-zoo
|
|
9
17
|
```
|
|
10
18
|
|
|
11
|
-
## Overview
|
|
19
|
+
## 🎯 Overview
|
|
12
20
|
|
|
13
21
|
**three-zoo** provides focused solutions for recurring challenges in 3D web development:
|
|
14
22
|
|
|
@@ -19,9 +27,9 @@ npm install three-zoo
|
|
|
19
27
|
|
|
20
28
|
Each utility is designed to work seamlessly with existing Three.js workflows without imposing architectural constraints.
|
|
21
29
|
|
|
22
|
-
## Tools
|
|
30
|
+
## 🛠️ Tools
|
|
23
31
|
|
|
24
|
-
### DualFovCamera
|
|
32
|
+
### 📷 DualFovCamera
|
|
25
33
|
|
|
26
34
|
Camera with independent horizontal and vertical field of view control, plus advanced fitting capabilities:
|
|
27
35
|
|
|
@@ -43,7 +51,7 @@ const actualHFov = camera.getActualHorizontalFov();
|
|
|
43
51
|
const actualVFov = camera.getActualVerticalFov();
|
|
44
52
|
```
|
|
45
53
|
|
|
46
|
-
### Sun
|
|
54
|
+
### ☀️ Sun
|
|
47
55
|
|
|
48
56
|
Directional light with intuitive spherical positioning and automatic shadow configuration:
|
|
49
57
|
|
|
@@ -62,7 +70,7 @@ sun.configureShadowsForBoundingBox(sceneBounds);
|
|
|
62
70
|
sun.setDirectionFromHDRTexture(hdrTexture, 50);
|
|
63
71
|
```
|
|
64
72
|
|
|
65
|
-
### SceneTraversal
|
|
73
|
+
### 🔍 SceneTraversal
|
|
66
74
|
|
|
67
75
|
Scene graph navigation and batch operations for finding and manipulating objects:
|
|
68
76
|
|
|
@@ -89,7 +97,7 @@ SceneTraversal.enumerateMaterials(scene, (material) => {
|
|
|
89
97
|
});
|
|
90
98
|
```
|
|
91
99
|
|
|
92
|
-
### SkinnedMeshBaker
|
|
100
|
+
### 🎭 SkinnedMeshBaker
|
|
93
101
|
|
|
94
102
|
Converts animated skinned meshes to static geometry:
|
|
95
103
|
|
|
@@ -106,11 +114,11 @@ const frameMesh = SkinnedMeshBaker.bakeAnimationFrame(
|
|
|
106
114
|
);
|
|
107
115
|
```
|
|
108
116
|
|
|
109
|
-
## Requirements
|
|
117
|
+
## ⚡ Requirements
|
|
110
118
|
|
|
111
119
|
- Three.js >= 0.150.0
|
|
112
120
|
- TypeScript support included
|
|
113
121
|
|
|
114
|
-
## License
|
|
122
|
+
## 📄 License
|
|
115
123
|
|
|
116
124
|
MIT
|