@needle-tools/engine 3.5.8-alpha → 3.5.9-alpha

package/plugins/types/userconfig.d.ts

@@ -0,0 +1,27 @@
+
+
+export type needleModules = {
+    webpack: object | undefined
+}
+
+export type userSettings = {
+    /** disable vite.alias modification */
+    noAlias: boolean;
+    /** disable automatic copying of files to include and output directory (dist) */
+    noCopy: boolean;
+    /** set to false to tree-shake rapier physics engine to the reduce bundle size */
+    useRapier: boolean;
+    noDependencyWatcher: boolean;
+    /** set to false to suppress editor-sync package installation and connection */
+    dontInstallEditor: boolean;
+    /** set to false to prevent meta.html modifications (vite only) */
+    allowMetaPlugin: boolean;
+    /** set to true to prevent injecting peerjs `parcelRequire` global variable declaration */
+    noPeer: boolean;
+    /** set to true to disable reload plugin */
+    noReload: boolean;
+    noCodegenTransform: boolean;
+
+    /** used by nextjs config to forward the webpack module */
+    modules: needleModules
+}

package/plugins/vite/alias.js

@@ -25,6 +25,9 @@ const packages_to_resolve = {
     'md5': null,
 }
 
+/**
+ * @param {import('../types').userSettings} userSettings
+ */
 export const needleViteAlias = (command, config, userSettings) => {
 
     if (config?.noAlias === true || userSettings?.noAlias === true)

package/plugins/vite/config.js

@@ -17,7 +17,9 @@ export async function loadConfig(path) {
         if (existsSync(path)) {
             const text = readFileSync(path, 'utf8');
             if (!text) return null;
-            return JSON.parse(text);
+            /**@type {import("../types/needleConfig").needleConfig} */
+            const meta = JSON.parse(text);
+            return meta;
         }
         else console.error("Could not find config file at " + path);
         return null;
@@ -51,7 +53,7 @@ export function tryLoadProjectConfig() {
 
 
 /** "assets" -> the directory name inside the output directory to put e.g. glb files into */
-export function builtAssetsDirectory(){
+export function builtAssetsDirectory() {
     return "assets";
 }
 

package/plugins/vite/copyfiles.js

@@ -4,7 +4,9 @@ import { existsSync, statSync, mkdirSync, readdirSync, copyFileSync, mkdir } fro
 import { builtAssetsDirectory, tryLoadProjectConfig } from './config.js';
 
 
-/** copy files on build from assets to dist */
+/** copy files on build from assets to dist 
+ * @param {import('../types').userSettings} userSettings
+ */
 export const needleCopyFiles = (command, config, userSettings) => {
 
     if (config?.noCopy === true || userSettings?.noCopy === true) {

package/plugins/vite/defines.js

@@ -9,6 +9,9 @@ import { tryGetNeedleEngineVersion } from "./utils.js";
 
 // https://vitejs.dev/config/#using-environment-variables-in-config
 
+/**
+ * @param {import('../types').userSettings} userSettings
+ */
 export const needleDefines = (command, needleEngineConfig, userSettings) => {
 
     if (!userSettings) userSettings = {};

package/plugins/vite/dependency-watcher.js

@@ -8,6 +8,9 @@ function log(...msg) {
     console.log(prefix, ...msg)
 }
 
+/**
+ * @param {import('../types').userSettings} userSettings
+ */
 export const needleDependencyWatcher = (command, config, userSettings) => {
     if (command === "build") return;
 

package/plugins/vite/editor-connection.js

@@ -12,6 +12,9 @@ const editorSyncPackageName = "@needle-tools/editor-sync"
 */
 let editorSyncEnabled = false;
 
+/**
+ * @param {import('../types').userSettings} userSettings
+ */
 export const editorConnection = async (command, config, userSettings, pluginsArray) => {
     if (command === "build") return;
 

package/plugins/vite/index.js

@@ -20,7 +20,11 @@ const defaultUserSettings = {
     allowHotReload: true,
 }
 
+/**
+ * @param {import('../types').userSettings} userSettings
+ */
 export const needlePlugins = async (command, config, userSettings) => {
+
     // ensure we have user settings initialized with defaults
     userSettings = { ...defaultUserSettings, ...userSettings }
     const array = [

package/plugins/vite/meta.js

@@ -3,6 +3,9 @@ import fs from 'fs';
 import { getPosterPath } from './poster.js';
 import { tryGetNeedleEngineVersion } from './utils.js';
 
+/**
+ * @param {import('../types').userSettings} userSettings
+ */
 export const needleMeta = (command, config, userSettings) => {
 
     // we can check if this is a build

package/plugins/vite/peer.js

@@ -3,6 +3,9 @@ const peerjsString = `/* needle: injected fix for peerjs */
 window.global = window;
 var parcelRequire;`
 
+/**
+ * @param {import('../types').userSettings} userSettings
+ */
 export const needlePeerjs = (command, config, userSettings) => {
 
     if (userSettings.noPeer === true) return;

package/plugins/vite/reload.js

@@ -11,6 +11,9 @@ const __dirname = path.dirname(__filename);
 const filesUsingHotReload = new Set();
 let assetsDirectory = "";
 
+/**
+ * @param {import('../types').userSettings} userSettings
+ */
 export const needleReload = (command, config, userSettings) => {
     if (command === "build") return;
 

package/plugins/vite/transform-codegen.js

@@ -3,6 +3,7 @@ import { builtAssetsDirectory, tryLoadProjectConfig } from './config.js';
 /** 
  * modify the glb load path in codegen files
  * this is necessary if the assets directory is not the default (changed by the user in needle.config.json)
+ * @param {import('../types').userSettings} userSettings
  */
 export const needleTransformCodegen = (command, config, userSettings) => {
 

package/src/engine/engine_element_loading.ts

@@ -178,7 +178,7 @@ export class EngineLoadingView implements ILoadingViewHandler {
 
         const hasLicense = hasProLicense();
         if (!existing) {
-            this._loadingElement.style.position = "fixed";
+            this._loadingElement.style.position = "absolute";
             this._loadingElement.style.width = "100%";
             this._loadingElement.style.height = "100%";
             this._loadingElement.style.left = "0";

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

@@ -66,6 +66,13 @@ class USDObject {
 
 	}
 
+	static createEmpty() {
+		
+		const empty = new USDObject( MathUtils.generateUUID(), 'Empty_' + ( USDObject.USDObject_export_id ++ ), new Matrix4() );
+		empty.isDynamic = true;
+		return empty;
+	}
+
 	constructor( id, name, matrix, mesh: BufferGeometry | null = null, material: Material | null = null, camera: Camera | null = null ) {
 
 		this.uuid = id;
@@ -443,7 +450,7 @@ class USDZExporter {
 
 		await invokeAll( context, 'onAfterSerialize' );
 
-		context.output += buildMaterials( materials, textures );
+		context.output += buildMaterials( materials, textures, options.quickLookCompatible );
 
 		const header = context.document.buildHeader();
 		const final = header + '\n' + context.output;
@@ -1100,7 +1107,7 @@ function buildVector2Array( attribute, count ) {
 
 // Materials
 
-function buildMaterials( materials, textures ) {
+function buildMaterials( materials, textures, quickLookCompatible = false ) {
 
 	const array: Array<string> = [];
 
@@ -1108,7 +1115,7 @@ function buildMaterials( materials, textures ) {
 
 		const material = materials[ uuid ];
 
-		array.push( buildMaterial( material, textures ) );
+		array.push( buildMaterial( material, textures, quickLookCompatible ) );
 
 	}
 
@@ -1121,14 +1128,13 @@ ${array.join( '' )}
 
 }
 
-function buildMaterial( material: MeshStandardMaterial, textures ) {
+function buildMaterial( material: MeshStandardMaterial, textures, quickLookCompatible = false ) {
 
 	// https://graphics.pixar.com/usd/docs/UsdPreviewSurface-Proposal.html
 
 	const pad = '            ';
 	const inputs: Array<string> = [];
 	const samplers: Array<string> = [];
-	const exportForQuickLook = false;
 
 	function buildTexture( texture, mapType, color: Color | undefined = undefined, opacity: number | undefined = undefined ) {
 
@@ -1151,7 +1157,7 @@ function buildMaterial( material: MeshStandardMaterial, textures ) {
 
 		// turns out QuickLook is buggy and interprets texture repeat inverted.
 		// Apple Feedback: 	FB10036297 and FB11442287
-		if ( exportForQuickLook ) {
+		if ( quickLookCompatible ) {
 
 			// This is NOT correct yet in QuickLook, but comes close for a range of models.
 			// It becomes more incorrect the bigger the offset is

package/src/engine-components/export/usdz/extensions/behavior/BehavioursBuilder.ts

@@ -110,6 +110,7 @@ export class TriggerModel implements IBehaviorElement {
     targetId?: string | Target;
     tokenId?: string;
     type?: string;
+    distance?: number;
 
     constructor(targetId?: string | Target, id?: string) {
         if (targetId) this.targetId = targetId;
@@ -127,6 +128,8 @@ export class TriggerModel implements IBehaviorElement {
             writer.appendLine(`token info:id = "${this.tokenId}"`);
         if (this.type)
             writer.appendLine(`token type = "${this.type}"`);
+        if (typeof this.distance === "number")
+            writer.appendLine(`double distance = ${this.distance}`);
         writer.closeBlock();
     }
 }
@@ -150,6 +153,13 @@ export class TriggerBuilder {
     static isTapTrigger(trigger?: TriggerModel) {
         return trigger?.tokenId === "TapGesture";
     }
+
+    static proximityToCameraTrigger(targetObject: Target, distance: number): TriggerModel {
+        const trigger = new TriggerModel(targetObject);
+        trigger.tokenId = "ProximityToCamera";
+        trigger.distance = distance;
+        return trigger;
+    }
 }
 
 export class GroupActionModel implements IBehaviorElement {

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

@@ -1 +1,3 @@
-export { USDZExporter } from "./USDZExporter"
+export { USDZExporter } from "./USDZExporter";
+export { USDObject } from "./ThreeUSDZExporter";
+export { type UsdzBehaviour } from "./extensions/behavior/Behaviour";

package/src/engine-components/utils/LookAt.ts

@@ -55,8 +55,9 @@ export class LookAt extends Behaviour implements UsdzBehaviour {
 
                 // rotate by 90° - counter-rotation on the parent makes sure 
                 // that without Preliminary Behaviours it still looks right
-                parent.matrix.multiply(new Matrix4().makeRotationZ(Math.PI / 2));
-                model.matrix.multiply(new Matrix4().makeRotationZ(-Math.PI / 2));
+                const flip = this.invertForward ? -1 : 1;
+                parent.matrix.multiply(new Matrix4().makeRotationZ(Math.PI / 2 * flip));
+                model.matrix.multiply(new Matrix4().makeRotationZ(-Math.PI / 2 * flip));
             }
 
             const lookAt = new BehaviorModel("lookat " + this.name,