three-instance-batch 0.1.0 → 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 qiao-coding
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -28,7 +28,7 @@ inst.castShadow = true
 batcher.addInstance(inst)
 
 function animate() {
-  inst.position.x = Math.sin(Date.now() * 0.001) * 5
+  inst.position.setX(Math.sin(Date.now() * 0.001) * 5)
   batcher.update(camera)
   renderer.render(scene, camera)
   requestAnimationFrame(animate)
@@ -37,9 +37,35 @@ function animate() {
 
 No `setMatrixAt`. No `needsUpdate`. Just change properties and call `update()`.
 
+## Multiple Instances
+
+```ts
+const count = 500
+const instances: Instance[] = []
+
+for (let i = 0; i < count; i++) {
+  const inst = new Instance(geo, mat)
+  const angle = (i / count) * Math.PI * 2
+  inst.position.set(Math.cos(angle) * 10, 0, Math.sin(angle) * 10)
+  inst.color.setHSL(i / count, 0.8, 0.5)
+  instances.push(inst)
+}
+batcher.addInstance(instances)
+
+function animate() {
+  for (let i = 0; i < instances.length; i++) {
+    instances[i].rotation.set(0, Date.now() * 0.001 + i * 0.1, 0)
+    instances[i].color.setHSL((Date.now() * 0.0001 + i * 0.002) % 1, 0.8, 0.5)
+  }
+  batcher.update(camera)
+  renderer.render(scene, camera)
+  requestAnimationFrame(animate)
+}
+```
+
 ## How It Works
 
-`Instance` wraps `Vector3`, `Quaternion`, and `Color` setter methods at construction time. Any mutation — `position.set()`, `quaternion.setFromEuler()`, `color.setHSL()`, etc. — automatically marks that instance dirty. On `batcher.update()`, only the changed matrix rows and color rows are written to the GPU buffer.
+`Instance` wraps `Vector3`, `Euler`, `Quaternion`, and `Color` setter methods at construction time. Any mutation via setter — `position.set()`, `rotation.set()`, `quaternion.setFromEuler()`, `color.setHSL()`, etc. — automatically marks that instance dirty. Note that direct property assignment (`position.x = 5`) is **not** tracked; use `setX()` or `set()` instead.
 
 Instances are grouped into `InstancedMesh` objects by a **group key** derived from geometry UUID, material properties, and shadow flags. Instances sharing the same key share one draw call.
 
@@ -109,6 +135,7 @@ new Instance(geometry: BufferGeometry, material: Material)
 | `material` | `Material` | Readonly |
 | `position` | `Vector3` | Auto-tracked |
 | `scale` | `Vector3` | Default `(1,1,1)`, auto-tracked |
+| `rotation` | `Euler` | Auto-tracked; syncs to `quaternion` on change |
 | `quaternion` | `Quaternion` | Auto-tracked |
 | `color` | `Color` | Default white, auto-tracked |
 | `visible` | `boolean` | Hidden instances write a zero matrix |
@@ -123,7 +150,7 @@ new Instance(geometry: BufferGeometry, material: Material)
 | `isAncestorOf(other)` | `boolean` | |
 | `dispose()` | `void` | Detaches from parent, detaches children, unsubscribes from all batchers |
 
-> **Note:** `rotation` (Euler) mutates are tracked and auto-sync to `quaternion`.
+> **Note:** Only method calls (`.set()`, `.setX()`, `.copy()`, etc.) are tracked. Property assignment (`position.x = 5`) bypasses the wrapper. Use `setX()` / `setY()` / `setZ()` for single-component updates.
 
 ### `InstanceBatcher`
 
@@ -170,7 +197,20 @@ The real bottleneck at scale is GPU draw calls and vertex throughput, not JS-sid
 
 ## Known Limitations
 
-- Frustum culling is JS-side only; it does not write zero matrices for culled instances.
+- Frustum culling collects per-instance visibility but does not yet skip culled instances in the render pass.
+
+## Development
+
+```bash
+git clone https://github.com/qiao-coding/three-instance-batch.git
+cd three-instance-batch
+npm install
+npm run test:run    # 56 tests
+npm run dev         # start demo at localhost:5173
+npm run build       # build to dist/
+```
+
+PRs welcome. Open an issue before starting on anything substantial.
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "three-instance-batch",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Declarative instanced rendering for Three.js — Instance describes what, InstanceBatcher decides how to draw",
   "type": "module",
   "main": "./dist/three-instance-batch.js",
@@ -25,11 +25,12 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/xier123456/three-instance-batch"
+    "url": "https://github.com/qiao-coding/three-instance-batch.git"
   },
-  "author": "xier123456",
+  "author": "qiao-coding",
+  "homepage": "https://github.com/qiao-coding/three-instance-batch#readme",
   "bugs": {
-    "url": "https://github.com/xier123456/three-instance-batch/issues"
+    "url": "https://github.com/qiao-coding/three-instance-batch/issues"
   },
   "peerDependencies": {
     "three": ">=0.152.0"