@needle-tools/engine 4.8.8-next.aa09526 → 4.8.8-next.db5fdbd

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.
Files changed (35) hide show
  1. package/README.md +50 -45
  2. package/dist/{needle-engine.bundle-DDQrIop6.min.js → needle-engine.bundle-BtPGFT7e.min.js} +6 -6
  3. package/dist/{needle-engine.bundle-xO7DnXAE.js → needle-engine.bundle-COsyGTEY.js} +42 -24
  4. package/dist/{needle-engine.bundle-C5WmZ20c.umd.cjs → needle-engine.bundle-IiODerFA.umd.cjs} +53 -53
  5. package/dist/needle-engine.js +2 -2
  6. package/dist/needle-engine.min.js +1 -1
  7. package/dist/needle-engine.umd.cjs +1 -1
  8. package/lib/engine/engine_camera.d.ts +15 -2
  9. package/lib/engine/engine_camera.js +9 -2
  10. package/lib/engine/engine_camera.js.map +1 -1
  11. package/lib/engine/engine_context.d.ts +8 -2
  12. package/lib/engine/engine_context.js +21 -3
  13. package/lib/engine/engine_context.js.map +1 -1
  14. package/lib/engine/engine_create_objects.d.ts +3 -3
  15. package/lib/engine/engine_create_objects.js +5 -4
  16. package/lib/engine/engine_create_objects.js.map +1 -1
  17. package/lib/engine/extensions/NEEDLE_lighting_settings.js +5 -2
  18. package/lib/engine/extensions/NEEDLE_lighting_settings.js.map +1 -1
  19. package/lib/engine-components/Camera.d.ts +1 -1
  20. package/lib/engine-components/Camera.js.map +1 -1
  21. package/lib/engine-components/ContactShadows.d.ts +12 -2
  22. package/lib/engine-components/ContactShadows.js +24 -4
  23. package/lib/engine-components/ContactShadows.js.map +1 -1
  24. package/lib/engine-components/OrbitControls.js +4 -6
  25. package/lib/engine-components/OrbitControls.js.map +1 -1
  26. package/lib/engine-components/api.d.ts +1 -1
  27. package/package.json +2 -2
  28. package/src/engine/engine_camera.ts +15 -3
  29. package/src/engine/engine_context.ts +22 -4
  30. package/src/engine/engine_create_objects.ts +8 -7
  31. package/src/engine/extensions/NEEDLE_lighting_settings.ts +5 -2
  32. package/src/engine-components/Camera.ts +1 -1
  33. package/src/engine-components/ContactShadows.ts +27 -6
  34. package/src/engine-components/OrbitControls.ts +4 -11
  35. package/src/engine-components/api.ts +1 -1
package/README.md CHANGED
@@ -1,69 +1,75 @@
1
1
  # Needle Engine
2
2
 
