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

package/src/engine-components/Component.ts

@@ -11,6 +11,7 @@ import { Context, FrameEvent } from "../engine/engine_setup.js";
 import * as threeutils from "../engine/engine_three_utils.js";
 import type { Collision, ComponentInit, Constructor, ConstructorConcrete, GuidsMap, ICollider, IComponent, IGameObject, SourceIdentifier } from "../engine/engine_types.js";
 import type { INeedleXRSessionEventReceiver, NeedleXRControllerEventArgs, NeedleXREventArgs } from "../engine/engine_xr.js";
+import { isHotReloadEnabled, registerHotReloadType, unregisterHotReloadType } from "../engine/engine_hot_reload.js";
 import { type IPointerEventHandler, PointerEventData } from "./ui/PointerEvents.js";
 
 
@@ -49,7 +50,7 @@ export abstract class GameObject extends Object3D implements Object3D, IGameObje
     /** @deprecated Use {@link addComponent} instead */
     // eslint-disable-next-line deprecation/deprecation
     abstract addNewComponent<T extends IComponent>(type: ConstructorConcrete<T>, init?: ComponentInit<T>): T;
-    
+
     /** 
      * Creates a new component on this gameObject or adds an existing component instance 
      * @param comp Component type constructor or existing component instance
@@ -57,28 +58,28 @@ export abstract class GameObject extends Object3D implements Object3D, IGameObje
      * @returns The newly created or added component
      */
     abstract addComponent<T extends IComponent>(comp: T | ConstructorConcrete<T>, init?: ComponentInit<T>): T;
-    
+
     /**
      * Removes a component from this GameObject
      * @param comp Component instance to remove
      * @returns The removed component
      */
     abstract removeComponent<T extends IComponent>(comp: T): T;
-    
+
     /**
      * Gets an existing component of the specified type or adds a new one if it doesn't exist
      * @param typeName Constructor of the component type to get or add
      * @returns The existing or newly added component
      */
     abstract getOrAddComponent<T>(typeName: ConstructorConcrete<T> | null): T;
-    
+
     /**
      * Gets a component of the specified type attached to this GameObject
      * @param type Constructor of the component type to get
      * @returns The component if found, otherwise null
      */
     abstract getComponent<T>(type: Constructor<T>): T | null;
-    
+
     /**
      * Gets all components of the specified type attached to this GameObject
      * @param type Constructor of the component type to get
@@ -86,14 +87,14 @@ export abstract class GameObject extends Object3D implements Object3D, IGameObje
      * @returns Array of components
      */
     abstract getComponents<T>(type: Constructor<T>, arr?: T[]): Array<T>;
-    
+
     /**
      * Gets a component of the specified type in this GameObject's children hierarchy
      * @param type Constructor of the component type to get
      * @returns The first matching component if found, otherwise null
      */
     abstract getComponentInChildren<T>(type: Constructor<T>): T | null;
-    
+
     /**
      * Gets all components of the specified type in this GameObject's children hierarchy
      * @param type Constructor of the component type to get
@@ -101,14 +102,14 @@ export abstract class GameObject extends Object3D implements Object3D, IGameObje
      * @returns Array of components
      */
     abstract getComponentsInChildren<T>(type: Constructor<T>, arr?: T[]): Array<T>;
-    
+
     /**
      * Gets a component of the specified type in this GameObject's parent hierarchy
      * @param type Constructor of the component type to get
      * @returns The first matching component if found, otherwise null
      */
     abstract getComponentInParent<T>(type: Constructor<T>): T | null;
-    
+
     /**
      * Gets all components of the specified type in this GameObject's parent hierarchy
      * @param type Constructor of the component type to get
@@ -123,19 +124,19 @@ export abstract class GameObject extends Object3D implements Object3D, IGameObje
      */
     abstract get worldPosition(): Vector3
     abstract set worldPosition(val: Vector3);
-    
+
     /**
      * The rotation of this GameObject in world space as a quaternion
      */
     abstract set worldQuaternion(val: Quaternion);
     abstract get worldQuaternion(): Quaternion;
-    
+
     /**
      * The rotation of this GameObject in world space in euler angles (degrees)
      */
     abstract set worldRotation(val: Vector3);
     abstract get worldRotation(): Vector3;
-    
+
     /**
      * The scale of this GameObject in world space
      */
@@ -146,12 +147,12 @@ export abstract class GameObject extends Object3D implements Object3D, IGameObje
      * The forward direction vector of this GameObject in world space
      */
     abstract get worldForward(): Vector3;
