@needle-tools/engine 4.11.5-next.d9019e4 → 4.11.5-next.dedc70b

package/src/engine-components/web/HoverAnimation.ts

@@ -13,6 +13,7 @@ import { Behaviour } from "../Component.js";
  * 
  * By default, a simple scale-up animation is used. You can customize the hover and idle animations by providing your own animation clips.
  * 
+ * @summary Hover Animation on Pointer Enter/Exit
  * @category Web
  * @group Components
  */

package/src/engine-components/web/ScrollFollow.ts

@@ -34,6 +34,7 @@ type ScrollFollowEvent = {
 
 /**
  * The ScrollFollow component allows you to link the scroll position of the page (or a specific element) to one or more target objects.  
+ 
  * This can be used to create scroll-based animations, audio playback, or other effects. For example you can link the scroll position to a timeline (PlayableDirector) to create scroll-based storytelling effects or to an Animator component to change the animation state based on scroll.
  * 
  * Assign {@link target} objects to the component to have them updated based on the current scroll position (check the 'target' property for supported types).
@@ -60,6 +61,7 @@ type ScrollFollowEvent = {
  *   <div data-timeline-marker="1.0">End of Timeline</div>
  * ```
  * 
+ * @summary Links scroll position to target objects
  * @category Web
  * @group Components
  * @component

package/src/engine-components/web/ViewBox.ts

@@ -31,6 +31,7 @@ export type ViewBoxMode = "continuous" | "once";
   scene.add(viewBox);
  * ```
   
+ * @summary Automatically fits a box area into the camera view
  * @category Camera
  * @group Components
  * @component

package/src/engine-components/webxr/Avatar.ts

@@ -18,6 +18,11 @@ const debug = getParam("debugwebxr");
 const flipForwardQuaternion = new Quaternion().setFromAxisAngle(new Vector3(0, 1, 0), Math.PI);
 
 /**
+ * Avatar component to setup a WebXR avatar with head and hand objects.  
+ * 
+ * The avatar will automatically synchronize the head and hand objects with the XR rig when entering an XR session.
+ * 
+ * @summary WebXR Avatar component for head and hands synchronization
  * @category XR
  * @category Networking
  * @group Components

package/src/engine-components/webxr/WebARCameraBackground.ts

@@ -26,6 +26,7 @@ const debug = getParam("debugarcamera");
  * 
  * - Example: https://samples.needle.tools/ar-camera-background
  * 
+ * @summary Displays the camera feed as background in WebAR sessions
  * @category XR
  * @group Components
  */

package/src/engine-components/webxr/WebARSessionRoot.ts

@@ -29,6 +29,7 @@ const invertForwardMatrix = new Matrix4().makeRotationY(Math.PI);
  * });
  * ```
  * 
+ * @summary Root object for WebAR sessions, managing scene placement and user scaling in AR.
  * @category XR
  * @group Components
  */

package/src/engine-components/webxr/WebXR.ts

@@ -51,7 +51,7 @@ const debugQuicklook = getParam("debugusdz");
  * });
  * ```
  * 
- * 
+ * @summary WebXR Component for VR and AR support
  * @category XR
  * @group Components
  */

package/src/engine-components/webxr/controllers/XRControllerFollow.ts

