@needle-tools/engine 4.1.0-beta.6 → 4.1.0-beta.9

package/src/engine/export/gltf/index.ts

@@ -6,6 +6,7 @@ import { AnimationUtils } from "../../engine_animation.js";
 import type { Context } from "../../engine_setup.js";
 import { registerExportExtensions } from "../../extensions/index.js";
 import { __isExporting } from "../state.js";
+import { shouldExport_HideFlags } from "../utils.js";
 import { GizmoWriter as GLTFGizmoWriter, RenderTextureWriter as GLTFRenderTextureWriter } from "./Writers.js";
 
 declare type ExportOptions = {
@@ -49,8 +50,7 @@ export async function exportAsGLTF(_opts: ExportOptions): Promise<ArrayBuffer |
         animations: collectAnimations(context, opts.scene, []),
     }
     const state = new ExporterState();
-
-    console.log("Exporting GLTF", exporterOptions);
+    console.debug("Exporting GLTF", exporterOptions);
     state.onBeforeExport(opts);
     __isExporting(true);
     const res = await exporter.parseAsync(opts.scene, exporterOptions).catch((e) => {
@@ -108,7 +108,17 @@ class ExporterState {
                 }
             }
             mixer.update(0);
-        })
+        });
+
+        opts.context.scene.traverse(obj => {
+            if(!shouldExport_HideFlags(obj)) {
+                const parent = obj.parent;
+                if(parent) {
+                    obj.removeFromParent();
+                    this._undo.push(() => parent.add(obj));
+                }
+            }
+        });
     }
 
     onAfterExport(_opts: Required<ExportOptions>) {

package/src/engine/export/index.ts

@@ -1,2 +1,2 @@
 export * from "./gltf/index.js";
-export { isExporting } from "./state.js";
+export { isExporting } from "./state.js";

package/src/engine/export/utils.ts

@@ -0,0 +1,10 @@
+import { Object3D } from "three";
+
+import { HideFlags } from "../engine_types.js";
+
+
+export function shouldExport_HideFlags(obj: Object3D) {
+    const dontExport = HideFlags.DontExport;
+    if (obj.hideFlags & dontExport) return false;
+    return true;
+}

package/src/engine/extensions/NEEDLE_gameobject_data.ts

@@ -7,7 +7,6 @@ declare type GameObjectData = {
     layers: number,
     visible: boolean,
     tag: string,
-    hideFlags: number,
     static: boolean,
     activeSelf: boolean,
     guid: string
@@ -71,7 +70,7 @@ export class NEEDLE_gameobject_data implements GLTFLoaderPlugin {
 
         node.userData.tag = ext.tag ?? "none";
 
-        node.userData.hideFlags = ext.hideFlags ?? 0;
+        node.hideFlags = 0;
 
         node.userData.static = ext.static ?? false;
 

package/src/engine/js-extensions/Object3D.ts

@@ -15,7 +15,7 @@ import {
     setWorldScale
 }
     from "../../engine/engine_three_utils.js";
-import type { ComponentInit, Constructor, ConstructorConcrete, IComponent as Component, IComponent } from "../../engine/engine_types.js";
+import type { ComponentInit, Constructor, ConstructorConcrete, HideFlags,IComponent as Component, IComponent } from "../../engine/engine_types.js";
 import { applyPrototypeExtensions, registerPrototypeExtensions } from "./ExtensionUtils.js";
 
 
@@ -26,6 +26,11 @@ declare module 'three' {
         get guid(): string | undefined;
         set guid(value: string | undefined);
 
+        /**
+         * Allows to control e.g. if an object should be exported
+         */
+        hideFlags: HideFlags;
+
         /**
          * Add a Needle Engine component to the {@link Object3D}.
          * @param comp The component instance or constructor to add.

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

@@ -1,7 +1,7 @@
 import type { Context } from "../../engine_context.js";
 import { hasCommercialLicense, onLicenseCheckResultChanged } from "../../engine_license.js";
 import { isLocalNetwork } from "../../engine_networking_utils.js";
-import { DeviceUtilities,getParam } from "../../engine_utils.js";
+import { DeviceUtilities, getParam } from "../../engine_utils.js";
 import { onXRSessionStart, XRSessionEventArgs } from "../../xr/events.js";
 import { ButtonsFactory } from "../buttons.js";
 import { ensureFonts, iconFontUrl, loadFont } from "../fonts.js";
@@ -256,7 +256,12 @@ export class NeedleMenuElement extends HTMLElement {
         if (!element && domElement.shadowRoot) {
             element = domElement.shadowRoot.querySelector(elementName);
         }
+        // if no needle-menu was found in the domelement then we search the document body
         if (!element) {
+            element = window.document.body.querySelector(elementName) as NeedleMenuElement | null;
+        }
+        if (!element) {
+            // OK no menu element exists yet anywhere
             element = NeedleMenuElement.create() as NeedleMenuElement;
             if (domElement.shadowRoot)
                 domElement.shadowRoot.appendChild(element);
@@ -682,14 +687,15 @@ export class NeedleMenuElement extends HTMLElement {
         });
 
         try {
-        // if the user has a license then we CAN hide the needle logo
-        onLicenseCheckResultChanged(res => {
-            if (res == true && hasCommercialLicense() && !debugNonCommercial) {
-                let visible = this._userRequestedLogoVisible;
-                if(visible === undefined) visible = false;
-                this.#onSetLogoVisible(visible);
-            }
-        });
+            // if the user has a license then we CAN hide the needle logo
+            // calling this method immediately will cause an issue with vite bundling tho
+            window.requestAnimationFrame(() => onLicenseCheckResultChanged(res => {
+                if (res == true && hasCommercialLicense() && !debugNonCommercial) {
+                    let visible = this._userRequestedLogoVisible;
+                    if (visible === undefined) visible = false;
+                    this.#onSetLogoVisible(visible);
+                }
+            }));
         } catch (e) {
             console.error("[Needle Menu] License check failed.", e);
         }
@@ -824,7 +830,7 @@ export class NeedleMenuElement extends HTMLElement {
         this.logoContainer.style.display = "";
         this.logoContainer.style.opacity = "1";
         this.logoContainer.style.visibility = "visible";
-        if(visible) { 
+        if (visible) {
             this.root.classList.remove("logo-hidden");
             this.root.classList.add("logo-visible");
         }

package/src/engine-components/AvatarLoader.ts

@@ -52,7 +52,7 @@ export class AvatarLoader {
             if (!root) {
                 const opts = new InstantiateOptions();
                 // opts.parent = context.scene.uuid;
-                root = GameObject.instantiate(utils.tryFindObject(avatarId, context.scene), opts);
+                root = GameObject.instantiate(utils.tryFindObject(avatarId, context.scene) as Object3D, opts);
             }
         }
         else root = avatarId;

package/src/engine-components/Component.ts

@@ -1,9 +1,10 @@
 import { Euler, Object3D, Quaternion, Scene, Vector3 } from "three";
 
 import { isDevEnvironment } from "../engine/debug/index.js";
+import { type AssetReference } from "../engine/engine_addressables.js";
 import { addComponent, destroyComponentInstance, findObjectOfType, findObjectsOfType, getComponent, getComponentInChildren, getComponentInParent, getComponents, getComponentsInChildren, getComponentsInParent, getOrAddComponent, removeComponent } from "../engine/engine_components.js";
 import { activeInHierarchyFieldName } from "../engine/engine_constants.js";
-import { destroy, findByGuid, foreachComponent, HideFlags, type IInstantiateOptions, instantiate, isActiveInHierarchy, isActiveSelf, isDestroyed, isUsingInstancing, markAsInstancedRendered, setActive } from "../engine/engine_gameobject.js";
+import { destroy, findByGuid, foreachComponent, type IInstantiateOptions, instantiate, isActiveInHierarchy, isActiveSelf, isDestroyed, isUsingInstancing, markAsInstancedRendered, setActive } from "../engine/engine_gameobject.js";
 import * as main from "../engine/engine_mainloop_utils.js";
 import { syncDestroy, syncInstantiate, SyncInstantiateOptions } from "../engine/engine_networking_instantiate.js";
 import { Context, FrameEvent } from "../engine/engine_setup.js";
@@ -117,15 +118,20 @@ export abstract class GameObject extends Object3D implements Object3D, IGameObje
      */
     public static instantiateSynced(instance: GameObject | Object3D | null, opts: SyncInstantiateOptions): GameObject | null {
         if (!instance) return null;
-        return syncInstantiate(instance as any, opts) as GameObject | null;
+        return syncInstantiate(instance, opts) as GameObject | null;
     }
 
     /** Creates a new instance of the provided object (like cloning it including all components and children) 
      * @param instance object to instantiate
      * @param opts options for the instantiation (e.g. with what parent, position, etc.)
     */
-    public static instantiate(instance: GameObject | Object3D, opts: IInstantiateOptions | null = null): GameObject {
-        return instantiate(instance, opts) as GameObject;
+    public static instantiate(instance: AssetReference, opts?: IInstantiateOptions | null | undefined): Promise<Object3D | null>
+    public static instantiate(instance: GameObject | Object3D, opts?: IInstantiateOptions | null | undefined): GameObject
+    public static instantiate(instance: AssetReference | GameObject | Object3D, opts: IInstantiateOptions | null | undefined = null): GameObject | Promise<Object3D | null> {
+        if ('isAssetReference' in instance) {
+            return instantiate(instance as AssetReference, opts);
+        }
+        return instantiate(instance as GameObject | Object3D, opts) as GameObject;
     }
 
     /** Destroys a object on all connected clients (if you are in a networked session) 
@@ -398,9 +404,9 @@ export abstract class Component implements IComponent, EventTarget,
             this.gameObject.userData.static = value;
         }
     }
-    get hideFlags(): HideFlags {
-        return this.gameObject?.userData.hideFlags;
-    }
+    // get hideFlags(): HideFlags {
+    //     return this.gameObject?.hideFlags;
+    // }
 
     /** @returns true if the object is enabled and active in the hierarchy */
     get activeAndEnabled(): boolean {

package/src/engine-components/ContactShadows.ts

@@ -9,7 +9,7 @@ import { Gizmos } from "../engine/engine_gizmos.js";
 import { onStart } from "../engine/engine_lifecycle_api.js";
 import { serializable } from "../engine/engine_serialization_decorator.js";
 import { getBoundingBox, getVisibleInCustomShadowRendering } from "../engine/engine_three_utils.js";
-import { IGameObject, Vec3 } from "../engine/engine_types.js";
+import { HideFlags, IGameObject, Vec3 } from "../engine/engine_types.js";
 import { getParam } from "../engine/engine_utils.js"
 import { setCustomVisibility } from "../engine/js-extensions/Layers.js";
 import { Behaviour, GameObject } from "./Component.js";
@@ -37,7 +37,7 @@ onStart(ctx => {
  */
 export class ContactShadows extends Behaviour {
 
-    private static _instances: Map<Context, ContactShadows> = new Map();
+    private static readonly _instances: Map<Context, ContactShadows> = new Map();
     /**
      * Create contact shadows for the scene. Automatically fits the shadows to the scene.  
      * The instance of contact shadows will be created only once.  
@@ -162,10 +162,14 @@ export class ContactShadows extends Behaviour {
 
     /** @internal */
     awake() {
+        ContactShadows._instances.set(this.context, this);
+        this.shadowsRoot.hideFlags = HideFlags.DontExport;
+
         // ignore self for autofitting
         setAutoFitEnabled(this.shadowsRoot, false);
     }
 
+
     /** @internal */
     start(): void {
         if (debug) console.log("Create ContactShadows on " + this.gameObject.name, this)
@@ -280,6 +284,11 @@ export class ContactShadows extends Behaviour {
 
     /** @internal */
     onDestroy(): void {
+        const instance = ContactShadows._instances.get(this.context);
+        if (instance === this) {
+            ContactShadows._instances.delete(this.context);
+        }
+
         // dispose the render targets
         this.renderTarget?.dispose();
         this.renderTargetBlur?.dispose();

package/src/engine-components/SceneSwitcher.ts

@@ -760,7 +760,7 @@ export class SceneSwitcher extends Behaviour {
             }
             this._lastLoadingScene = this.loadingScene;
             if (!this._loadingScenePromise) {
-                this._loadingScenePromise = this.loadingScene?.loadAssetAsync();
+                this._loadingScenePromise = this.loadingScene?.loadAssetAsync().then(res => res != null);
             }
             await this._loadingScenePromise;
             if (this._isCurrentlyLoading && this.loadingScene?.asset) {

package/src/engine-components/export/gltf/GltfExport.ts

@@ -6,6 +6,8 @@ import { SerializationContext } from "../../../engine/engine_serialization_core.
 import { serializable } from "../../../engine/engine_serialization_decorator.js";
 import { getWorldPosition } from "../../../engine/engine_three_utils.js";
 import { getParam } from "../../../engine/engine_utils.js";
+import { RenderTextureWriter } from "../../../engine/export/gltf/Writers.js";
+import { shouldExport_HideFlags } from "../../../engine/export/utils.js";
 import { registerExportExtensions } from "../../../engine/extensions/index.js";
 import { NEEDLE_components } from "../../../engine/extensions/NEEDLE_components.js";
 import GLTFMeshGPUInstancingExtension from '../../../include/three/EXT_mesh_gpu_instancing_exporter.js';
@@ -48,8 +50,8 @@ export class GltfExport extends Behaviour {
         if (!this.objects || this.objects.length <= 0)
             this.objects = [this.context.scene];
 
-        const options = { 
-            binary: this.binary, 
+        const options = {
+            binary: this.binary,
             pivot: GltfExport.calculateCenter(this.objects),
             ...opts
         };
@@ -74,6 +76,15 @@ export class GltfExport extends Behaviour {
 
     async export(objectsToExport: Object3D[], opts?: ExportOptions): Promise<any> {
 
+        // -----------------------
+        // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+        // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+        // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+        // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+        // TODO: refactor this to use ../engine/export/index exportAsGLTF function
+
+        // TODO add filtering / tags for what to export and what not < this is implemented in exportAsGLTF, see TODO above
+
         if (!objectsToExport || objectsToExport.length <= 0) {
             console.warn("No objects set to export");
             return;
@@ -82,12 +93,11 @@ export class GltfExport extends Behaviour {
         // Instantiate a exporter
         const exporter = new GLTFExporter();
         exporter.register(writer => new GLTFMeshGPUInstancingExtension(writer));
+        exporter.register(writer => new RenderTextureWriter(writer));
         registerExportExtensions(exporter, this.context);
 
         GltfExport.filterTopmostParent(objectsToExport);
 
-        // TODO export only worldglb BUT exclude "World" child which contains all build tools
-        // TODO add filtering / tags for what to export and what not
 
         // https://threejs.org/docs/#examples/en/exporters/GLTFExporter
         const options = {
@@ -102,7 +112,7 @@ export class GltfExport extends Behaviour {
             ...opts
         };
 
-        // hide objects that we don't want to export
+        const undo = new Array<() => void>();
 
         const exportScene = new Object3D();
         // set the pivot position
@@ -112,7 +122,7 @@ export class GltfExport extends Behaviour {
         // add objects for export
         if (debugExport) console.log("EXPORT", objectsToExport);
         objectsToExport.forEach(obj => {
-            if (obj) {
+            if (obj && shouldExport_HideFlags(obj)) {
                 // adding directly does not require us to change parents and mess with the hierarchy actually
                 exportScene.children.push(obj);
                 // TODO: we should probably be doing this before writing nodes?? apply world scale, position, rotation etc for export only
@@ -122,6 +132,15 @@ export class GltfExport extends Behaviour {
                 GameObject.getComponentsInChildren(obj, Renderer).forEach(r => {
                     if (GameObject.isActiveInHierarchy(r.gameObject)) r.setInstancingEnabled(false)
                 });
+                obj.traverse(o => {
+                    if (!shouldExport_HideFlags(o)) {
+                        const parent = o.parent;
+                        o.removeFromParent();
+                        undo.push(() => {
+                            if (parent) parent.add(o);
+                        });
+                    }
+                })
             }
         });
 
@@ -159,6 +178,7 @@ export class GltfExport extends Behaviour {
                 reject(err);
             }
             finally {
+                undo.forEach(u => u());
                 if (debugExport) console.log("Finished glTF export.");
             }
         });

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

@@ -101,7 +101,7 @@ export class Avatar extends Behaviour {
             headObj.quaternion.x *= -1;
 
             // HACK: XRFlag limitation workaround to make sure first person user head is never rendered
-            if (this.context.time.frameCount % 10 === 0) {
+            if (this.context.time.frameCount % 10 === 0 && this.head.asset) {
                 const xrflags = GameObject.getComponentsInChildren(this.head.asset, XRFlag);
                 for (const flag of xrflags) {
                     flag.enabled = false;
@@ -242,9 +242,9 @@ export class Avatar extends Behaviour {
         await this.loadAvatarObjects(this.head, this.leftHand, this.rightHand);
 
         this._leftHandMeshes = [];
-        this.leftHand.asset.traverse((obj) => { if ((obj as Mesh)?.isMesh) this._leftHandMeshes!.push(obj); });
+        this.leftHand.asset?.traverse((obj) => { if ((obj as Mesh)?.isMesh) this._leftHandMeshes!.push(obj as Mesh); });
         this._rightHandMeshes = [];
-        this.rightHand.asset.traverse((obj) => { if ((obj as Mesh)?.isMesh) this._rightHandMeshes!.push(obj); });
+        this.rightHand.asset?.traverse((obj) => { if ((obj as Mesh)?.isMesh) this._rightHandMeshes!.push(obj as Mesh); });
 
         if (PlayerState.isLocalPlayer(this.gameObject)) {
             this._syncTransforms = GameObject.getComponentsInChildren(this.gameObject, SyncedTransform);

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

@@ -4,6 +4,7 @@ import { Object3DEventMap } from "three";
 import { isDevEnvironment, showBalloonWarning } from "../../engine/debug/index.js";
 import { AssetReference } from "../../engine/engine_addressables.js";
 import { serializable } from "../../engine/engine_serialization.js";
+import { IGameObject } from "../../engine/engine_types.js";
 import { CircularBuffer, DeviceUtilities, getParam } from "../../engine/engine_utils.js";
 import { type NeedleXREventArgs, NeedleXRSession } from "../../engine/xr/api.js";
 import { IUSDExporterExtension } from "../../engine-components/export/usdz/Extension.js";
@@ -355,7 +356,7 @@ export class WebXRImageTracking extends Behaviour {
         }
     }
 
-    private readonly imageToObjectMap = new Map<WebXRImageTrackingModel, { object: GameObject | null, frames: number, lastTrackingTime: number }>();
+    private readonly imageToObjectMap = new Map<WebXRImageTrackingModel, { object: Object3D | null, frames: number, lastTrackingTime: number }>();
     private readonly currentImages: WebXRTrackedImage[] = [];
 
     
@@ -456,7 +457,7 @@ export class WebXRImageTracking extends Behaviour {
                 trackedData = { object: null, frames: 0, lastTrackingTime: Date.now() };
                 this.imageToObjectMap.set(model, trackedData);
 
-                model.object.loadAssetAsync().then((asset: GameObject | null) => {
+                model.object.loadAssetAsync().then((asset: Object3D | null) => {
                     if (model.createObjectInstance && asset) {
                         asset = GameObject.instantiate(asset);
                     }
@@ -475,7 +476,7 @@ export class WebXRImageTracking extends Behaviour {
                         if (xr.rig) {
                             xr.rig.gameObject.add(asset);
                             image.applyToObject(asset);
-                            if (!asset.activeSelf)
+                            if (!(asset as IGameObject).activeSelf)
                                 GameObject.setActive(asset, true);
                             // InstancingUtil.markDirty(asset);
                         }
@@ -503,7 +504,7 @@ export class WebXRImageTracking extends Behaviour {
                     xr.rig.gameObject.add(trackedData.object);
 
                     image.applyToObject(trackedData.object, this.smooth ? this.context.time.deltaTimeUnscaled * 3 : undefined);
-                    if (!trackedData.object.activeSelf) {
+                    if (!(trackedData.object as IGameObject).activeSelf) {
                         GameObject.setActive(trackedData.object, true);
                     }
                     // InstancingUtil.markDirty(trackedData.object);

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

@@ -36,7 +36,7 @@ export class PlayerSync extends Behaviour {
         const assetReference = AssetReference.getOrCreateFromUrl(url);
         if (!assetReference.asset) {
             const i = await assetReference.loadAssetAsync();
-            GameObject.getOrAddComponent(i, PlayerState);
+            if(i) GameObject.getOrAddComponent(i, PlayerState);
         }
         const ps = new PlayerSync();
         ps._internalInit(init);