@needle-tools/engine 5.1.0-alpha → 5.1.0-alpha.1

package/dist/needle-engine.d.ts

@@ -918,8 +918,9 @@ export declare enum AnimatorConditionMode {
  * and parameters that affect those transitions. It is used by the {@link Animator}
  * component to control animation behavior on 3D models.
  *
- * Use the static method {@link AnimatorController.createFromClips} to create
- * an animator controller from a set of animation clips.
+ * Use {@link AnimatorController.build} to fluently create a controller with parameters,
+ * states, transitions, and conditions. For simple sequential playback,
+ * use {@link AnimatorController.createFromClips}.
  *
  * @category Animation and Sequencing
  * @group Utilities
@@ -934,6 +935,27 @@ export declare class AnimatorController {
      * @returns A new AnimatorController instance
      */
     static createFromClips(clips: AnimationClip[], options?: CreateAnimatorControllerOptions): AnimatorController;
+    /**
+     * Creates a new {@link AnimatorControllerBuilder} for fluently constructing a controller with
+     * parameters, states, transitions, and conditions.
+     *
+     * @param name - Optional name for the controller
+     * @returns A new builder instance
+     *
+     * @example
+     * ```ts
+     * const ctrl = AnimatorController.build("MyController")
+     *     .floatParameter("Speed")
+     *     .state("Idle", { clip: idleClip, loop: true })
+     *     .state("Walk", { clip: walkClip, loop: true })
+     *     .transition("Idle", "Walk", { duration: 0.25 })
+     *         .condition("Speed", "greater", 0.1)
+     *     .transition("Walk", "Idle", { duration: 0.25 })
+     *         .condition("Speed", "less", 0.1)
+     *     .build();
+     * ```
+     */
+    static build(name?: string): AnimatorControllerBuilder;
     /**
      * Plays an animation state by name or hash.
      *
@@ -1125,6 +1147,84 @@ export declare class AnimatorController {
     private rootMotionHandler?;
 }
 
+/**
+ * A fluent builder for creating {@link AnimatorController} instances from code.
+ *
+ * Use {@link AnimatorController.build} to create a new builder.
+ *
+ * @example
+ * ```ts
+ * const controller = AnimatorController.build("CharacterController")
+ *     .floatParameter("Speed", 0)
+ *     .triggerParameter("Jump")
+ *     .state("Idle", { clip: idleClip, loop: true })
+ *     .state("Walk", { clip: walkClip, loop: true })
+ *     .state("Jump", { clip: jumpClip })
+ *     .transition("Idle", "Walk", { duration: 0.25 })
+ *         .condition("Speed", "greater", 0.1)
+ *     .transition("Walk", "Idle", { duration: 0.25 })
+ *         .condition("Speed", "less", 0.1)
+ *     .transition("*", "Jump", { duration: 0.1 })
+ *         .condition("Jump", "if")
+ *     .transition("Jump", "Idle", { hasExitTime: true, exitTime: 0.9, duration: 0.25 })
+ *     .build();
+ * ```
+ *
+ * @category Animation and Sequencing
+ * @group Utilities
+ */
+export declare class AnimatorControllerBuilder {
+    private _name;
+    private _parameters;
+    private _states;
+    private _anyStateTransitions;
+    private _defaultStateName;
+    private _lastTransition;
+    constructor(name?: string);
+    /** Adds a float parameter */
+    floatParameter(name: string, defaultValue?: number): this;
+    /** Adds an integer parameter */
+    intParameter(name: string, defaultValue?: number): this;
+    /** Adds a boolean parameter */
+    boolParameter(name: string, defaultValue?: boolean): this;
+    /** Adds a trigger parameter */
+    triggerParameter(name: string): this;
+    /**
+     * Adds a state to the controller. The first state added becomes the default state.
+     * @param name - Unique name for the state
+     * @param options - State configuration including clip, loop, speed
+     */
+    state(name: string, options: StateOptions): this;
+    /**
+     * Adds a transition between two states.
+     * Use `"*"` as the source to create a transition from any state.
+     * Chain `.condition()` calls after this to add conditions.
+     * @param from - Source state name, or `"*"` for any-state transition
+     * @param to - Destination state name
+     * @param options - Transition configuration
+     */
+    transition(from: string, to: string, options?: TransitionOptions): this;
+    /**
+     * Adds a condition to the most recently added transition.
+     * Multiple conditions on the same transition are AND-ed together.
+     * @param parameter - Name of the parameter to evaluate
+     * @param mode - Condition mode: `"if"`, `"ifNot"`, `"greater"`, `"less"`, `"equals"`, `"notEqual"`
+     * @param threshold - Comparison threshold for numeric conditions (default: 0)
+     */
+    condition(parameter: string, mode: ConditionMode, threshold?: number): this;
+    /**
+     * Sets which state is the default/entry state.
+     * If not called, the first added state is used.
+     * @param name - Name of the state
+     */
+    defaultState(name: string): this;
+    /**
+     * Builds and returns the {@link AnimatorController}.
+     * Resolves all state name references to indices.
+     */
+    build(): AnimatorController;
+}
+
 export declare type AnimatorControllerModel = {
     name: string;
     guid: string;
@@ -4006,6 +4106,9 @@ export declare type Condition = {
     threshold: number;
 };
 
+/** String condition modes for the builder, mapped to {@link AnimatorConditionMode} */
+export declare type ConditionMode = "if" | "ifNot" | "greater" | "less" | "equals" | "notEqual";
+
 /** Events regarding the websocket connection (e.g. when the connection opens) */
 export declare enum ConnectionEvents {
     ConnectionInfo = "connection-start-info"
@@ -7516,6 +7619,7 @@ export declare class GroundProjectedEnv extends Component {
     updateProjection(): void;
     private _blurrynessShader;
     private _lastBlurriness;
+    private updateProjectionMaterial;
     private updateBlurriness;
 }
 
@@ -8301,6 +8405,10 @@ export declare class InheritVelocityModule {
     applyCurrent(vel: Vector3 | Vector3_2, t01: number, lerpFactor: number): void;
 }
 
+/** Register the Rapier physics backend. Called from {@link initEngine}
+ * to ensure it runs regardless of tree-shaking. */
+export declare function initPhysics(): void;
+
 /**
  * Handles all input events including mouse, touch, keyboard, and XR controllers.
  * Access via `this.context.input` from any component.
@@ -12900,6 +13008,12 @@ export declare class ObjectUtils {
     private static applyDefaultObjectOptions;
 }
 
+/**
+ * Remove a listener for before an XR session is requested
+ * @param fn The function to remove from the listeners
+ */
+export declare function offBeforeXRSession(fn: (args: XRSessionRequestEventArgs) => void): void;
+
 /* Excluded from this release type: OffscreenCanvasExt */
 
 /**
@@ -13004,6 +13118,21 @@ export declare function onAfterRender(cb: LifecycleMethod, opts?: LifecycleMetho
  * */
 export declare function onBeforeRender(cb: LifecycleMethod, opts?: LifecycleMethodOptions): () => void;
 
+/**
+ * Add a listener that fires before an XR session is requested.
+ * Use this to modify the session init options, e.g. to add optional features like `camera-access`.
+ * @param fn The function to call before the XR session is requested
+ * @example
+ * ```js
+ * onBeforeXRSession((args) => {
+ *   args.init.optionalFeatures ??= [];
+ *   args.init.optionalFeatures.push("camera-access");
+ * });
+ * ```
+ * @return A function to remove the listener
+ */
+export declare function onBeforeXRSession(fn: (args: XRSessionRequestEventArgs) => void): () => void;
+
 /**
  * Register a callback before the engine context is cleared.
  * This happens if e.g. `<needle-engine src>` changes
@@ -13225,8 +13354,9 @@ export declare function onUpdate(cb: LifecycleMethod, opts?: LifecycleMethodOpti
  *    console.log("XR session ended", evt);
  * });
  * ```
+ * @returns A function to remove the listener
  */
-export declare function onXRSessionEnd(fn: (evt: XRSessionEventArgs) => void): void;
+export declare function onXRSessionEnd(fn: (evt: XRSessionEventArgs) => void): () => void;
 
 /**
  * Add a listener for when an XR session starts
@@ -13238,8 +13368,9 @@ export declare function onXRSessionEnd(fn: (evt: XRSessionEventArgs) => void): v
  *   console.log("XR session started", evt);
  * });
  * ```
+ * @returns A function to remove the listener
  */
-export declare function onXRSessionStart(fn: (evt: XRSessionEventArgs) => void): void;
+export declare function onXRSessionStart(fn: (evt: XRSessionEventArgs) => void): () => void;
 
 /**
  * OpenURL behaviour opens a URL in a new tab or window when the object (or any if it's children) is clicked.
@@ -17977,6 +18108,7 @@ export declare class OrbitControls extends Component implements ICameraControlle
      export declare type SessionRequestedEvent = (args: {
          readonly mode: XRSessionMode;
          readonly init: XRSessionInit;
+         readonly context: Context;
      }) => void;
 
      export declare function setActive(go: Object3D, active: boolean | number): boolean;
@@ -19614,6 +19746,24 @@ export declare class OrbitControls extends Component implements ICameraControlle
          instance?: StateMachineBehaviour;
      };
 
+     /**
+      * Configuration for an animation state in the builder
+      */
+     export declare type StateOptions = {
+         /** The animation clip for this state */
+         clip: AnimationClip;
+         /** Whether the animation should loop (default: false) */
+         loop?: boolean;
+         /** Base speed multiplier (default: 1) */
+         speed?: number;
+         /** Name of a float parameter to multiply with speed */
+         speedParameter?: string;
+         /** Normalized cycle offset 0-1 (default: 0) */
+         cycleOffset?: number;
+         /** Name of a float parameter to use as cycle offset */
+         cycleOffsetParameter?: string;
+     };
+
      declare type StickName = "xr-standard-thumbstick" | "xr-standard-touchpad";
 
      export declare class StreamEndedEvent {
@@ -20712,6 +20862,22 @@ export declare class OrbitControls extends Component implements ICameraControlle
          Animation = 3
      }
 
+     /**
+      * Configuration for a transition in the builder
+      */
+     export declare type TransitionOptions = {
+         /** Duration of the crossfade in seconds (default: 0) */
+         duration?: number;
+         /** Normalized exit time 0-1 (default: 1). Only used when hasExitTime is true */
+         exitTime?: number;
+         /** Whether the transition waits for exitTime before transitioning (default: false) */
+         hasExitTime?: boolean;
+         /** Normalized offset into the destination state's animation (default: 0) */
+         offset?: number;
+         /** Whether duration is in seconds (true) or normalized (false) (default: false) */
+         hasFixedDuration?: boolean;
+     };
+
      export declare class TriggerBuilder {
          private static __sceneStartTrigger?;
          static sceneStartTrigger(): TriggerModel;
@@ -23231,6 +23397,12 @@ export declare class OrbitControls extends Component implements ICameraControlle
          session: NeedleXRSession;
      };
 
+     export declare type XRSessionRequestEventArgs = {
+         readonly mode: XRSessionMode;
+         readonly init: XRSessionInit;
+         readonly context: Context;
+     };
+
      export declare class XRState {
          static Global: XRState;
          Mask: XRStateFlag;