@@ -21,6 +21,7 @@ import { Behaviour } from "../../Component.js";
  * });
  * ```
  * 
+ * @summary Makes the object follow a specific XR controller or hand
  * @category XR
  * @group Components
  * */

package/src/engine-components/webxr/controllers/XRControllerModel.ts

@@ -27,6 +27,10 @@ const renderingUpdateTimings = new Array<number>();
  * It automatically loads the appropriate model for the connected controller or hand.  
  * 
  * You can configure if controller models or hand models should be created.
+ * 
+ * @summary Displays controller or hand models in XR
+ * @category XR
+ * @group Components
  */
 export class XRControllerModel extends Behaviour {
 

package/src/engine-components/webxr/controllers/XRControllerMovement.ts

@@ -30,6 +30,7 @@ declare type HitPointObject = Object3D & { material: Material & { opacity: numbe
  * It also visualizes controller rays and hit points in the scene.
  * 
  * 
+ * @summary Move the XR rig using controller input
  * @category XR
  * @group Components
  */

package/src/engine-components-experimental/networking/PlayerSync.ts

@@ -18,7 +18,9 @@ declare type PlayerSyncWithAsset = PlayerSync & Required<Pick<PlayerSync, "asset
 /**
  * This component instantiates an asset for each player that joins a networked room. The asset will be destroyed when the player leaves the room.
  * The asset should have a PlayerState component, and can have other components like SyncedTransform, custom components, etc.
+ * @summary Instantiates and manages player assets in a networked room
  * @category Networking
+ * @group Components
  */
 export class PlayerSync extends Behaviour {
 

package/lib/engine/webcomponents/needle-engine.attributes.d.ts

@@ -1,70 +0,0 @@
-type MainAttributes = {
-    children?: HTMLElement[];
-    style?: Partial<CSSStyleDeclaration>;
-    /** src to one or multiple glb files to be loaded initially. Can be either "path/to/scene.glb" or "[./path/scene1.glb, myOtherScene.gltf]" */
-    src?: string | string[];
-    /** optional */
-    hash?: string;
-    /** set to automatically add OrbitControls to the loaded scene */
-    "camera-controls"?: boolean | "none";
-    /** event function name called when loading starts, use preventDefault to prevent the default loading overlay to show */
-    "loadstart"?: string;
-    /** event function name called when loading updates */
-    "progress"?: string;
-    /** event function name called when loading has finished */
-    "loadfinished"?: string;
-    /** override the default draco decoder path location */
-    "dracoDecoderPath"?: string;
-    /** override the default draco type */
-    "dracoDecoderType"?: string;
-    /** override the default ktx2 decoder path */
-    "ktx2DecoderPath"?: string;
-    /** Add to prevent Needle Engine context from being disposed when the element is removed from the DOM */
-    "keep-alive"?: boolean;
-    addEventListener?(event: "ready", callback: (event: CustomEvent) => void): void;
-    addEventListener?(event: "error", callback: (event: CustomEvent) => void): void;
-};
-type LoadingAttributes = {
-    /** Set a custom loading background color (e.g. "red" or "#dd00ff" or "rgba(18, 224, 224, 0.5)") */
-    "loading-background"?: string;
-    /** Pro features */
-    "hide-loading-overlay"?: boolean;
-    /** Pro feature */
-    "loading-logo-src"?: string;
-    /** Pro feature */
-    "primary-color"?: string;
-    /** Pro feature */
-    "secondary-color"?: string;
-};
-type SkyboxAttributes = {
-    /** @deprecated. Use background-image instead - URL to .exr, .hdr, .png, .jpg to be used as skybox */
-    "skybox-image"?: string;
-    /** URL to .exr, .hdr, .png, .jpg to be used as skybox */
-    "background-image"?: string;
-    /** Blurs the background image (if any) - value between 0 and 1
-     * 0: no blur
-     * 1: full blur
-     */
-    "background-blurriness"?: number;
-    /**
-     * Background color to be used if no skybox or background image is provided.
-     * For example: "skybox-color='#ff0000'" will set the background color to red.
-     */
-    "background-color"?: string;
-    /** URL to .exr, .hdr, .png, .jpg to be used for lighting */
-    "environment-image"?: string;
-    "environment-intensity"?: number;
-};
-export type TonemappingAttributeOptions = "none" | "linear" | "neutral" | "agx";
-type RenderingAttributes = {
-    "transparent"?: boolean;
-    "contactshadows"?: boolean;
-    "tone-mapping"?: TonemappingAttributeOptions;
-    "tone-mapping-exposure"?: number;
-};
-/**
- * Available attributes for the `<needle-engine>` web component
- * @inheritdoc
- */
-export type NeedleEngineAttributes = MainAttributes & Partial<Omit<HTMLElement, "style">> & LoadingAttributes & SkyboxAttributes & RenderingAttributes;
-export {};

package/lib/engine/webcomponents/needle-engine.attributes.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=needle-engine.attributes.js.map

package/lib/engine/webcomponents/needle-engine.attributes.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"needle-engine.attributes.js","sourceRoot":"","sources":["../../../src/engine/webcomponents/needle-engine.attributes.ts"],"names":[],"mappings":""}

package/src/engine/webcomponents/needle-engine.attributes.ts

@@ -1,85 +0,0 @@
-
-
-
-type MainAttributes = {
-    children?: HTMLElement[];
-    style?: Partial<CSSStyleDeclaration>;
-    /** src to one or multiple glb files to be loaded initially. Can be either "path/to/scene.glb" or "[./path/scene1.glb, myOtherScene.gltf]" */
-    src?: string | string[];
-    /** optional */
-    hash?: string;
-    /** set to automatically add OrbitControls to the loaded scene */
-    "camera-controls"?: boolean | "none";
-    /** event function name called when loading starts, use preventDefault to prevent the default loading overlay to show */
-    "loadstart"?: string;
-    /** event function name called when loading updates */
-    "progress"?: string;
-    /** event function name called when loading has finished */
-    "loadfinished"?: string;
-    /** override the default draco decoder path location */
-    "dracoDecoderPath"?: string;
-    /** override the default draco type */
-    "dracoDecoderType"?: string;
-    /** override the default ktx2 decoder path */
-    "ktx2DecoderPath"?: string;
-
-    /** Add to prevent Needle Engine context from being disposed when the element is removed from the DOM */
-    "keep-alive"?: boolean;
-
-    addEventListener?(event: "ready", callback: (event: CustomEvent) => void): void;
-    addEventListener?(event: "error", callback: (event: CustomEvent) => void): void;
-}
-
-type LoadingAttributes = {
-    /** Set a custom loading background color (e.g. "red" or "#dd00ff" or "rgba(18, 224, 224, 0.5)") */
-    "loading-background"?: string,
-    /** Pro features */
-    "hide-loading-overlay"?: boolean,
-    /** Pro feature */
-    "loading-logo-src"?: string,
-    /** Pro feature */
-    "primary-color"?: string,
-    /** Pro feature */
-    "secondary-color"?: string,
-}
-
-type SkyboxAttributes = {
-    /** @deprecated. Use background-image instead - URL to .exr, .hdr, .png, .jpg to be used as skybox */
-    "skybox-image"?: string,
-    /** URL to .exr, .hdr, .png, .jpg to be used as skybox */
-    "background-image"?: string, 
-    /** Blurs the background image (if any) - value between 0 and 1  
-     * 0: no blur
-     * 1: full blur
-     */
-    "background-blurriness"?: number,
-    /**
-     * Background color to be used if no skybox or background image is provided.  
-     * For example: "skybox-color='#ff0000'" will set the background color to red.
-     */
-    "background-color"?: string,
-    /** URL to .exr, .hdr, .png, .jpg to be used for lighting */
-    "environment-image"?: string,
-
-    "environment-intensity"?: number,
-}
-
-export type TonemappingAttributeOptions = "none" | "linear" | "neutral" | "agx";
-type RenderingAttributes = {
-    "transparent"?: boolean,
-    "contactshadows"?: boolean,
-    "tone-mapping"?: TonemappingAttributeOptions,
-    "tone-mapping-exposure"?: number,
-}
-
-/**
- * Available attributes for the `<needle-engine>` web component
- * @inheritdoc
- */
-export type NeedleEngineAttributes =
-    MainAttributes
-    & Partial<Omit<HTMLElement, "style">>
-    & LoadingAttributes
-    & SkyboxAttributes
-    & RenderingAttributes
-    ;