-    
+
     /**
      * The right direction vector of this GameObject in world space
      */
     abstract get worldRight(): Vector3;
-    
+
     /**
      * The up direction vector of this GameObject in world space
      */
@@ -577,7 +578,7 @@ export abstract class Component implements IComponent, EventTarget,
     get isComponent(): boolean { return true; }
 
     private __context: Context | undefined;
-    
+
     /**
      * The context this component belongs to, providing access to the runtime environment
      * including physics, timing utilities, camera, and scene
@@ -588,7 +589,7 @@ export abstract class Component implements IComponent, EventTarget,
     set context(context: Context) {
         this.__context = context;
     }
-    
+
     /**
      * Shorthand accessor for the current scene from the context
      * @returns The scene this component belongs to
@@ -624,7 +625,7 @@ export abstract class Component implements IComponent, EventTarget,
             this.__name = str;
         }
     }
-    
+
     /**
      * The tag of the GameObject this component is attached to
      * Used for categorizing objects and efficient lookup
@@ -638,7 +639,7 @@ export abstract class Component implements IComponent, EventTarget,
             this.gameObject.userData.tag = str;
         }
     }
-    
+
     /**
      * Indicates whether the GameObject is marked as static
      * Static objects typically don't move and can be optimized by the engine
@@ -678,7 +679,7 @@ export abstract class Component implements IComponent, EventTarget,
     private get __isActive(): boolean {
         return this.gameObject.visible;
     }
-    
+
     private get __isActiveInHierarchy(): boolean {
         if (!this.gameObject) return false;
         const res = this.gameObject[activeInHierarchyFieldName];
@@ -696,13 +697,13 @@ export abstract class Component implements IComponent, EventTarget,
      * This is a three.js Object3D with additional GameObject functionality
      */
     gameObject!: GameObject;
-    
+
     /**
      * Unique identifier for this component instance,
      * used for finding and tracking components
      */
     guid: string = "invalid";
-    
+
     /**
      * Identifier for the source asset that created this component.
      * For example, URL to the glTF file this component was loaded from
@@ -720,19 +721,19 @@ export abstract class Component implements IComponent, EventTarget,
      * This is the first lifecycle callback to be invoked
      */
     awake() { }
-    
+
     /**
      * Called every time the component becomes enabled or active in the hierarchy.
      * Invoked after {@link awake} and before {@link start}.
      */
     onEnable() { }
-    
+
     /**
      * Called every time the component becomes disabled or inactive in the hierarchy.
      * Invoked when the component or any parent GameObject becomes invisible
      */
     onDisable() { }
-    
+
     /**
      * Called when the component is destroyed.
      * Use for cleanup operations like removing event listeners
@@ -740,7 +741,7 @@ export abstract class Component implements IComponent, EventTarget,
     onDestroy() {
         this.__destroyed = true;
     }
-    
+
     /**
      * Called when a field decorated with @validate() is modified.
      * @param prop The name of the field that was changed
@@ -759,31 +760,31 @@ export abstract class Component implements IComponent, EventTarget,
      * Use for initialization that requires other components to be awake.
      */
     start?(): void;
-    
+
     /**
      * Called at the beginning of each frame before regular updates.
      * Use for logic that needs to run before standard update callbacks.
      */
     earlyUpdate?(): void;
-    
+
     /**
      * Called once per frame during the main update loop.
      * The primary location for frame-based game logic.
      */
     update?(): void;
-    
+
     /**
      * Called after all update functions have been called.
      * Use for calculations that depend on other components being updated first.
      */
     lateUpdate?(): void;
-    
+
     /**
      * Called immediately before the scene is rendered.
      * @param frame Current XRFrame if in an XR session, null otherwise
      */
     onBeforeRender?(frame: XRFrame | null): void;
-    
+
     /**
      * Called after the scene has been rendered.
      * Use for post-processing or UI updates that should happen after rendering
@@ -795,13 +796,13 @@ export abstract class Component implements IComponent, EventTarget,
      * @param col Information about the collision that occurred
      */
     onCollisionEnter?(col: Collision);
-    
+
     /**
      * Called when this component's collider stops colliding with another collider.
      * @param col Information about the collision that ended
      */
     onCollisionExit?(col: Collision);
-    
+
     /**
      * Called each frame while this component's collider is colliding with another collider
      * @param col Information about the ongoing collision
@@ -813,13 +814,13 @@ export abstract class Component implements IComponent, EventTarget,
      * @param col The collider that entered this trigger
      */
     onTriggerEnter?(col: ICollider);
