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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@needle-tools/engine",
-  "version": "4.1.0-beta.8",
+  "version": "4.1.0-beta.9",
   "description": "Needle Engine is a web-based runtime for 3D apps. It runs on your machine for development with great integrations into editors like Unity or Blender - and can be deployed onto any device! It is flexible, extensible and networking and XR are built-in",
   "main": "dist/needle-engine.min.js",
   "exports": {
@@ -86,7 +86,7 @@
   ],
   "dependencies": {
     "@dimforge/rapier3d-compat": "^0.14.0",
-    "@needle-tools/gltf-progressive": "^2.1.0-alpha.5",
+    "@needle-tools/gltf-progressive": "^2.1.0-alpha.6",
     "@webxr-input-profiles/motion-controllers": "^1.0.0",
     "flatbuffers": "2.0.4",
     "md5": "^2.3.0",

package/src/engine/engine_gameobject.ts

@@ -18,19 +18,6 @@ import { apply } from "./js-extensions/index.js";
 const debug = getParam("debuggetcomponent");
 const debugInstantiate = getParam("debuginstantiate");
 
-/** @internal */
-export enum HideFlags {
-    None = 0,
-    HideInHierarchy = 1,
-    HideInInspector = 2,
-    DontSaveInEditor = 4,
-    NotEditable = 8,
-    DontSaveInBuild = 16, // 0x00000010
-    DontUnloadUnusedAsset = 32, // 0x00000020
-    DontSave = DontUnloadUnusedAsset | DontSaveInBuild | DontSaveInEditor, // 0x00000034
-    HideAndDontSave = DontSave | NotEditable | HideInHierarchy, // 0x0000003D
-}
-
 export type IInstantiateOptions = {
     idProvider?: UIDProvider;
     //** parent guid or object */

package/src/engine/engine_types.ts

@@ -90,6 +90,12 @@ export declare interface INeedleEngineComponent extends HTMLElement {
     onExitAR(session: XRSession);
 }
 
+export enum HideFlags {
+    None = 0,
+    /** When enabled the glTF exporter will omit this object and all children from being exported */
+    DontExport = 1 << 0,
+}
+
 export declare interface IGameObject extends Object3D {
 
     /** the object's unique identifier */

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

@@ -1,4 +1,3 @@
-
 import { Object3D, Texture } from 'three';
 import { GLTFExporterPlugin, GLTFWriter } from 'three/examples/jsm/exporters/GLTFExporter.js';
 

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-components/Component.ts

@@ -4,7 +4,7 @@ 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";
@@ -404,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/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.");
             }
         });