3
- <!-- <img src="https://engine.needle.tools/docs/imgs/banner.webp" /> -->
4
-
5
- **[Needle Engine](https://needle.tools)** is a fast web engine for complex and simple 3D applications alike.
6
- It is flexible, extensible and has built-in support for collaboration and XR! It is built around the **glTF standard** for 3D assets and is using three.js under the hood - so all your existing knowledge applies.
7
-
8
- → 📑 [Documentation](https://docs.needle.tools)
9
- → 💎 [Samples](https://samples.needle.tools)
10
- → 🏓 [Changelog](https://github.com/needle-tools/needle-engine-support/releases)
11
-
12
- ## Features
13
- - Components System: Add your custom components with easy
14
- - WebXR support & iOS Quicklook support for interactive AR
15
- - Networking is built-in
16
- - Advanced PBR Rendering
17
- - Animate Everything
18
- - Animation Statemachines & Timeline Animations
19
- - Lightmaps
20
- - Physics
21
- - Postprocessing
22
- - Texture & Mesh LOD Generation
23
- - Progressive Texture and Mesh Loading
24
- *Higher resolution assets are loaded on demand*
25
- - Dynamic Content Loading & Multi-Scene support
26
- - Integrations for Unity or Blender
27
- - Commercial & Educational Licenses
28
- - [↪ more features](https://docs.needle.tools/features)
3
+ **Needle Engine** is a web engine for high quality 3D applications with performance in mind.
29
4
 
5
+ Built on three.js and the glTF standard, Needle Engine delivers flexible, extensible web experiences with built-in collaboration and XR support.
30
6
 
31
- <br />
7
+ ## Quick Links
8
+ 🏓 [Changelog](https://github.com/needle-tools/needle-engine-support/releases) • 📑 [Documentation](https://docs.needle.tools) • 🧠 [Sample Scenes](https://samples.needle.tools) • 💎 [Showcase](https://engine.needle.tools/samples/?overlay=showcase)
9
+
10
+ ## Key Features
11
+
12
+ **🎮 Development Experience**
13
+ - Component system with easy custom component creation
14
+ - Unity and Blender integrations for familiar workflows
15
+ - Multi-scene support with dynamic content loading
32
16
 
17
+ **🌐 Web & XR Ready**
18
+ - WebXR support for immersive experiences
19
+ - iOS QuickLook support for interactive AR
20
+ - Built-in networking and collaboration
33
21
 
22
+ **⚡ Performance Optimized**
23
+ - Progressive texture and mesh loading
24
+ - Automatic LOD generation for textures and meshes
25
+ - Advanced PBR rendering with lightmap support
26
+
27
+ **🎬 Animation & Effects**
28
+ - Animation state machines and timeline animations
29
+ - Physics simulation
30
+ - Post-processing effects
31
+ - Animate anything with ease
32
+
33
+ [→ See all features](https://docs.needle.tools/features)
34
34
 
35
35
  ## Editor Integrations
36
36
 
37
37
  **Powerful integrations for Unity and Blender** allow artists and developers to collaborate and manage web applications inside battle-tested 3d editors. Needle Engine integrations allow you to use editor features for exporting models, author materials, animate and sequence animations, bake lightmaps and more.
38
38
  - 🎲 [Download Unity Integration](https://engine.needle.tools/downloads/unity)
39
39
  - 🐵 [Download Blender Integration](https://engine.needle.tools/downloads/blender)
40
- - 📜 [Code only](https://engine.needle.tools/docs/three/)
41
-
40
+ - 📜 [Use with Code](https://engine.needle.tools/docs/three/)
42
41
 
43
42
  ## Getting Started
44
43
 
45
- Follow the [Getting Started Guide](https://docs.needle.tools/getting-started) to download and install Needle Engine or [try one of our samples](https://engine.needle.tools/samples) ⚡
44
+ **Quick Start with npm:**
45
+ ```bash
46
+ npm install @needle-tools/engine
47
+ ```
46
48
 
49
+ **Or use our Editor Integrations:** Follow the [Getting Started Guide](https://docs.needle.tools/getting-started) to download and install Needle Engine with Unity or Blender.
47
50
 
48
- ## Examples
49
-
50
- ### [Custom loading overlay & wait for LODs](https://lods-loading-overlay-z23hmxbz29h8vr.needle.run/) | [Code on Stackblitz](https://stackblitz.com/edit/needle-engine-wait-for-lods?file=README.md)
51
-
52
- ### [Motors & More Shop Example with React](https://reactshoppingcart-z23hmxbzcfkmf.needle.run/) | [Code on Stackblitz](https://stackblitz.com/edit/needle-react-shopping-cart-2)
51
+ **Explore Examples:** [Try our interactive samples](https://engine.needle.tools/samples) to see what's possible ⚡
53
52
 
54
- ### [Postprocessing Effects with custom Magnifier effect](https://antialiasing-and-postprocessing-zubcksz1o8daw.needle.run/) | [Code on Stackblitz](https://stackblitz.com/edit/needle-engine-postprocessing?file=README.md)
55
- [![](https://cdn.needle.tools/static/images/changelog/magnifier-postprocessing-example-thumbnail.jpg)](https://antialiasing-and-postprocessing-zubcksz1o8daw.needle.run/)
53
+ ---
56
54
 
57
- ### [AR Restaurant Example](https://ar-restaurant-example-zubcks1t14le.needle.run/) | [Code on Github](https://github.com/needle-engine/ar-restaurant-example)
55
+ *Available under commercial and educational licenses*
58
56
 
59
- ### [Camera Focus DIV Example 1](https://responsive-layout-z23hmxb22no6t.needle.run/) | [Code on Stackblitz](<https://stackblitz.com/edit/needle-engine-camera-focus-rect?file=src%2Fsidebar.ts,index.html,src%2Fmain.ts>)
60
- [![](https://cdn.needle.tools/static/images/changelog/4.8.8-focus-thumbnail.jpg)](https://responsive-layout-z23hmxb22no6t.needle.run/)
57
+ ## Examples
61
58
 
62
- ### [Camera Focus DIV Example 2](https://responsive-layout-click-example-z23hmxbzuyk6y.needle.run/) | [Code on Stackblitz](<https://stackblitz.com/edit/needle-engine-camera-focus-rect-click-to-move?file=index.html,src%2Fmain.ts>)
63
- [![](https://cdn.needle.tools/static/images/changelog/4.8.8-focus-2-thumbnail.jpg?)](https://responsive-layout-click-example-z23hmxbzuyk6y.needle.run/)
59
+ | Preview | Example | Description | Links |
60
+ |---------|---------|-------------|-------|
61
+ | [![](https://cdn.needle.tools/static/images/changelog/khr_animation_pointer-thumbnail.jpg?1)](https://khr-animation-pointer-zubcksz2dgy3k.needle.run/) | [Animate Anything](https://khr-animation-pointer-zubcksz2dgy3k.needle.run/) | Interactive animation system | [Code on Stackblitz](https://stackblitz.com/edit/needle-engine-animate-anything?file=src%2Fmain.ts) • [three.js Example](https://threejs.org/examples/?q=gltf#webgl_loader_gltf_animation_pointer) |
62
+ | [![](https://cdn.needle.tools/static/images/changelog/magnifier-postprocessing-example-thumbnail.jpg)](https://antialiasing-and-postprocessing-zubcksz1o8daw.needle.run/) | [Postprocessing Effects](https://antialiasing-and-postprocessing-zubcksz1o8daw.needle.run/) | Custom magnifier effect with post-processing | [Code on Stackblitz](https://stackblitz.com/edit/needle-engine-postprocessing) |
63
+ | [![](https://cdn.needle.tools/static/images/changelog/4.8.8-focus-thumbnail.jpg)](https://responsive-layout-z23hmxb22no6t.needle.run/) | [Camera Focus DIV 1](https://responsive-layout-z23hmxb22no6t.needle.run/) | Responsive layout with camera focus | [Code on Stackblitz](https://stackblitz.com/edit/needle-engine-camera-focus-rect?file=src%2Fsidebar.ts,index.html,src%2Fmain.ts) |
64
+ | [![](https://cdn.needle.tools/static/images/changelog/4.8.8-focus-2-thumbnail.jpg)](https://responsive-layout-click-example-z23hmxbzuyk6y.needle.run/) | [Camera Focus DIV 2](https://responsive-layout-click-example-z23hmxbzuyk6y.needle.run/) | Click-to-move camera focus example | [Code on Stackblitz](https://stackblitz.com/edit/needle-engine-camera-focus-rect-click-to-move?file=index.html,src%2Fmain.ts) |
65
+ | [![](https://cdn.needle.tools/static/images/changelog/fasthdr-thumbnail.jpg?1)](https://fasthdr-needle-engine-zubcks1li2iy.needle.run/) | [FastHDR Loading](https://fasthdr-needle-engine-zubcks1li2iy.needle.run/) | 10x faster than EXR, non-blocking, 95% less GPU memory | [Code on Stackblitz](https://stackblitz.com/edit/needle-fast-hdri-needle-engine) • [Learn more](https://cloud.needle.tools/hdris) |
66
+ | | [AR Restaurant](https://ar-restaurant-example-zubcks1t14le.needle.run/) | Interactive AR restaurant experience | [Code on Github](https://github.com/needle-engine/ar-restaurant-example) |
67
+ | | [Custom Loading Overlay](https://lods-loading-overlay-z23hmxbz29h8vr.needle.run/) | Wait for LODs with custom loading states | [Code on Stackblitz](https://stackblitz.com/edit/needle-engine-wait-for-lods) |
68
+ | | [React Shopping Cart](https://reactshoppingcart-z23hmxbzcfkmf.needle.run/) | E-commerce integration with React | [Code on Stackblitz](https://stackblitz.com/edit/needle-react-shopping-cart-2) |
64
69
 
70
+ <br/>
65
71
 
66
- 👋 Find more examples on [samples.needle.tools](https://samples.needle.tools/), [docs.needle.tools](https://docs.needle.tools) and in the [Needle Engine Stackblitz Collection](https://stackblitz.com/@marwie/collections/needle-engine)
72
+ 👋 More examples on [samples.needle.tools](https://samples.needle.tools/), [docs.needle.tools](https://docs.needle.tools) and in the [Needle Engine Stackblitz Collection](https://stackblitz.com/@marwie/collections/needle-engine)
67
73
 
68
74
  <br />
69
75
 
@@ -73,5 +79,4 @@ Follow the [Getting Started Guide](https://docs.needle.tools/getting-started) to
73
79
  [Twitter](https://twitter.com/NeedleTools) •
74
80
  [Discord](https://discord.needle.tools) •
75
81
  [Forum](https://forum.needle.tools) •
76
- [Youtube](https://www.youtube.com/@needle-tools)
77
-
82
+ [Youtube](https://www.youtube.com/@needle-tools)