@needle-tools/engine 3.5.3-alpha → 3.5.4-alpha

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@needle-tools/engine",
-    "version": "3.5.3-alpha",
+    "version": "3.5.4-alpha",
     "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.umd.cjs",
     "type": "module",

package/plugins/vite/defines.js

@@ -1,19 +1,26 @@
 import { loadConfig } from "./config.js";
+import { tryGetNeedleEngineVersion } from "./utils.js";
 
 /** used to pass config variables into vite.config.define
  * for example "useRapier"
  */
-export const needleDefines = (command, config, userSettings) => {
+export const needleDefines = (command, needleEngineConfig, userSettings) => {
 
     if (!userSettings) userSettings = {};
 
     let useRapier = true;
-    if (config.useRapier === false || userSettings?.useRapier === false) useRapier = false;
+    if (needleEngineConfig.useRapier === false || userSettings?.useRapier === false) useRapier = false;
 
     return {
         name: 'needle-defines',
         enforce: 'pre',
-        config(config) {
+        config(viteConfig) {
+            if (!viteConfig.define) viteConfig.define = {};
+            viteConfig.define.NEEDLE_ENGINE_META = {
+                version: tryGetNeedleEngineVersion(),
+                generator: needleEngineConfig.generator,
+            }
+
             if (useRapier && userSettings?.useRapier !== true) {
                 const meta = loadConfig();
                 if (meta?.useRapier === false) {
@@ -21,9 +28,8 @@ export const needleDefines = (command, config, userSettings) => {
                 }
             }
             console.log("UseRapier?", useRapier);
-            if (!config.define) config.define = {};
-            if (config.define.NEEDLE_USE_RAPIER === undefined) {
-                config.define.NEEDLE_USE_RAPIER = useRapier;
+            if (viteConfig.define.NEEDLE_USE_RAPIER === undefined) {
+                viteConfig.define.NEEDLE_USE_RAPIER = useRapier;
             }
         }
     }

package/plugins/vite/meta.js

@@ -1,6 +1,7 @@
 import { loadConfig } from './config.js';
 import fs from 'fs';
 import { getPosterPath } from './poster.js';
+import { tryGetNeedleEngineVersion } from './utils.js';
 
 export const needleMeta = (command, config, userSettings) => {
 
@@ -15,7 +16,7 @@ export const needleMeta = (command, config, userSettings) => {
 
     return {
         // replace meta tags
-        name: 'needle-meta-tags',
+        name: 'needle-meta',
         transformIndexHtml: {
             enforce: 'pre',
             transform(html, _ctx) {
@@ -91,8 +92,19 @@ export const needleMeta = (command, config, userSettings) => {
                     }
                 }
 
-                // if(!tags.filter(t => t.attrs?.name === "generator"))
-                    tags.push({ tag: 'meta', attrs: { name: 'generator', content: 'Needle' } });
+                let generator = "Needle";
+                if (config.generator?.length > 5) {
+                    generator = config.generator;
+                }
+                tags.push({ tag: 'meta', attrs: { name: 'generator', content: generator } });
+
+                const needleEngineVersion = tryGetNeedleEngineVersion();
+                if (needleEngineVersion) {
+                    if (command === "build")
+                        console.log("Needle Engine version: " + needleEngineVersion);
+                    tags.push({ tag: 'meta', attrs: { name: 'needle-engine', content: needleEngineVersion } });
+                }
+                else console.log("WARN: could not find needle engine package.json")
 
                 return { html, tags }
             },
@@ -100,6 +112,7 @@ export const needleMeta = (command, config, userSettings) => {
     }
 }
 
+
 function updateUrlMetaTag(html, url) {
     html = html.replace(`<meta name="url" content="http://needle.tools">`, `<meta name="url" content="${url}">`);
     return html;

package/plugins/vite/utils.js

@@ -0,0 +1,11 @@
+import { existsSync, readFileSync } from "fs";
+
+export function tryGetNeedleEngineVersion() {
+    const needleEnginePackageJsonPath = process.cwd() + "/node_modules/@needle-tools/engine/package.json";
+    if (existsSync(needleEnginePackageJsonPath)) {
+        const json = JSON.parse(readFileSync(needleEnginePackageJsonPath));
+        const version = json.version;
+        return version;
+    }
+    return null;
+}

package/src/engine/codegen/register_types.js

@@ -54,6 +54,7 @@ import { ColorBySpeedModule } from "../../engine-components/ParticleSystemModule
 import { ColorOverLifetimeModule } from "../../engine-components/ParticleSystemModules";
 import { Component } from "../../engine-components/Component";
 import { ControlTrackHandler } from "../../engine-components/timeline/TimelineTracks";
+import { CustomBranding } from "../../engine-components/export/usdz/USDZExporter";
 import { Deletable } from "../../engine-components/DeleteBox";
 import { DeleteBox } from "../../engine-components/DeleteBox";
 import { DepthOfField } from "../../engine-components/postprocessing/Effects/DepthOfField";
@@ -126,7 +127,6 @@ import { PostProcessingHandler } from "../../engine-components/postprocessing/Po
 import { PreliminaryAction } from "../../engine-components/export/usdz/extensions/behavior/BehaviourComponents";
 import { PreliminaryTrigger } from "../../engine-components/export/usdz/extensions/behavior/BehaviourComponents";
 import { PresentationMode } from "../../engine-components-experimental/Presentation";
-import { QuickLookOverlay } from "../../engine-components/export/usdz/USDZExporter";
 import { RawImage } from "../../engine-components/ui/Image";
 import { Raycaster } from "../../engine-components/ui/Raycaster";
 import { Rect } from "../../engine-components/ui/RectTransform";
@@ -270,6 +270,7 @@ TypeStore.add("ColorBySpeedModule", ColorBySpeedModule);
 TypeStore.add("ColorOverLifetimeModule", ColorOverLifetimeModule);
 TypeStore.add("Component", Component);
 TypeStore.add("ControlTrackHandler", ControlTrackHandler);
+TypeStore.add("CustomBranding", CustomBranding);
 TypeStore.add("Deletable", Deletable);
 TypeStore.add("DeleteBox", DeleteBox);
 TypeStore.add("DepthOfField", DepthOfField);
@@ -342,7 +343,6 @@ TypeStore.add("PostProcessingHandler", PostProcessingHandler);
 TypeStore.add("PreliminaryAction", PreliminaryAction);
 TypeStore.add("PreliminaryTrigger", PreliminaryTrigger);
 TypeStore.add("PresentationMode", PresentationMode);
-TypeStore.add("QuickLookOverlay", QuickLookOverlay);
 TypeStore.add("RawImage", RawImage);
 TypeStore.add("Raycaster", Raycaster);
 TypeStore.add("Rect", Rect);

package/src/engine/engine_addressables.ts

@@ -353,7 +353,7 @@ new AddressableSerializer();
 
 
 
-
+const failedTexturePromise = Promise.resolve(null);
 
 export class ImageReference {
 
@@ -392,6 +392,7 @@ export class ImageReference {
 
     private loader: TextureLoader | null = null;
     createTexture(): Promise<Texture | null> {
+        if (!this.url) return failedTexturePromise;
         if (!this.loader) this.loader = new TextureLoader();
         this.loader.setCrossOrigin("anonymous");
         return this.loader.loadAsync(this.url);

package/src/engine/engine_constants.ts

@@ -1,3 +1,6 @@
+declare const NEEDLE_ENGINE_META: { version: string, generator: string };
+export const NEEDLE_ENGINE_VERSION = NEEDLE_ENGINE_META.version;
+export const NEEDLE_ENGINE_GENERATOR = NEEDLE_ENGINE_META.generator;
 
 export const activeInHierarchyFieldName = "needle_isActiveInHierarchy";
 export const builtinComponentKeyName = "builtin_components";

package/src/engine/engine_context.ts

@@ -29,6 +29,7 @@ import { CoroutineData, ICamera, IComponent, IContext, ILight } from "./engine_t
 import { destroy, foreachComponent } from './engine_gameobject';
 import { ContextEvent, ContextRegistry } from './engine_context_registry';
 import { delay } from './engine_utils';
+import { NEEDLE_ENGINE_VERSION } from './engine_constants';
 // import { createCameraWithOrbitControl } from '../engine-components/CameraUtils';
 
 
@@ -93,6 +94,11 @@ export function registerComponent(script: IComponent, context?: Context) {
 
 export class Context implements IContext {
 
+	/** the needle engine version */
+	get version() {
+		return NEEDLE_ENGINE_VERSION;
+	}
+
 	static get Current(): Context {
 		return ContextRegistry.Current as Context;
 	}

package/src/engine/engine_serialization_core.ts

@@ -436,7 +436,7 @@ function implictlyAssignPrimitiveTypes(obj: any, serializedData: any) {
                 if (isPrimitiveType(data[key]) && !isPrimitiveType(member)) {
 
                     const prop = tryFindPropertyDescriptor(member, key);
-                    if (!prop?.writable === false || (prop && prop.set === undefined)) {
+                    if (prop && (prop?.writable === undefined || prop?.writable === false) && (prop.set === undefined)) {
                         if (debug)
                             console.warn("Property is not writable \"" + key + "\"", member, prop, data[key], member[key]);
                         continue;

package/src/engine-components/codegen/components.ts

@@ -52,6 +52,7 @@ export { ColorBySpeedModule } from "../ParticleSystemModules";
 export { ColorOverLifetimeModule } from "../ParticleSystemModules";
 export { Component } from "../Component";
 export { ControlTrackHandler } from "../timeline/TimelineTracks";
+export { CustomBranding } from "../export/usdz/USDZExporter";
 export { Deletable } from "../DeleteBox";
 export { DeleteBox } from "../DeleteBox";
 export { DepthOfField } from "../postprocessing/Effects/DepthOfField";
@@ -121,7 +122,6 @@ export { PointerEventData } from "../ui/PointerEvents";
 export { PostProcessingHandler } from "../postprocessing/PostProcessingHandler";
 export { PreliminaryAction } from "../export/usdz/extensions/behavior/BehaviourComponents";
 export { PreliminaryTrigger } from "../export/usdz/extensions/behavior/BehaviourComponents";
-export { QuickLookOverlay } from "../export/usdz/USDZExporter";
 export { RawImage } from "../ui/Image";
 export { Raycaster } from "../ui/Raycaster";
 export { Rect } from "../ui/RectTransform";

package/src/engine-components/export/usdz/USDZExporter.ts

@@ -18,7 +18,7 @@ import { AudioExtension } from "./extensions/behavior/AudioExtension";
 
 const debug = getParam("debugusdz");
 
-export class QuickLookOverlay {
+export class CustomBranding {
     @serializable()
     callToAction?: string;
     @serializable()
@@ -45,8 +45,8 @@ export class USDZExporter extends Behaviour {
     @serializable(URL)
     customUsdzFile?: string;
 
-    @serializable(QuickLookOverlay)
-    overlay?: QuickLookOverlay;
+    @serializable(CustomBranding)
+    customBranding?: CustomBranding;
 
     // Currently not exposed to integrations - not fully tested. Set from code (e.g. image tracking)
     @serializable()
@@ -66,6 +66,7 @@ export class USDZExporter extends Behaviour {
     private webARSessionRoot: WebARSessionRoot | undefined;
 
     start() {
+        console.log(this.customUsdzFile);
         if (debug) {
             console.log(this);
             console.log("Debug USDZ, press 't' to export")
@@ -249,16 +250,27 @@ export class USDZExporter extends Behaviour {
                     if (debug)
                         showBalloonMessage("Quicklook url: " + callToActionURL);
                     if (callToActionURL) {
-                        globalThis.open(callToActionURL, "_blank");
+                        if (!hasProLicense()) {
+                            console.warn("Quicklook closed: custom redirects require a Needle Engine Pro license: https://needle.tools/pricing", callToActionURL)
+                        }
+                        else {
+                            globalThis.open(callToActionURL, "_blank");
+                        }
                     }
                 }
             }
         }
     }
 
-    private buildQuicklookOverlay(): QuickLookOverlay {
-        const obj: QuickLookOverlay = {};
-        if (this.overlay) Object.assign(obj, this.overlay);
+    private buildQuicklookOverlay(): CustomBranding {
+        const obj: CustomBranding = {};
+        if (this.customBranding) Object.assign(obj, this.customBranding);
+        if (!hasProLicense()) {
+            console.log("Custom Quicklook banner text requires pro license: https://needle.tools/pricing");
+            obj.callToAction = "Close";
+            obj.checkoutTitle = "🌵 Made with Needle";
+            obj.checkoutSubtitle = "_";
+        }
         if (!obj.callToAction?.length)
             obj.callToAction = "Close";
         if (!obj.checkoutTitle?.length)

package/src/engine-components/ui/Graphic.ts

@@ -174,7 +174,6 @@ export class Graphic extends BaseUIComponent implements IGraphic, IRectTransform
     static textureCache: Map<Texture, Texture> = new Map();
 
     protected async setTexture(tex: Texture | null | undefined) {
-        if (!tex) return;
         this.setOptions({ backgroundOpacity: 0 });
         if (tex) {
             // workaround for https://github.com/needle-tools/needle-engine-support/issues/109
@@ -190,6 +189,9 @@ export class Graphic extends BaseUIComponent implements IGraphic, IRectTransform
             }
             this.setOptions({ backgroundImage: tex, borderRadius: 0, backgroundOpacity: this.color.alpha, backgroundSize: "stretch" });
         }
+        else {
+            this.setOptions({ backgroundImage: null, borderRadius: 0, backgroundOpacity: this.color.alpha });
+        }
     }
 
     protected onAfterAddedToScene(): void {

package/src/engine-components/ui/Text.ts

@@ -61,10 +61,11 @@ export class Text extends Graphic {
     }
 
     set text(val: string) {
-
-
-        this._text = val;
-        this.feedText(this.text, this.supportRichText);
+        if (val !== this._text) {
+            this._text = val;
+            this.feedText(this.text, this.supportRichText);
+            this.markDirty();
+        }
     }
 
     private set_text(val: string) {

package/src/needle-engine.ts

@@ -1,6 +1,8 @@
 import { makeErrorsVisibleForDevelopment } from "./engine/debug/debug_overlay";
 makeErrorsVisibleForDevelopment();
 
+import { NEEDLE_ENGINE_GENERATOR, NEEDLE_ENGINE_VERSION } from "./engine/engine_constants";
+
 import "./engine/engine_element";
 import "./engine/engine_setup";
 import "./engine-components/CameraUtils"
@@ -9,6 +11,7 @@ export * from "./engine/api";
 export * from "./engine-components/api";
 export * from "./engine-components-experimental/api";
 
+
 // make accessible for external javascript
 import { Context } from "./engine/engine_setup";
 const Needle = { Context: Context };
@@ -27,6 +30,12 @@ registerGlobal(Component);
 import * as Components from "./engine-components/codegen/components";
 registerGlobal(Components);
 
+Needle["$meta"] = {
+    version: NEEDLE_ENGINE_VERSION,
+    generator: NEEDLE_ENGINE_GENERATOR
+};
+
+
 import { GameObject } from "./engine-components/Component";
 for (const method of Object.getOwnPropertyNames(GameObject)) {
     switch (method) {
@@ -50,4 +59,4 @@ else console.warn("Threejs is already imported");
 
 
 
-import "./engine/engine_license";
+import "./engine/engine_license";