@needle-tools/engine 4.13.0 → 4.13.1

package/lib/engine-components/ShadowCatcher.js

@@ -22,14 +22,66 @@ var ShadowMode;
     ShadowMode[ShadowMode["Occluder"] = 2] = "Occluder";
 })(ShadowMode || (ShadowMode = {}));
 /**
- * ShadowCatcher can be added to an Object3D to make it render shadows (or light) in the scene. It can also be used to create a shadow mask, or to occlude light.
- * If the GameObject is a Mesh, it will apply a shadow-catching material to it - otherwise it will create a quad with the shadow-catching material.
+ * ShadowCatcher renders real-time shadows cast by lights onto a mesh surface.
+ * Captures actual shadow data from the scene's lighting system (directional lights, point lights, spot lights).
  *
- * Note that ShadowCatcher meshes are not raycastable by default; if you want them to be raycastable, change the layers in `onEnable()`.
+ * If the GameObject is a Mesh, it applies a shadow-catching material to it.
+ * Otherwise, it creates a quad mesh with the shadow-catching material automatically.
  *
- * @summary Creates a shadow mask or a light occluder
+ * [![](https://cloud.needle.tools/-/media/pFXPchA4vynNKOjgG_KucQ.gif)](https://engine.needle.tools/samples/shadow-catcher/)
+ * *Additive ShadowCatcher mode with point light shadows*
+ *
+ * [![](https://cloud.needle.tools/-/media/oIWgEU49rEA0xJ2TrbzVlg.gif)](https://engine.needle.tools/samples/transmission/)
+ * *ShadowCatcher with directional light shadows*
+ *
+ * **Shadow Modes:**
+ * - `ShadowMask` - Only renders shadows (works best with directional lights)
+ * - `Additive` - Renders light additively (works best with point/spot lights)
+ * - `Occluder` - Occludes light without rendering shadows
+ *
+ * **ShadowCatcher vs ContactShadows:**
+ * - **ShadowCatcher**: Real-time shadows from actual lights. Accurate directional shadows that match light sources. Requires lights with shadows enabled. Updates every frame.
+ * - **{@link ContactShadows}**: Proximity-based ambient occlusion-style shadows. Extremely soft and diffuse, ideal for subtle grounding. Better performance, works without lights.
+ *
+ * **When to use ShadowCatcher:**
+ * - You need accurate shadows that match specific light directions
+ * - Scene has real-time lighting with shadow-casting lights
+ * - Shadows need to follow light attenuation and angles
+ * - AR/VR scenarios where light estimation is available
+ * - Hard or semi-hard shadow edges are desired
+ *
+ * **When to use ContactShadows instead:**
+ * - You want very soft, ambient occlusion-style ground shadows
+ * - Performance is critical (no per-frame shadow rendering)
+ * - Scene doesn't have shadow-casting lights
+ * - Product visualization or configurators (subtle grounding effect)
+ * - Soft, diffuse shadows are more visually appealing than accurate ones
+ *
+ * **Note:** ShadowCatcher meshes are not raycastable by default (layer 2). Change layers in `onEnable()` if raycasting is needed.
+ *
+ * @example Basic shadow catcher plane
+ * ```ts
+ * const plane = new Object3D();
+ * const catcher = addComponent(plane, ShadowCatcher);
+ * catcher.mode = ShadowMode.ShadowMask;
+ * catcher.shadowColor = new RGBAColor(0, 0, 0, 0.8);
+ * ```
+ *
+ * @example Apply to existing mesh
+ * ```ts
+ * const mesh = this.gameObject.getComponent(Mesh);
+ * const catcher = addComponent(mesh, ShadowCatcher);
+ * // The mesh will now catch shadows from scene lights
+ * ```
+ *
+ * @summary Renders real-time shadows from lights onto surfaces
  * @category Rendering
  * @group Components
+ * @see {@link ContactShadows} for proximity-based fake shadows (better performance)
+ * @see {@link Light} for shadow-casting light configuration
+ * @see {@link Renderer} for shadow receiving settings
+ * @link https://engine.needle.tools/samples/shadow-catcher/
+ * @link https://engine.needle.tools/samples/transmission/
  */
 export class ShadowCatcher extends Behaviour {
     //@type Needle.Engine.ShadowCatcher.Mode

package/lib/engine-components/ShadowCatcher.js.map

@@ -1 +1 @@
-{"version":3,"file":"ShadowCatcher.js","sourceRoot":"","sources":["../../src/engine-components/ShadowCatcher.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,gBAAgB,EAAY,IAAI,EAAE,iBAAiB,EAAE,oBAAoB,EAAC,cAAc,EAAE,MAAM,OAAO,CAAC;AAEjH,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,6CAA6C,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;;;;GAKG;AACH,IAAK,UAIJ;AAJD,WAAK,UAAU;IACX,uDAAc,CAAA;IACd,mDAAY,CAAA;IACZ,mDAAY,CAAA;AAChB,CAAC,EAJI,UAAU,KAAV,UAAU,QAId;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,aAAc,SAAQ,SAAS;IAExC,wCAAwC;IAExC,IAAI,GAAe,UAAU,CAAC,UAAU,CAAC;IAEzC,yBAAyB;IAEzB,WAAW,GAAc,IAAI,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAE3C,UAAU,CAAQ;IAE1B,gBAAgB;IAChB,KAAK;QACD,4CAA4C;QAC5C,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,YAAY,IAAI,CAAC,EAAE;YACpC,MAAM,IAAI,GAAG,WAAW,CAAC,eAAe,CAAC,aAAa,CAAC,IAAI,EAAE;gBACzD,IAAI,EAAE,eAAe;gBACrB,QAAQ,EAAE,IAAI,oBAAoB,CAAC;oBAC/B,uGAAuG;oBACvG,mHAAmH;oBACnH,KAAK,EAAE,QAAQ;oBACf,SAAS,EAAE,CAAC;oBACZ,SAAS,EAAE,CAAC;oBACZ,WAAW,EAAE,IAAI;iBACpB,CAAC;aACL,CAAC,CAAC;YACH,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;YAC1B,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAEpC,wCAAwC;YACxC,oCAAoC;YACpC,kCAAkC;YAClC,2CAA2C;YAE3C,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC1B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;SAC1B;aACI,IAAI,IAAI,CAAC,UAAU,YAAY,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE;YAClE,mDAAmD;YACnD,IAAI,CAAC,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YAC5D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;YAClC,yCAAyC;YACzC,IAAI,CAAC,UAAU,CAAC,aAAa,GAAG,IAAI,CAAC;SACxC;QAED,IAAG,CAAC,IAAI,CAAC,UAAU,EAAE;YACjB,OAAO,CAAC,IAAI,CAAC,yFAAyF,CAAC,CAAC;YACxG,OAAO;SACV;QAED,sCAAsC;QACtC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAE9B,QAAQ,IAAI,CAAC,IAAI,EAAE;YACf,KAAK,UAAU,CAAC,UAAU;gBACtB,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBAC3B,MAAM;YACV,KAAK,UAAU,CAAC,QAAQ;gBACpB,IAAI,CAAC,uBAAuB,EAAE,CAAC;gBAC/B,MAAM;YACV,KAAK,UAAU,CAAC,QAAQ;gBACpB,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAC7B,MAAM;SACb;IACL,CAAC;IAED,4EAA4E;IAC5E,iDAAiD;IACjD,mFAAmF;IACnF,0FAA0F;IAC1F,yDAAyD;IACzD,uBAAuB;QACnB,IAAI,CAAC,IAAI,CAAC,UAAU;YAAE,OAAO;QAE7B,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,QAAoB,CAAC;QACtD,QAAQ,CAAC,QAAQ,GAAG,gBAAgB,CAAC;QACrC,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QACpC,QAAQ,CAAC,eAAe,GAAG,CAAC,MAAM,EAAE,EAAE;YAClC,4GAA4G;YAC5G,sGAAsG;YACtG,qGAAqG;YACrG,wHAAwH;YACxH,yHAAyH;YAEzH,MAAM,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,4EAA4E,EAC9H;;;;;;;;;;aAUH,CAAC,CAAC;QACP,CAAC,CAAA;QACD,QAAQ,CAAC,QAAQ,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAClD,CAAC;IAED,oEAAoE;IACpE,+CAA+C;IAC/C,sCAAsC;IACtC,mBAAmB;QACf,IAAI,IAAI,CAAC,UAAU,EAAE;YACjB,IAAK,IAAI,CAAC,UAAU,CAAC,QAAqB,CAAC,IAAI,KAAK,gBAAgB,EAAE;gBAClE,MAAM,QAAQ,GAAG,IAAI,cAAc,EAAE,CAAC;gBACtC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC;gBAClC,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;gBAC1C,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;gBACpC,IAAI,CAAC,UAAU,CAAC,QAAQ,GAAG,QAAQ,CAAC;gBACpC,QAAQ,CAAC,QAAQ,CAAC,uBAAuB,GAAG,IAAI,CAAC;aACpD;iBACI;gBACD,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,QAA0B,CAAC;gBAC5D,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC;gBAClC,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;gBAC1C,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;gBACpC,QAAQ,CAAC,QAAQ,CAAC,uBAAuB,GAAG,IAAI,CAAC;aACpD;SACJ;IACL,CAAC;IAED,qBAAqB;QACjB,IAAI,IAAI,CAAC,UAAU,EAAE;YACjB,IAAI,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,QAAoB,CAAC;YACpD,IAAI,CAAC,QAAQ,EAAE;gBACX,MAAM,GAAG,GAAG,IAAI,iBAAiB,EAAE,CAAC;gBACpC,IAAI,CAAC,UAAU,CAAC,QAAQ,GAAG,GAAG,CAAC;gBAC/B,QAAQ,GAAG,GAAG,CAAC;aAClB;YACD,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC;YAC3B,QAAQ,CAAC,YAAY,GAAG,IAAI,CAAC;YAC7B,QAAQ,CAAC,UAAU,GAAG,KAAK,CAAC;YAC5B,IAAI,CAAC,UAAU,CAAC,WAAW,GAAG,CAAC,GAAG,CAAC;SACtC;IACL,CAAC;IAEO,oBAAoB,CAAC,QAAkB;QAC3C,IAAI,QAAQ,EAAE;YACV,QAAQ,CAAC,UAAU,GAAG,KAAK,CAAC;YAC5B,QAAQ,CAAC,YAAY,GAAG,KAAK,CAAC;SACjC;IACL,CAAC;CACJ;AA7IG;IADC,YAAY,EAAE;2CAC0B;AAIzC;IADC,YAAY,CAAC,SAAS,CAAC;kDAC2B"}
+{"version":3,"file":"ShadowCatcher.js","sourceRoot":"","sources":["../../src/engine-components/ShadowCatcher.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,gBAAgB,EAAY,IAAI,EAAE,iBAAiB,EAAE,oBAAoB,EAAC,cAAc,EAAE,MAAM,OAAO,CAAC;AAEjH,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,6CAA6C,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAK3C;;;;;GAKG;AACH,IAAK,UAIJ;AAJD,WAAK,UAAU;IACX,uDAAc,CAAA;IACd,mDAAY,CAAA;IACZ,mDAAY,CAAA;AAChB,CAAC,EAJI,UAAU,KAAV,UAAU,QAId;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH,MAAM,OAAO,aAAc,SAAQ,SAAS;IAExC,wCAAwC;IAExC,IAAI,GAAe,UAAU,CAAC,UAAU,CAAC;IAEzC,yBAAyB;IAEzB,WAAW,GAAc,IAAI,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAE3C,UAAU,CAAQ;IAE1B,gBAAgB;IAChB,KAAK;QACD,4CAA4C;QAC5C,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,YAAY,IAAI,CAAC,EAAE;YACpC,MAAM,IAAI,GAAG,WAAW,CAAC,eAAe,CAAC,aAAa,CAAC,IAAI,EAAE;gBACzD,IAAI,EAAE,eAAe;gBACrB,QAAQ,EAAE,IAAI,oBAAoB,CAAC;oBAC/B,uGAAuG;oBACvG,mHAAmH;oBACnH,KAAK,EAAE,QAAQ;oBACf,SAAS,EAAE,CAAC;oBACZ,SAAS,EAAE,CAAC;oBACZ,WAAW,EAAE,IAAI;iBACpB,CAAC;aACL,CAAC,CAAC;YACH,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;YAC1B,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAEpC,wCAAwC;YACxC,oCAAoC;YACpC,kCAAkC;YAClC,2CAA2C;YAE3C,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC1B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;SAC1B;aACI,IAAI,IAAI,CAAC,UAAU,YAAY,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE;YAClE,mDAAmD;YACnD,IAAI,CAAC,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YAC5D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;YAClC,yCAAyC;YACzC,IAAI,CAAC,UAAU,CAAC,aAAa,GAAG,IAAI,CAAC;SACxC;QAED,IAAG,CAAC,IAAI,CAAC,UAAU,EAAE;YACjB,OAAO,CAAC,IAAI,CAAC,yFAAyF,CAAC,CAAC;YACxG,OAAO;SACV;QAED,sCAAsC;QACtC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAE9B,QAAQ,IAAI,CAAC,IAAI,EAAE;YACf,KAAK,UAAU,CAAC,UAAU;gBACtB,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBAC3B,MAAM;YACV,KAAK,UAAU,CAAC,QAAQ;gBACpB,IAAI,CAAC,uBAAuB,EAAE,CAAC;gBAC/B,MAAM;YACV,KAAK,UAAU,CAAC,QAAQ;gBACpB,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAC7B,MAAM;SACb;IACL,CAAC;IAED,4EAA4E;IAC5E,iDAAiD;IACjD,mFAAmF;IACnF,0FAA0F;IAC1F,yDAAyD;IACzD,uBAAuB;QACnB,IAAI,CAAC,IAAI,CAAC,UAAU;YAAE,OAAO;QAE7B,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,QAAoB,CAAC;QACtD,QAAQ,CAAC,QAAQ,GAAG,gBAAgB,CAAC;QACrC,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QACpC,QAAQ,CAAC,eAAe,GAAG,CAAC,MAAM,EAAE,EAAE;YAClC,4GAA4G;YAC5G,sGAAsG;YACtG,qGAAqG;YACrG,wHAAwH;YACxH,yHAAyH;YAEzH,MAAM,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,4EAA4E,EAC9H;;;;;;;;;;aAUH,CAAC,CAAC;QACP,CAAC,CAAA;QACD,QAAQ,CAAC,QAAQ,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAClD,CAAC;IAED,oEAAoE;IACpE,+CAA+C;IAC/C,sCAAsC;IACtC,mBAAmB;QACf,IAAI,IAAI,CAAC,UAAU,EAAE;YACjB,IAAK,IAAI,CAAC,UAAU,CAAC,QAAqB,CAAC,IAAI,KAAK,gBAAgB,EAAE;gBAClE,MAAM,QAAQ,GAAG,IAAI,cAAc,EAAE,CAAC;gBACtC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC;gBAClC,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;gBAC1C,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;gBACpC,IAAI,CAAC,UAAU,CAAC,QAAQ,GAAG,QAAQ,CAAC;gBACpC,QAAQ,CAAC,QAAQ,CAAC,uBAAuB,GAAG,IAAI,CAAC;aACpD;iBACI;gBACD,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,QAA0B,CAAC;gBAC5D,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC;gBAClC,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;gBAC1C,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;gBACpC,QAAQ,CAAC,QAAQ,CAAC,uBAAuB,GAAG,IAAI,CAAC;aACpD;SACJ;IACL,CAAC;IAED,qBAAqB;QACjB,IAAI,IAAI,CAAC,UAAU,EAAE;YACjB,IAAI,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,QAAoB,CAAC;YACpD,IAAI,CAAC,QAAQ,EAAE;gBACX,MAAM,GAAG,GAAG,IAAI,iBAAiB,EAAE,CAAC;gBACpC,IAAI,CAAC,UAAU,CAAC,QAAQ,GAAG,GAAG,CAAC;gBAC/B,QAAQ,GAAG,GAAG,CAAC;aAClB;YACD,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC;YAC3B,QAAQ,CAAC,YAAY,GAAG,IAAI,CAAC;YAC7B,QAAQ,CAAC,UAAU,GAAG,KAAK,CAAC;YAC5B,IAAI,CAAC,UAAU,CAAC,WAAW,GAAG,CAAC,GAAG,CAAC;SACtC;IACL,CAAC;IAEO,oBAAoB,CAAC,QAAkB;QAC3C,IAAI,QAAQ,EAAE;YACV,QAAQ,CAAC,UAAU,GAAG,KAAK,CAAC;YAC5B,QAAQ,CAAC,YAAY,GAAG,KAAK,CAAC;SACjC;IACL,CAAC;CACJ;AA7IG;IADC,YAAY,EAAE;2CAC0B;AAIzC;IADC,YAAY,CAAC,SAAS,CAAC;kDAC2B"}

package/lib/engine-components/Skybox.d.ts

@@ -4,20 +4,52 @@ type AnyString = string & {
     _brand?: never;
 };
 /**
- * RemoteSkybox is a component that allows you to set the skybox or environment texture of a scene from a URL, a local file or a static skybox name.
- * It supports .hdr, .exr, .jpg, .png files.
+ * The [RemoteSkybox](https://engine.needle.tools/docs/api/RemoteSkybox) component allows you to set the skybox or environment texture of a scene from a URL, a local file or a static skybox name.
+ * It supports .hdr, .exr, .jpg, .png, and .ktx2 files.
+ *
+ * **HTML Attributes:**
+ * You can control skybox and environment from HTML using `<needle-engine>` attributes:
+ * - `background-image`: Sets the scene background/skybox image
+ * - `environment-image`: Sets the scene environment map (for reflections and lighting)
+ *
+ * These attributes accept URLs or magic skybox names (see examples below).
+ *
+ * **Magic Skybox Names:**
+ * Built-in optimized skyboxes hosted on Needle CDN:
+ * - `"studio"` - Neutral studio lighting (default)
+ * - `"blurred-skybox"` - Blurred environment
+ * - `"quicklook"` - Apple QuickLook object mode style
+ * - `"quicklook-ar"` - Apple QuickLook AR mode style
  *
  * ### Events
  * - `dropped-unknown-url`: Emitted when a file is dropped on the scene. The event detail contains the sender, the url and a function to apply the url.
  *
- * @example adding a skybox
+ * @example Using HTML attributes
+ * ```html
+ * <needle-engine
+ *   background-image="https://example.com/skybox.hdr"
+ *   environment-image="studio">
+ * </needle-engine>
+ * ```
+ *
+ * @example Using magic skybox names
+ * ```html
+ * <needle-engine background-image="studio"></needle-engine>
+ * <needle-engine environment-image="quicklook"></needle-engine>
+ * ```
+ *
+ * @example Adding via code
  * ```ts
- * GameObject.addComponent(gameObject, Skybox, { url: "https://example.com/skybox.hdr", background: true, environment: true });
+ * GameObject.addComponent(gameObject, RemoteSkybox, {
+ *   url: "https://example.com/skybox.hdr",
+ *   background: true,
+ *   environment: true
+ * });
  * ```
  *
- * @example handle custom url
+ * @example Handle custom dropped URL
  * ```ts
- * const skybox = GameObject.addComponent(gameObject, Skybox);
+ * const skybox = GameObject.addComponent(gameObject, RemoteSkybox);
  * skybox.addEventListener("dropped-unknown-url", (evt) => {
  *    let url = evt.detail.url;
  *    console.log("User dropped file", url);
@@ -28,14 +60,18 @@ type AnyString = string & {
  * });
  * ```
  *
- * @example update skybox url
+ * @example Update skybox at runtime
  * ```ts
  * skybox.setSkybox("https://example.com/skybox.hdr");
+ * // Or use a magic name:
+ * skybox.setSkybox("studio");
  * ```
  *
  * @summary Sets the skybox or environment texture of a scene
  * @category Rendering
  * @group Components
+ * @see {@link Camera} for clearFlags and background control
+ * @link https://engine.needle.tools/docs/html.html#needle-engine-element
  */
 export declare class RemoteSkybox extends Behaviour {
     /**

package/lib/engine-components/Skybox.js

@@ -109,20 +109,52 @@ ContextRegistry.registerCallback(ContextEvent.ContextCreationStart, () => {
     });
 });
 /**
- * RemoteSkybox is a component that allows you to set the skybox or environment texture of a scene from a URL, a local file or a static skybox name.
- * It supports .hdr, .exr, .jpg, .png files.
+ * The [RemoteSkybox](https://engine.needle.tools/docs/api/RemoteSkybox) component allows you to set the skybox or environment texture of a scene from a URL, a local file or a static skybox name.
+ * It supports .hdr, .exr, .jpg, .png, and .ktx2 files.
+ *
+ * **HTML Attributes:**
+ * You can control skybox and environment from HTML using `<needle-engine>` attributes:
+ * - `background-image`: Sets the scene background/skybox image
+ * - `environment-image`: Sets the scene environment map (for reflections and lighting)
+ *
+ * These attributes accept URLs or magic skybox names (see examples below).
+ *
+ * **Magic Skybox Names:**
+ * Built-in optimized skyboxes hosted on Needle CDN:
+ * - `"studio"` - Neutral studio lighting (default)
+ * - `"blurred-skybox"` - Blurred environment
+ * - `"quicklook"` - Apple QuickLook object mode style
+ * - `"quicklook-ar"` - Apple QuickLook AR mode style
  *
  * ### Events
  * - `dropped-unknown-url`: Emitted when a file is dropped on the scene. The event detail contains the sender, the url and a function to apply the url.
  *
- * @example adding a skybox
+ * @example Using HTML attributes
+ * ```html
+ * <needle-engine
+ *   background-image="https://example.com/skybox.hdr"
+ *   environment-image="studio">
+ * </needle-engine>
+ * ```
+ *
+ * @example Using magic skybox names
+ * ```html
+ * <needle-engine background-image="studio"></needle-engine>
+ * <needle-engine environment-image="quicklook"></needle-engine>
+ * ```
+ *
+ * @example Adding via code
  * ```ts
- * GameObject.addComponent(gameObject, Skybox, { url: "https://example.com/skybox.hdr", background: true, environment: true });
+ * GameObject.addComponent(gameObject, RemoteSkybox, {
+ *   url: "https://example.com/skybox.hdr",
+ *   background: true,
+ *   environment: true
+ * });
  * ```
  *
- * @example handle custom url
+ * @example Handle custom dropped URL
  * ```ts
- * const skybox = GameObject.addComponent(gameObject, Skybox);
+ * const skybox = GameObject.addComponent(gameObject, RemoteSkybox);
  * skybox.addEventListener("dropped-unknown-url", (evt) => {
  *    let url = evt.detail.url;
  *    console.log("User dropped file", url);
@@ -133,14 +165,18 @@ ContextRegistry.registerCallback(ContextEvent.ContextCreationStart, () => {
  * });
  * ```
  *
- * @example update skybox url
+ * @example Update skybox at runtime
  * ```ts
  * skybox.setSkybox("https://example.com/skybox.hdr");
+ * // Or use a magic name:
+ * skybox.setSkybox("studio");
  * ```
  *
  * @summary Sets the skybox or environment texture of a scene
  * @category Rendering
  * @group Components
+ * @see {@link Camera} for clearFlags and background control
+ * @link https://engine.needle.tools/docs/html.html#needle-engine-element
  */
 export class RemoteSkybox extends Behaviour {
     /**

package/lib/engine-components/Skybox.js.map

@@ -1 +1 @@
-{"version":3,"file":"Skybox.js","sourceRoot":"","sources":["../../src/engine-components/Skybox.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,uBAAuB,EAAE,gCAAgC,EAAW,MAAM,OAAO,CAAA;AAE9H,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AACrF,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,6CAA6C,CAAC;AAE3E,OAAO,EAAE,0BAA0B,EAAE,QAAQ,EAAE,6BAA6B,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAC5H,OAAO,EAAE,2BAA2B,EAAE,MAAM,iDAAiD,CAAC;AAC9F,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAEvD,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC;AAEtC,2BAA2B,CAAC,kBAAkB,CAAC,CAAC;AAChD,2BAA2B,CAAC,mBAAmB,CAAC,CAAC;AAIjD,MAAM,gBAAgB,GAA8D;IAChF,QAAQ,EAAE;QACN,GAAG,EAAE,gFAAgF;QACrF,OAAO,EAAE,sFAAsF;KAClG;IACD,gBAAgB,EAAE;QACd,GAAG,EAAE,2EAA2E;QAChF,OAAO,EAAE,iFAAiF;KAC7F;IACD,cAAc,EAAE;QACZ,GAAG,EAAE,6EAA6E;QAClF,OAAO,EAAE,mFAAmF;KAC/F;IACD,WAAW,EAAE;QACT,GAAG,EAAE,iFAAiF;QACtF,OAAO,EAAE,uFAAuF;KACnG;CACK,CAAC;AAIX,SAAS,2BAA2B,CAAC,OAAiB,EAAE,GAAW,EAAE,MAAe,EAAE,WAAoB,EAAE,SAAmD;IAE3J,oFAAoF;IACpF,IAAI,GAAG,KAAK,aAAa,IAAI,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,IAAI,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE;QACzE,OAAO,CAAC,IAAI,CAAC,0BAA0B,SAAS,WAAW,GAAG,kDAAkD,CAAC,CAAC;QAClH,OAAO,IAAI,CAAC;KACf;IAED,MAAM,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;IAClC,MAAM,CAAC,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;IAClC,MAAM,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,MAAM,CAAC,eAAe,GAAG,KAAK,CAAC;IAC/B,MAAM,CAAC,UAAU,GAAG,MAAM,CAAC;IAC3B,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC/C,MAAM,UAAU,GAAG,QAAQ,CAAC,EAAE;QAC1B,IAAI,KAAK;YAAE,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;QAC1D,IAAI,QAAQ,EAAE;YACV,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;gBAC9B,OAAO,CAAC,IAAI,CAAC,8BAA8B,GAAG,SAAS,CAAC,CAAC;gBACzD,OAAO;aACV;YACD,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;SAC9B;aACI;YACD,IAAI,MAAM,CAAC,QAAQ,EAAE;gBACjB,IAAI,WAAW,EAAE;oBACb,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,wBAAwB,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;wBAClE,OAAO,CAAC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC;qBACpC;iBACJ;gBACD,IAAI,MAAM,EAAE;oBACR,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;oBAC/D,OAAO,CAAC,KAAK,CAAC,UAAU,GAAG,MAAM,CAAC;iBACrC;aACJ;SACJ;IACL,CAAC,CAAC;IACF,0BAA0B,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;IACtE,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,GAAG,EAAE;QACpC,IAAI,KAAK;YAAE,OAAO,CAAC,GAAG,CAAC,mCAAmC,EAAE,SAAS,CAAC,CAAC;QACvE,6BAA6B,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;IAC7E,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;AACjC,CAAC;AAED,MAAM,QAAQ,GAAG,IAAI,KAAK,EAAgB,CAAC;AAC3C,eAAe,CAAC,gBAAgB,CAAC,YAAY,CAAC,oBAAoB,EAAE,CAAC,IAAI,EAAE,EAAE;IACzE,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;IAC7B,MAAM,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;IAC5E,MAAM,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC;IAE9E,IAAI,eAAe,EAAE;QACjB,IAAI,KAAK;YAAE,OAAO,CAAC,GAAG,CAAC,2CAA2C,GAAG,eAAe,CAAC,CAAC;QACtF,wGAAwG;QACxG,uFAAuF;QACvF,iKAAiK;QACjK,MAAM,OAAO,GAAG,2BAA2B,CAAC,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,EAAE,kBAAkB,CAAC,CAAC;QACvG,IAAI,OAAO;YAAE,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;KACvC;IACD,IAAI,gBAAgB,EAAE;QAClB,IAAI,KAAK;YAAE,OAAO,CAAC,GAAG,CAAC,4CAA4C,GAAG,gBAAgB,CAAC,CAAC;QACxF,MAAM,OAAO,GAAG,2BAA2B,CAAC,OAAO,EAAE,gBAAgB,EAAE,KAAK,EAAE,IAAI,EAAE,mBAAmB,CAAC,CAAC;QACzG,IAAI,OAAO;YAAE,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;KACvC;AACL,CAAC,CAAC,CAAC;AACH,eAAe,CAAC,gBAAgB,CAAC,YAAY,CAAC,oBAAoB,EAAE,GAAG,EAAE;IACrE,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE;QACtC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;IACxB,CAAC,CAAC,CAAA;AACN,CAAC,CAAC,CAAC;AAIH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,OAAO,YAAa,SAAQ,SAAS;IAEvC;;;;;;;;;;;;OAYG;IAGH,GAAG,GAAgC,QAAQ,CAAC;IAE5C;;;OAGG;IAEH,SAAS,GAAY,IAAI,CAAC;IAE1B;;;OAGG;IAEH,UAAU,GAAY,IAAI,CAAC;IAE3B;;;OAGG;IAEH,WAAW,GAAY,IAAI,CAAC;IAE5B;;;OAGG;IAEH,eAAe,GAAY,IAAI,CAAC;IAExB,QAAQ,CAAU;IAClB,sBAAsB,CAAW;IACjC,gBAAgB,GAAmB,IAAI,CAAC;IACxC,eAAe,GAAQ,IAAI,CAAC;IAEpC,gBAAgB;IAChB,QAAQ;QACJ,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzB,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAC9B,CAAC;IAED,gBAAgB;IAChB,SAAS;QACL,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,KAAK,IAAI,CAAC,sBAAsB,EAAE;YAChE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC;YACvD,IAAI,CAAC,MAAM,CAAC,6BAA6B,CAAC,IAAI,CAAC,OAAO,CAAC;gBACnD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC;YACzD,IAAI,CAAC,sBAAsB,GAAG,SAAS,CAAC;SAC3C;QACD,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,6DAA6D;QAC7D,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,eAAe,EAAE,CAAC;IACxD,CAAC;IAEO,mBAAmB;QACvB,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,GAAG,EAAE;YAClC,8CAA8C;YAC9C,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;gBAChC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aAC5B;iBACI,IAAI,KAAK,EAAE;gBACZ,OAAO,CAAC,IAAI,CAAC,qCAAqC,IAAI,CAAC,GAAG,6FAA6F,CAAC,CAAC;aAC5J;SACJ;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CAAC,GAAmD,EAAE,IAAa;QAC9E,IAAI,CAAC,IAAI,CAAC,gBAAgB;YAAE,OAAO,KAAK,CAAC;QAEzC,GAAG,GAAG,uBAAuB,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAEtE,IAAI,CAAC,GAAG;YAAE,OAAO,KAAK,CAAC;QAEvB,IAAI,KAAK,GAAG,CAAC;QAEb,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE;YAChC,OAAO,CAAC,IAAI,CAAC,oCAAoC,GAAG,IAAI,GAAG,QAAQ,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,EAAE,IAAI,IAAI,SAAS,CAAC,CAAC,CAAC;SAC5H;QAED,IAAI,KAAK;YAAE,OAAO,CAAC,GAAG,CAAC,wBAAwB,GAAG,GAAG,CAAC,CAAC;QAEvD,IAAI,IAAI,CAAC,QAAQ,KAAK,GAAG,IAAI,IAAI,CAAC,sBAAsB,EAAE;YACtD,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,OAAO,IAAI,CAAC;SACf;aACI;YACD,IAAI,CAAC,sBAAsB,EAAE,OAAO,EAAE,CAAC;YACvC,IAAI,CAAC,sBAAsB,GAAG,SAAS,CAAC;SAC3C;QACD,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC;QAEpB,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC5D,IAAI,CAAC,OAAO,EAAE;YACV,IAAI,KAAK;gBAAE,OAAO,CAAC,IAAI,CAAC,+CAA+C,EAAE,GAAG,CAAC,CAAC;YAC9E,OAAO,KAAK,CAAC;SAChB;QACD,2CAA2C;QAC3C,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE;YACjC,IAAI,KAAK;gBAAE,OAAO,CAAC,IAAI,CAAC,kDAAkD,CAAC,CAAC;YAC5E,OAAO,KAAK,CAAC;SAChB;QACD,6CAA6C;QAC7C,IAAI,IAAI,CAAC,QAAQ,KAAK,GAAG,EAAE;YACvB,IAAI,KAAK;gBAAE,OAAO,CAAC,IAAI,CAAC,qEAAqE,CAAC,CAAC;YAC/F,OAAO,KAAK,CAAC,CAAC,4BAA4B;SAC7C;QACD,yBAAyB;QACzB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,sBAAsB,GAAG,OAAO,CAAC;QACtC,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,OAAO,IAAI,CAAC;IAChB,CAAC;IAGO,KAAK;QACT,MAAM,MAAM,GAAG,IAAI,CAAC,sBAAsB,CAAC;QAC3C,IAAI,CAAC,MAAM;YAAE,OAAO;QAEpB,IAAI,CAAC,MAAM,YAAY,WAAW,IAAI,MAAM,YAAY,qBAAqB,CAAC,IAAI,MAAM,CAAC,OAAO,IAAI,uBAAuB,EAAE;YACzH,gBAAgB;SACnB;aACI;YACD,MAAM,CAAC,OAAO,GAAG,gCAAgC,CAAC;YAClD,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;SAC7B;QAED,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO;QAC3B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACf,OAAO,CAAC,IAAI,CAAC,gEAAgE,CAAC,CAAC;YAC/E,OAAO;SACV;QAED,gBAAgB;QAChB,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,KAAK,MAAM;YACxC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC;QACzD,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,KAAK,MAAM;YACzC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC;QAC3D,IAAI,KAAK;YAAE,OAAO,CAAC,GAAG,CAAC,oBAAoB,GAAG,CAAC,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,6BAA6B,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QACxQ,IAAI,IAAI,CAAC,WAAW;YAChB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,GAAG,MAAM,CAAC;QAC5C,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,MAAM,CAAC,6BAA6B,CAAC,IAAI,CAAC,OAAO,CAAC;YACtE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,GAAG,MAAM,CAAC;QAC3C,IAAI,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,oBAAoB,KAAK,SAAS;YACpE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,oBAAoB,GAAG,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC;IACxG,CAAC;IAGgB,cAAc,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC7C,iBAAiB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAEhF,eAAe,CAAC,GAAW;QAC/B,OAAO,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IACnE,CAAC;IAEO,kBAAkB,CAAC,GAAW;QAClC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,iBAAiB,EAAE;YACvC,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAAE,OAAO,IAAI,CAAC;SACvC;QACD,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,cAAc,EAAE;YACxC,IAAI,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC;gBAAE,OAAO,IAAI,CAAC;SAC7C;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAIO,kBAAkB;QACtB,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC3E,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAClE,CAAC;IAEO,oBAAoB;QACxB,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC9E,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACrE,CAAC;IAEO,eAAe,GAAG,CAAC,CAAY,EAAE,EAAE;QACvC,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,OAAO;QAC5B,IAAI,CAAC,CAAC,CAAC,YAAY;YAAE,OAAO;QAC5B,KAAK,MAAM,IAAI,IAAI,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE;YACrC,kDAAkD;YAClD,0CAA0C;YAC1C,yCAAyC;YACzC,6BAA6B;YAC7B,IAAI,IAAI,KAAK,eAAe,IAAI,IAAI,KAAK,OAAO,EAAE;gBAC9C,CAAC,CAAC,cAAc,EAAE,CAAC;aACtB;SACJ;IACL,CAAC,CAAC;IAEM,MAAM,GAAG,CAAC,CAAY,EAAE,EAAE;QAC9B,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,OAAO;QAC5B,IAAI,CAAC,CAAC,CAAC,YAAY;YAAE,OAAO;QAC5B,KAAK,MAAM,IAAI,IAAI,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE;YACrC,IAAI,KAAK;gBAAE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC7B,IAAI,IAAI,KAAK,eAAe,EAAE;gBAC1B,MAAM,GAAG,GAAG,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBACzC,IAAI,KAAK;oBAAE,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBAClC,IAAI,IAAI,GAAG,IAAI,MAAM,CAAC,iDAAiD,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC;gBACjG,IAAI,CAAC,IAAI,EAAE;oBACP,IAAI,GAAG,IAAI,MAAM,CAAC,gCAAgC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC;iBAC/E;gBACD,IAAI,KAAK;oBAAE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC7B,IAAI,IAAI,EAAE;oBACN,MAAM,SAAS,GAAG,uDAAuD,GAAG,IAAI,GAAG,SAAS,CAAC;oBAC7F,OAAO,CAAC,GAAG,CAAC,4CAA4C,SAAS,EAAE,CAAC,CAAC;oBACrE,CAAC,CAAC,cAAc,EAAE,CAAC;oBACnB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;oBAC1B,MAAM;iBACT;qBACI,IAAI,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE;oBACnC,OAAO,CAAC,GAAG,CAAC,2CAA2C,GAAG,GAAG,CAAC,CAAC;oBAC/D,CAAC,CAAC,cAAc,EAAE,CAAC;oBACnB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;oBACpB,MAAM;iBACT;qBACI;oBAED,OAAO,CAAC,IAAI,CAAC,8BAA8B,GAAG,kGAAkG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBACtL,mFAAmF;oBACnF,MAAM,GAAG,GAAG,IAAI,WAAW,CAAC,qBAAqB,EAAE;wBAC/C,MAAM,EAAE;4BACJ,MAAM,EAAE,IAAI;4BACZ,KAAK,EAAE,CAAC;4BACR,GAAG;4BACH,KAAK,EAAE,CAAC,GAAW,EAAE,EAAE;gCACnB,CAAC,CAAC,cAAc,EAAE,CAAC;gCACnB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;4BACxB,CAAC;yBACJ;qBACJ,CAAC,CAAC;oBACH,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;iBAC3B;aACJ;iBACI,IAAI,IAAI,IAAI,OAAO,EAAE;gBACtB,MAAM,IAAI,GAAG,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBAC1C,IAAI,KAAK;oBAAE,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACnC,IAAI,CAAC,IAAI;oBAAE,SAAS;gBACpB,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;oBACrC,OAAO,CAAC,IAAI,CAAC,0BAA0B,IAAI,CAAC,IAAI,4CAA4C,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;oBACjI,OAAO;iBACV;gBACD,2DAA2D;gBAC3D,qCAAqC;gBACrC,6CAA6C;gBAC7C,0BAA0B;gBAC1B,sCAAsC;gBACtC,IAAI;gBACJ,QAAQ;gBACR;oBACI,CAAC,CAAC,cAAc,EAAE,CAAC;oBACnB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBAC7B;gBACD,MAAM;aACT;SACJ;IACL,CAAC,CAAC;CACL;AAxQG;IAFC,SAAS,CAAC,YAAY,CAAC,SAAS,CAAC,mBAAmB,CAAC;IACrD,YAAY,CAAC,GAAG,CAAC;yCAC0B;AAO5C;IADC,YAAY,EAAE;+CACW;AAO1B;IADC,YAAY,EAAE;gDACY;AAO3B;IADC,YAAY,EAAE;iDACa;AAO5B;IADC,YAAY,EAAE;qDACiB;AAgPpC,SAAS,uBAAuB,CAAC,GAA8B,EAAE,WAAoB,EAAE,UAAmB;IAEtG,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IAEnD,MAAM,SAAS,GAAG,WAAW,IAAI,CAAC,UAAU,CAAC;IAE7C,MAAM,KAAK,GAAG,gBAAgB,CAAC,GAAG,CAAC,WAAW,EAAqB,CAAC,CAAC;IACrE,IAAI,KAAK,EAAE;QACP,OAAO,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC;KAChD;SACI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,EAAE,MAAM,IAAI,CAAC,gBAAgB,EAAE,IAAI,KAAK,CAAC,EAAE;QAC9E,MAAM,WAAW,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;QACvJ,IAAG,WAAW,EAAE;YACZ,OAAO,CAAC,IAAI,CAAC,4CAA4C,GAAG,uBAAuB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACrJ;KACJ;IAED,OAAO,GAAG,CAAC;AACf,CAAC"}
+{"version":3,"file":"Skybox.js","sourceRoot":"","sources":["../../src/engine-components/Skybox.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,uBAAuB,EAAE,gCAAgC,EAAW,MAAM,OAAO,CAAA;AAE9H,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AACrF,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,6CAA6C,CAAC;AAE3E,OAAO,EAAE,0BAA0B,EAAE,QAAQ,EAAE,6BAA6B,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAC5H,OAAO,EAAE,2BAA2B,EAAE,MAAM,iDAAiD,CAAC;AAC9F,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAEvD,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC;AAEtC,2BAA2B,CAAC,kBAAkB,CAAC,CAAC;AAChD,2BAA2B,CAAC,mBAAmB,CAAC,CAAC;AAIjD,MAAM,gBAAgB,GAA8D;IAChF,QAAQ,EAAE;QACN,GAAG,EAAE,gFAAgF;QACrF,OAAO,EAAE,sFAAsF;KAClG;IACD,gBAAgB,EAAE;QACd,GAAG,EAAE,2EAA2E;QAChF,OAAO,EAAE,iFAAiF;KAC7F;IACD,cAAc,EAAE;QACZ,GAAG,EAAE,6EAA6E;QAClF,OAAO,EAAE,mFAAmF;KAC/F;IACD,WAAW,EAAE;QACT,GAAG,EAAE,iFAAiF;QACtF,OAAO,EAAE,uFAAuF;KACnG;CACK,CAAC;AAIX,SAAS,2BAA2B,CAAC,OAAiB,EAAE,GAAW,EAAE,MAAe,EAAE,WAAoB,EAAE,SAAmD;IAE3J,oFAAoF;IACpF,IAAI,GAAG,KAAK,aAAa,IAAI,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,IAAI,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE;QACzE,OAAO,CAAC,IAAI,CAAC,0BAA0B,SAAS,WAAW,GAAG,kDAAkD,CAAC,CAAC;QAClH,OAAO,IAAI,CAAC;KACf;IAED,MAAM,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;IAClC,MAAM,CAAC,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;IAClC,MAAM,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,MAAM,CAAC,eAAe,GAAG,KAAK,CAAC;IAC/B,MAAM,CAAC,UAAU,GAAG,MAAM,CAAC;IAC3B,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC/C,MAAM,UAAU,GAAG,QAAQ,CAAC,EAAE;QAC1B,IAAI,KAAK;YAAE,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;QAC1D,IAAI,QAAQ,EAAE;YACV,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;gBAC9B,OAAO,CAAC,IAAI,CAAC,8BAA8B,GAAG,SAAS,CAAC,CAAC;gBACzD,OAAO;aACV;YACD,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;SAC9B;aACI;YACD,IAAI,MAAM,CAAC,QAAQ,EAAE;gBACjB,IAAI,WAAW,EAAE;oBACb,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,wBAAwB,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;wBAClE,OAAO,CAAC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC;qBACpC;iBACJ;gBACD,IAAI,MAAM,EAAE;oBACR,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;oBAC/D,OAAO,CAAC,KAAK,CAAC,UAAU,GAAG,MAAM,CAAC;iBACrC;aACJ;SACJ;IACL,CAAC,CAAC;IACF,0BAA0B,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;IACtE,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,GAAG,EAAE;QACpC,IAAI,KAAK;YAAE,OAAO,CAAC,GAAG,CAAC,mCAAmC,EAAE,SAAS,CAAC,CAAC;QACvE,6BAA6B,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;IAC7E,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;AACjC,CAAC;AAED,MAAM,QAAQ,GAAG,IAAI,KAAK,EAAgB,CAAC;AAC3C,eAAe,CAAC,gBAAgB,CAAC,YAAY,CAAC,oBAAoB,EAAE,CAAC,IAAI,EAAE,EAAE;IACzE,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;IAC7B,MAAM,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;IAC5E,MAAM,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC;IAE9E,IAAI,eAAe,EAAE;QACjB,IAAI,KAAK;YAAE,OAAO,CAAC,GAAG,CAAC,2CAA2C,GAAG,eAAe,CAAC,CAAC;QACtF,wGAAwG;QACxG,uFAAuF;QACvF,iKAAiK;QACjK,MAAM,OAAO,GAAG,2BAA2B,CAAC,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,EAAE,kBAAkB,CAAC,CAAC;QACvG,IAAI,OAAO;YAAE,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;KACvC;IACD,IAAI,gBAAgB,EAAE;QAClB,IAAI,KAAK;YAAE,OAAO,CAAC,GAAG,CAAC,4CAA4C,GAAG,gBAAgB,CAAC,CAAC;QACxF,MAAM,OAAO,GAAG,2BAA2B,CAAC,OAAO,EAAE,gBAAgB,EAAE,KAAK,EAAE,IAAI,EAAE,mBAAmB,CAAC,CAAC;QACzG,IAAI,OAAO;YAAE,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;KACvC;AACL,CAAC,CAAC,CAAC;AACH,eAAe,CAAC,gBAAgB,CAAC,YAAY,CAAC,oBAAoB,EAAE,GAAG,EAAE;IACrE,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE;QACtC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;IACxB,CAAC,CAAC,CAAA;AACN,CAAC,CAAC,CAAC;AAIH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqEG;AACH,MAAM,OAAO,YAAa,SAAQ,SAAS;IAEvC;;;;;;;;;;;;OAYG;IAGH,GAAG,GAAgC,QAAQ,CAAC;IAE5C;;;OAGG;IAEH,SAAS,GAAY,IAAI,CAAC;IAE1B;;;OAGG;IAEH,UAAU,GAAY,IAAI,CAAC;IAE3B;;;OAGG;IAEH,WAAW,GAAY,IAAI,CAAC;IAE5B;;;OAGG;IAEH,eAAe,GAAY,IAAI,CAAC;IAExB,QAAQ,CAAU;IAClB,sBAAsB,CAAW;IACjC,gBAAgB,GAAmB,IAAI,CAAC;IACxC,eAAe,GAAQ,IAAI,CAAC;IAEpC,gBAAgB;IAChB,QAAQ;QACJ,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzB,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAC9B,CAAC;IAED,gBAAgB;IAChB,SAAS;QACL,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,KAAK,IAAI,CAAC,sBAAsB,EAAE;YAChE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC;YACvD,IAAI,CAAC,MAAM,CAAC,6BAA6B,CAAC,IAAI,CAAC,OAAO,CAAC;gBACnD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC;YACzD,IAAI,CAAC,sBAAsB,GAAG,SAAS,CAAC;SAC3C;QACD,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,6DAA6D;QAC7D,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,eAAe,EAAE,CAAC;IACxD,CAAC;IAEO,mBAAmB;QACvB,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,GAAG,EAAE;YAClC,8CAA8C;YAC9C,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;gBAChC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aAC5B;iBACI,IAAI,KAAK,EAAE;gBACZ,OAAO,CAAC,IAAI,CAAC,qCAAqC,IAAI,CAAC,GAAG,6FAA6F,CAAC,CAAC;aAC5J;SACJ;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CAAC,GAAmD,EAAE,IAAa;QAC9E,IAAI,CAAC,IAAI,CAAC,gBAAgB;YAAE,OAAO,KAAK,CAAC;QAEzC,GAAG,GAAG,uBAAuB,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAEtE,IAAI,CAAC,GAAG;YAAE,OAAO,KAAK,CAAC;QAEvB,IAAI,KAAK,GAAG,CAAC;QAEb,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE;YAChC,OAAO,CAAC,IAAI,CAAC,oCAAoC,GAAG,IAAI,GAAG,QAAQ,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,EAAE,IAAI,IAAI,SAAS,CAAC,CAAC,CAAC;SAC5H;QAED,IAAI,KAAK;YAAE,OAAO,CAAC,GAAG,CAAC,wBAAwB,GAAG,GAAG,CAAC,CAAC;QAEvD,IAAI,IAAI,CAAC,QAAQ,KAAK,GAAG,IAAI,IAAI,CAAC,sBAAsB,EAAE;YACtD,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,OAAO,IAAI,CAAC;SACf;aACI;YACD,IAAI,CAAC,sBAAsB,EAAE,OAAO,EAAE,CAAC;YACvC,IAAI,CAAC,sBAAsB,GAAG,SAAS,CAAC;SAC3C;QACD,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC;QAEpB,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC5D,IAAI,CAAC,OAAO,EAAE;YACV,IAAI,KAAK;gBAAE,OAAO,CAAC,IAAI,CAAC,+CAA+C,EAAE,GAAG,CAAC,CAAC;YAC9E,OAAO,KAAK,CAAC;SAChB;QACD,2CAA2C;QAC3C,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE;YACjC,IAAI,KAAK;gBAAE,OAAO,CAAC,IAAI,CAAC,kDAAkD,CAAC,CAAC;YAC5E,OAAO,KAAK,CAAC;SAChB;QACD,6CAA6C;QAC7C,IAAI,IAAI,CAAC,QAAQ,KAAK,GAAG,EAAE;YACvB,IAAI,KAAK;gBAAE,OAAO,CAAC,IAAI,CAAC,qEAAqE,CAAC,CAAC;YAC/F,OAAO,KAAK,CAAC,CAAC,4BAA4B;SAC7C;QACD,yBAAyB;QACzB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,sBAAsB,GAAG,OAAO,CAAC;QACtC,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,OAAO,IAAI,CAAC;IAChB,CAAC;IAGO,KAAK;QACT,MAAM,MAAM,GAAG,IAAI,CAAC,sBAAsB,CAAC;QAC3C,IAAI,CAAC,MAAM;YAAE,OAAO;QAEpB,IAAI,CAAC,MAAM,YAAY,WAAW,IAAI,MAAM,YAAY,qBAAqB,CAAC,IAAI,MAAM,CAAC,OAAO,IAAI,uBAAuB,EAAE;YACzH,gBAAgB;SACnB;aACI;YACD,MAAM,CAAC,OAAO,GAAG,gCAAgC,CAAC;YAClD,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;SAC7B;QAED,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO;QAC3B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACf,OAAO,CAAC,IAAI,CAAC,gEAAgE,CAAC,CAAC;YAC/E,OAAO;SACV;QAED,gBAAgB;QAChB,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,KAAK,MAAM;YACxC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC;QACzD,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,KAAK,MAAM;YACzC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC;QAC3D,IAAI,KAAK;YAAE,OAAO,CAAC,GAAG,CAAC,oBAAoB,GAAG,CAAC,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,6BAA6B,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QACxQ,IAAI,IAAI,CAAC,WAAW;YAChB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,GAAG,MAAM,CAAC;QAC5C,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,MAAM,CAAC,6BAA6B,CAAC,IAAI,CAAC,OAAO,CAAC;YACtE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,GAAG,MAAM,CAAC;QAC3C,IAAI,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,oBAAoB,KAAK,SAAS;YACpE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,oBAAoB,GAAG,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC;IACxG,CAAC;IAGgB,cAAc,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC7C,iBAAiB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAEhF,eAAe,CAAC,GAAW;QAC/B,OAAO,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IACnE,CAAC;IAEO,kBAAkB,CAAC,GAAW;QAClC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,iBAAiB,EAAE;YACvC,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAAE,OAAO,IAAI,CAAC;SACvC;QACD,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,cAAc,EAAE;YACxC,IAAI,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC;gBAAE,OAAO,IAAI,CAAC;SAC7C;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAIO,kBAAkB;QACtB,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC3E,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAClE,CAAC;IAEO,oBAAoB;QACxB,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC9E,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACrE,CAAC;IAEO,eAAe,GAAG,CAAC,CAAY,EAAE,EAAE;QACvC,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,OAAO;QAC5B,IAAI,CAAC,CAAC,CAAC,YAAY;YAAE,OAAO;QAC5B,KAAK,MAAM,IAAI,IAAI,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE;YACrC,kDAAkD;YAClD,0CAA0C;YAC1C,yCAAyC;YACzC,6BAA6B;YAC7B,IAAI,IAAI,KAAK,eAAe,IAAI,IAAI,KAAK,OAAO,EAAE;gBAC9C,CAAC,CAAC,cAAc,EAAE,CAAC;aACtB;SACJ;IACL,CAAC,CAAC;IAEM,MAAM,GAAG,CAAC,CAAY,EAAE,EAAE;QAC9B,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,OAAO;QAC5B,IAAI,CAAC,CAAC,CAAC,YAAY;YAAE,OAAO;QAC5B,KAAK,MAAM,IAAI,IAAI,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE;YACrC,IAAI,KAAK;gBAAE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC7B,IAAI,IAAI,KAAK,eAAe,EAAE;gBAC1B,MAAM,GAAG,GAAG,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBACzC,IAAI,KAAK;oBAAE,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBAClC,IAAI,IAAI,GAAG,IAAI,MAAM,CAAC,iDAAiD,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC;gBACjG,IAAI,CAAC,IAAI,EAAE;oBACP,IAAI,GAAG,IAAI,MAAM,CAAC,gCAAgC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC;iBAC/E;gBACD,IAAI,KAAK;oBAAE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC7B,IAAI,IAAI,EAAE;oBACN,MAAM,SAAS,GAAG,uDAAuD,GAAG,IAAI,GAAG,SAAS,CAAC;oBAC7F,OAAO,CAAC,GAAG,CAAC,4CAA4C,SAAS,EAAE,CAAC,CAAC;oBACrE,CAAC,CAAC,cAAc,EAAE,CAAC;oBACnB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;oBAC1B,MAAM;iBACT;qBACI,IAAI,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE;oBACnC,OAAO,CAAC,GAAG,CAAC,2CAA2C,GAAG,GAAG,CAAC,CAAC;oBAC/D,CAAC,CAAC,cAAc,EAAE,CAAC;oBACnB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;oBACpB,MAAM;iBACT;qBACI;oBAED,OAAO,CAAC,IAAI,CAAC,8BAA8B,GAAG,kGAAkG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBACtL,mFAAmF;oBACnF,MAAM,GAAG,GAAG,IAAI,WAAW,CAAC,qBAAqB,EAAE;wBAC/C,MAAM,EAAE;4BACJ,MAAM,EAAE,IAAI;4BACZ,KAAK,EAAE,CAAC;4BACR,GAAG;4BACH,KAAK,EAAE,CAAC,GAAW,EAAE,EAAE;gCACnB,CAAC,CAAC,cAAc,EAAE,CAAC;gCACnB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;4BACxB,CAAC;yBACJ;qBACJ,CAAC,CAAC;oBACH,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;iBAC3B;aACJ;iBACI,IAAI,IAAI,IAAI,OAAO,EAAE;gBACtB,MAAM,IAAI,GAAG,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBAC1C,IAAI,KAAK;oBAAE,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACnC,IAAI,CAAC,IAAI;oBAAE,SAAS;gBACpB,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;oBACrC,OAAO,CAAC,IAAI,CAAC,0BAA0B,IAAI,CAAC,IAAI,4CAA4C,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;oBACjI,OAAO;iBACV;gBACD,2DAA2D;gBAC3D,qCAAqC;gBACrC,6CAA6C;gBAC7C,0BAA0B;gBAC1B,sCAAsC;gBACtC,IAAI;gBACJ,QAAQ;gBACR;oBACI,CAAC,CAAC,cAAc,EAAE,CAAC;oBACnB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBAC7B;gBACD,MAAM;aACT;SACJ;IACL,CAAC,CAAC;CACL;AAxQG;IAFC,SAAS,CAAC,YAAY,CAAC,SAAS,CAAC,mBAAmB,CAAC;IACrD,YAAY,CAAC,GAAG,CAAC;yCAC0B;AAO5C;IADC,YAAY,EAAE;+CACW;AAO1B;IADC,YAAY,EAAE;gDACY;AAO3B;IADC,YAAY,EAAE;iDACa;AAO5B;IADC,YAAY,EAAE;qDACiB;AAgPpC,SAAS,uBAAuB,CAAC,GAA8B,EAAE,WAAoB,EAAE,UAAmB;IAEtG,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IAEnD,MAAM,SAAS,GAAG,WAAW,IAAI,CAAC,UAAU,CAAC;IAE7C,MAAM,KAAK,GAAG,gBAAgB,CAAC,GAAG,CAAC,WAAW,EAAqB,CAAC,CAAC;IACrE,IAAI,KAAK,EAAE;QACP,OAAO,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC;KAChD;SACI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,EAAE,MAAM,IAAI,CAAC,gBAAgB,EAAE,IAAI,KAAK,CAAC,EAAE;QAC9E,MAAM,WAAW,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;QACvJ,IAAG,WAAW,EAAE;YACZ,OAAO,CAAC,IAAI,CAAC,4CAA4C,GAAG,uBAAuB,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACrJ;KACJ;IAED,OAAO,GAAG,CAAC;AACf,CAAC"}

package/lib/engine-components/SmoothFollow.d.ts

@@ -2,11 +2,54 @@ import { Object3D } from "three";
 import { Axes } from "../engine/engine_physics.types.js";
 import { Behaviour } from "./Component.js";
 /**
- * SmoothFollow makes the {@link Object3D} (`GameObject`) smoothly follow another target {@link Object3D}.
- * It can follow the target's position, rotation, or both.
- * @summary Smoothly follows a target object
+ * [SmoothFollow](https://engine.needle.tools/docs/api/SmoothFollow) makes this GameObject smoothly follow another target object's position and/or rotation.
+ *
+ * **Position Following:**
+ * When enabled (`followFactor > 0`), this object will move towards the target's world position.
+ * The object interpolates from its current position to the target's position each frame.
+ * Use `positionAxes` to restrict following to specific axes (e.g., only horizontal movement).
+ *
+ * **Rotation Following:**
+ * When enabled (`rotateFactor > 0`), this object will rotate to match the target's world rotation.
+ * The object smoothly interpolates from its current rotation to the target's rotation each frame.
+ * This makes the object face the same direction as the target, not look at it (use {@link LookAt} for that).
+ *
+ * **Smoothing:**
+ * Both position and rotation use time-based interpolation (lerp/slerp).
+ * Higher factor values = faster following (less lag), lower values = slower following (more lag).
+ * Set a factor to 0 to disable that type of following entirely.
+ *
+ * **Common Use Cases:**
+ * - Camera following a player character
+ * - UI elements tracking world objects
+ * - Delayed motion effects (ghost trails, spring arms)
+ * - Smoothed object attachment
+ *
+ * @example Follow a target with smooth position
+ * ```ts
+ * const follower = myObject.addComponent(SmoothFollow);
+ * follower.target = playerObject;
+ * follower.followFactor = 5;  // Higher = faster following
+ * follower.rotateFactor = 0;  // Don't follow rotation
+ * ```
+ *
+ * @example Follow only on horizontal plane
+ * ```ts
+ * follower.positionAxes = Axes.X | Axes.Z; // Follow X and Z only (no vertical)
+ * ```
+ *
+ * @example Follow both position and rotation
+ * ```ts
+ * follower.target = targetObject;
+ * follower.followFactor = 3;  // Smooth position following
+ * follower.rotateFactor = 2;  // Smooth rotation following
+ * ```
+ *
+ * @summary Smoothly follows a target object's position and/or rotation
  * @category Interactivity
  * @group Components
+ * @see {@link LookAtConstraint} for making an object look at a target (different from rotation following)
+ * @see {@link Mathf} for the interpolation used
  */
 export declare class SmoothFollow extends Behaviour {
     /**
@@ -14,16 +57,28 @@ export declare class SmoothFollow extends Behaviour {
      */
     target: Object3D | null;
     /**
-     * The factor to smoothly follow the target's position.
-     * The value is clamped between 0 and 1. If 0, the GameObject will not follow the target's position.
+     * Speed factor for position following.
+     * Controls how quickly this object moves to match the target's position.
+     * Higher values = faster/tighter following (less lag), lower = slower/looser (more lag).
+     * Set to 0 to disable position following entirely.
+     * @default 0.1
      */
     followFactor: number;
     /**
-     * The factor to smoothly follow the target's rotation.
-     * The value is clamped between 0 and 1. If 0, the GameObject will not follow the target's rotation.
+     * Speed factor for rotation following.
+     * Controls how quickly this object rotates to match the target's rotation.
+     * Higher values = faster/tighter following (less lag), lower = slower/looser (more lag).
+     * Set to 0 to disable rotation following entirely.
+     * @default 0.1
      */
     rotateFactor: number;
+    /**
+     * Which position axes to follow. Use bitwise OR to combine:
+     * `Axes.X | Axes.Y` follows only X and Y axes.
+     * @default Axes.All
+     */
     positionAxes: Axes;
+    /** When true, rotates 180° around Y axis (useful for mirrored setups) */
     flipForward: boolean;
     private static _invertForward;
     private _firstUpdate;
@@ -31,5 +86,9 @@ export declare class SmoothFollow extends Behaviour {
      * Update the position and rotation of the GameObject to follow the target.
      */
     onBeforeRender(): void;
+    /**
+     * Manually update the position/rotation to follow the target.
+     * @param hard If true, snaps instantly to target without smoothing
+     */
     updateNow(hard: boolean): void;
 }

package/lib/engine-components/SmoothFollow.js

@@ -11,11 +11,54 @@ import { serializable } from "../engine/engine_serialization_decorator.js";
 import { getWorldPosition, getWorldQuaternion } from "../engine/engine_three_utils.js";
 import { Behaviour } from "./Component.js";
 /**
- * SmoothFollow makes the {@link Object3D} (`GameObject`) smoothly follow another target {@link Object3D}.
- * It can follow the target's position, rotation, or both.
- * @summary Smoothly follows a target object
+ * [SmoothFollow](https://engine.needle.tools/docs/api/SmoothFollow) makes this GameObject smoothly follow another target object's position and/or rotation.
+ *
+ * **Position Following:**
+ * When enabled (`followFactor > 0`), this object will move towards the target's world position.
+ * The object interpolates from its current position to the target's position each frame.
+ * Use `positionAxes` to restrict following to specific axes (e.g., only horizontal movement).
+ *
+ * **Rotation Following:**
+ * When enabled (`rotateFactor > 0`), this object will rotate to match the target's world rotation.
+ * The object smoothly interpolates from its current rotation to the target's rotation each frame.
+ * This makes the object face the same direction as the target, not look at it (use {@link LookAt} for that).
+ *
+ * **Smoothing:**
+ * Both position and rotation use time-based interpolation (lerp/slerp).
+ * Higher factor values = faster following (less lag), lower values = slower following (more lag).
+ * Set a factor to 0 to disable that type of following entirely.
+ *
+ * **Common Use Cases:**
+ * - Camera following a player character
+ * - UI elements tracking world objects
+ * - Delayed motion effects (ghost trails, spring arms)
+ * - Smoothed object attachment
+ *
+ * @example Follow a target with smooth position
+ * ```ts
+ * const follower = myObject.addComponent(SmoothFollow);
+ * follower.target = playerObject;
+ * follower.followFactor = 5;  // Higher = faster following
+ * follower.rotateFactor = 0;  // Don't follow rotation
+ * ```
+ *
+ * @example Follow only on horizontal plane
+ * ```ts
+ * follower.positionAxes = Axes.X | Axes.Z; // Follow X and Z only (no vertical)
+ * ```
+ *
+ * @example Follow both position and rotation
+ * ```ts
+ * follower.target = targetObject;
+ * follower.followFactor = 3;  // Smooth position following
+ * follower.rotateFactor = 2;  // Smooth rotation following
+ * ```
+ *
+ * @summary Smoothly follows a target object's position and/or rotation
  * @category Interactivity
  * @group Components
+ * @see {@link LookAtConstraint} for making an object look at a target (different from rotation following)
+ * @see {@link Mathf} for the interpolation used
  */
 export class SmoothFollow extends Behaviour {
     /**
@@ -23,16 +66,28 @@ export class SmoothFollow extends Behaviour {
      */
     target = null;
     /**
-     * The factor to smoothly follow the target's position.
-     * The value is clamped between 0 and 1. If 0, the GameObject will not follow the target's position.
+     * Speed factor for position following.
+     * Controls how quickly this object moves to match the target's position.
+     * Higher values = faster/tighter following (less lag), lower = slower/looser (more lag).
+     * Set to 0 to disable position following entirely.
+     * @default 0.1
      */
     followFactor = .1;
     /**
-     * The factor to smoothly follow the target's rotation.
-     * The value is clamped between 0 and 1. If 0, the GameObject will not follow the target's rotation.
+     * Speed factor for rotation following.
+     * Controls how quickly this object rotates to match the target's rotation.
+     * Higher values = faster/tighter following (less lag), lower = slower/looser (more lag).
+     * Set to 0 to disable rotation following entirely.
+     * @default 0.1
      */
     rotateFactor = .1;
+    /**
+     * Which position axes to follow. Use bitwise OR to combine:
+     * `Axes.X | Axes.Y` follows only X and Y axes.
+     * @default Axes.All
+     */
     positionAxes = Axes.All;
+    /** When true, rotates 180° around Y axis (useful for mirrored setups) */
     flipForward = false;
     static _invertForward = new Quaternion().setFromAxisAngle(new Vector3(0, 1, 0), Math.PI);
     _firstUpdate = true;
@@ -42,6 +97,10 @@ export class SmoothFollow extends Behaviour {
     onBeforeRender() {
         this.updateNow(false);
     }
+    /**
+     * Manually update the position/rotation to follow the target.
+     * @param hard If true, snaps instantly to target without smoothing
+     */
     updateNow(hard) {
         if (!this.target || this.target === this.gameObject)
             return;

package/lib/engine-components/SmoothFollow.js.map

@@ -1 +1 @@
-{"version":3,"file":"SmoothFollow.js","sourceRoot":"","sources":["../../src/engine-components/SmoothFollow.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAEtD,OAAO,EAAE,KAAK,EAAE,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,mCAAmC,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,6CAA6C,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACvF,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;;;;;GAMG;AACH,MAAM,OAAO,YAAa,SAAQ,SAAS;IAEvC;;OAEG;IAEH,MAAM,GAAoB,IAAI,CAAC;IAE/B;;;OAGG;IAEH,YAAY,GAAG,EAAE,CAAC;IAClB;;;OAGG;IAEH,YAAY,GAAG,EAAE,CAAC;IAGlB,YAAY,GAAS,IAAI,CAAC,GAAG,CAAC;IAE9B,WAAW,GAAY,KAAK,CAAC;IAErB,MAAM,CAAC,cAAc,GAAe,IAAI,UAAU,EAAE,CAAC,gBAAgB,CAAC,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;IACrG,YAAY,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,cAAc;QACV,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED,SAAS,CAAC,IAAa;QACnB,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,UAAU;YAAE,OAAO;QAC5D,IAAI,IAAI,CAAC,YAAY,GAAG,CAAC,EAAE;YACvB,MAAM,EAAE,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACzC,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;YAC5G,MAAM,eAAe,GAAG,IAAI,CAAC,aAAa,CAAC;YAE3C,IAAI,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;gBAAE,eAAe,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAC9F,IAAI,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;gBAAE,eAAe,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAC9F,IAAI,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;gBAAE,eAAe,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAE9F,yCAAyC;YAEzC,IAAI,CAAC,aAAa,GAAG,eAAe,CAAC;SACxC;QACD,IAAI,IAAI,CAAC,YAAY,GAAG,CAAC,EAAE;YACvB,MAAM,EAAE,GAAG,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC3C,IAAI,IAAI,CAAC,WAAW,EAAE;gBAClB,EAAE,CAAC,WAAW,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;aAC/C;YACD,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;YAE5G,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SAC/D;QACD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC9B,CAAC;;AAvDD;IADC,YAAY,CAAC,QAAQ,CAAC;4CACQ;AAO/B;IADC,YAAY,EAAE;kDACG;AAMlB;IADC,YAAY,EAAE;kDACG;AAGlB;IADC,YAAY,EAAE;kDACe"}
+{"version":3,"file":"SmoothFollow.js","sourceRoot":"","sources":["../../src/engine-components/SmoothFollow.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAEtD,OAAO,EAAE,KAAK,EAAE,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,mCAAmC,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,6CAA6C,CAAC;AAC3E,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAEvF,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,MAAM,OAAO,YAAa,SAAQ,SAAS;IAEvC;;OAEG;IAEH,MAAM,GAAoB,IAAI,CAAC;IAE/B;;;;;;OAMG;IAEH,YAAY,GAAG,EAAE,CAAC;IAElB;;;;;;OAMG;IAEH,YAAY,GAAG,EAAE,CAAC;IAElB;;;;OAIG;IAEH,YAAY,GAAS,IAAI,CAAC,GAAG,CAAC;IAE9B,yEAAyE;IACzE,WAAW,GAAY,KAAK,CAAC;IAErB,MAAM,CAAC,cAAc,GAAe,IAAI,UAAU,EAAE,CAAC,gBAAgB,CAAC,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;IACrG,YAAY,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,cAAc;QACV,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,IAAa;QACnB,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,UAAU;YAAE,OAAO;QAC5D,IAAI,IAAI,CAAC,YAAY,GAAG,CAAC,EAAE;YACvB,MAAM,EAAE,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACzC,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;YAC5G,MAAM,eAAe,GAAG,IAAI,CAAC,aAAa,CAAC;YAE3C,IAAI,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;gBAAE,eAAe,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAC9F,IAAI,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;gBAAE,eAAe,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAC9F,IAAI,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;gBAAE,eAAe,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAE9F,yCAAyC;YAEzC,IAAI,CAAC,aAAa,GAAG,eAAe,CAAC;SACxC;QACD,IAAI,IAAI,CAAC,YAAY,GAAG,CAAC,EAAE;YACvB,MAAM,EAAE,GAAG,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC3C,IAAI,IAAI,CAAC,WAAW,EAAE;gBAClB,EAAE,CAAC,WAAW,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;aAC/C;YACD,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;YAE5G,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SAC/D;QACD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC9B,CAAC;;AAxED;IADC,YAAY,CAAC,QAAQ,CAAC;4CACQ;AAU/B;IADC,YAAY,EAAE;kDACG;AAUlB;IADC,YAAY,EAAE;kDACG;AAQlB;IADC,YAAY,EAAE;kDACe"}

package/lib/engine-components/SpatialTrigger.d.ts

@@ -4,9 +4,32 @@ import { EventList } from "./EventList.js";
 /**
  * Component that receives and responds to spatial events, like entering or exiting a trigger zone.
  * Used in conjunction with {@link SpatialTrigger} to create interactive spatial events.
+ *
+ * Place this on objects that should react when entering trigger zones. The receiver checks
+ * against all active SpatialTriggers each frame and fires events when intersections change.
+ *
+ * Events can be connected via {@link EventList} in the editor or listened to in code.
+ *
+ * @example Listen to trigger events
+ * ```ts
+ * export class DoorTrigger extends Behaviour {
+ *   @serializable(SpatialTriggerReceiver)
+ *   receiver?: SpatialTriggerReceiver;
+ *
+ *   start() {
+ *     this.receiver?.onEnter?.addEventListener(() => {
+ *       console.log("Player entered door zone");
+ *     });
+ *   }
+ * }
+ * ```
+ *
  * @summary Receives spatial trigger events
  * @category Interactivity
  * @group Components
+ * @see {@link SpatialTrigger} for defining trigger zones
+ * @see {@link EventList} for event handling
+ * @link https://engine.needle.tools/samples/spatial-triggers/
  */
 export declare class SpatialTriggerReceiver extends Behaviour {
     /**
@@ -53,9 +76,33 @@ export declare class SpatialTriggerReceiver extends Behaviour {
 }
 /**
  * A spatial trigger component that detects objects within a box-shaped area.
- * Used to trigger events when objects enter, stay in, or exit the defined area
+ * Used to trigger events when objects enter, stay in, or exit the defined area.
+ *
+ * The trigger area is defined by the GameObject's bounding box (uses {@link BoxHelperComponent}).
+ * Objects with {@link SpatialTriggerReceiver} components are tested against this area.
+ *
+ * **Mask system:** Both trigger and receiver have a `triggerMask` - they only interact
+ * when their masks have overlapping bits set. This allows selective triggering.
+ *
+ * **Debug:** Use `?debugspatialtrigger` URL parameter to visualize trigger zones.
+ *
+ * @example Create a pickup zone
+ * ```ts
+ * // On the pickup zone object
+ * const trigger = pickupZone.addComponent(SpatialTrigger);
+ * trigger.triggerMask = 1; // Layer 1 for pickups
+ *
+ * // On the player
+ * const receiver = player.addComponent(SpatialTriggerReceiver);
+ * receiver.triggerMask = 1; // Match the pickup layer
+ * ```
+ *
+ * @summary Define a trigger zone that detects entering objects
  * @category Interactivity
  * @group Components
+ * @see {@link SpatialTriggerReceiver} for objects that respond to triggers
+ * @see {@link BoxHelperComponent} for the underlying box used to define the trigger area
+ * @link https://engine.needle.tools/samples/spatial-triggers/
  */
 export declare class SpatialTrigger extends Behaviour {
     /** Global registry of all active spatial triggers in the scene */