-    
+
     /**
      * Called each frame while another collider is inside this component's trigger collider
      * @param col The collider that is inside this trigger
      */
     onTriggerStay?(col: ICollider);
-    
+
     /**
      * Called when another collider exits this component's trigger collider
      * @param col The collider that exited this trigger
@@ -832,7 +833,7 @@ export abstract class Component implements IComponent, EventTarget,
      * @returns True if the component supports the specified mode
      */
     supportsXR?(mode: XRSessionMode): boolean;
-    
+
     /**
      * Called before an XR session is requested
      * Use to modify session initialization parameters
@@ -840,32 +841,32 @@ export abstract class Component implements IComponent, EventTarget,
      * @param args The session initialization parameters that can be modified
      */
     onBeforeXR?(mode: XRSessionMode, args: XRSessionInit): void;
-    
+
     /**
      * Called when this component joins an XR session or becomes active in a running session
      * @param args Event data for the XR session
      */
     onEnterXR?(args: NeedleXREventArgs): void;
-    
+
     /**
      * Called each frame while this component is active in an XR session
      * @param args Event data for the current XR frame
      */
     onUpdateXR?(args: NeedleXREventArgs): void;
-    
+
     /**
      * Called when this component exits an XR session or becomes inactive during a session
      * @param args Event data for the XR session
      */
     onLeaveXR?(args: NeedleXREventArgs): void;
-    
+
     /**
      * Called when an XR controller is connected or when this component becomes active
      * in a session with existing controllers
      * @param args Event data for the controller that was added
      */
     onXRControllerAdded?(args: NeedleXRControllerEventArgs): void;
-    
+
     /**
      * Called when an XR controller is disconnected or when this component becomes inactive
      * during a session with controllers
@@ -878,31 +879,31 @@ export abstract class Component implements IComponent, EventTarget,
      * @param args Data about the pointer event
      */
     onPointerEnter?(args: PointerEventData);
-    
+
     /**
      * Called when a pointer moves while over this component's GameObject
      * @param args Data about the pointer event
      */
     onPointerMove?(args: PointerEventData);
-    
+
     /**
      * Called when a pointer exits this component's GameObject
      * @param args Data about the pointer event
      */
     onPointerExit?(args: PointerEventData);
-    
+
     /**
      * Called when a pointer button is pressed while over this component's GameObject
      * @param args Data about the pointer event
      */
     onPointerDown?(args: PointerEventData);
-    
+
     /**
      * Called when a pointer button is released while over this component's GameObject
      * @param args Data about the pointer event
      */
     onPointerUp?(args: PointerEventData);
-    
+
     /**
      * Called when a pointer completes a click interaction with this component's GameObject
      * @param args Data about the pointer event
@@ -944,7 +945,7 @@ export abstract class Component implements IComponent, EventTarget,
     startCoroutine(routine: Generator, evt: FrameEvent = FrameEvent.Update): Generator {
         return this.context.registerCoroutineUpdate(this, routine, evt);
     }
-    
+
     /**
      * Stops a coroutine that was previously started with startCoroutine
      * @param routine The routine to be stopped
@@ -997,6 +998,7 @@ export abstract class Component implements IComponent, EventTarget,
         this.__isEnabled = undefined;
         this.__destroyed = false;
         this._internalInit(init as ComponentInit<this>);
+        if (isHotReloadEnabled()) registerHotReloadType(this);
     }
 
     /** @internal */
@@ -1092,6 +1094,7 @@ export abstract class Component implements IComponent, EventTarget,
             this.dispatchEvent(new CustomEvent("destroyed", { detail: this }));
         }
         destroyComponentInstance(this as any);
+        if(isHotReloadEnabled()) unregisterHotReloadType(this);
     }
 
     /**
@@ -1160,7 +1163,7 @@ export abstract class Component implements IComponent, EventTarget,
     get worldQuaternion(): Quaternion {
         return threeutils.getWorldQuaternion(this.gameObject);
     }
-    
+
     /**
      * Sets the rotation of this component's GameObject in world space using a quaternion
      * @param val The world rotation quaternion to set
@@ -1168,7 +1171,7 @@ export abstract class Component implements IComponent, EventTarget,
     set worldQuaternion(val: Quaternion) {
         threeutils.setWorldQuaternion(this.gameObject, val);
     }
-    
+
     /**
      * Sets the rotation of this component's GameObject in world space using quaternion components
      * @param x X component of the quaternion