@needle-tools/engine 4.3.2-beta.1 → 4.3.2-beta.3

package/lib/engine/engine_tonemapping.js

@@ -81,8 +81,8 @@ vec3 _agx(vec3 val) {
         0.0784335999999992,  0.878468636469772,  0.0784336,
         0.0792237451477643, 0.0791661274605434, 0.879142973793104);
     
-    const float min_ev = -12.47393f;
-    const float max_ev = 4.026069f;
+    const float min_ev = -12.47393;
+    const float max_ev = 4.026069;
 
     // val = pow(val, vec3(2.2)); 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@needle-tools/engine",
-  "version": "4.3.2-beta.1",
+  "version": "4.3.2-beta.3",
   "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": {

package/src/engine/engine_context.ts

@@ -10,6 +10,7 @@ import {
 /** @ts-ignore (not yet in types?) */
 import { BasicNodeLibrary } from "three";
 import * as Stats from 'three/examples/jsm/libs/stats.module.js';
+import type { EffectComposer as ThreeEffectComposer } from "three/examples/jsm/postprocessing/EffectComposer.js";
 import { nodeFrame } from "three/examples/jsm/renderers/webgl-legacy/nodes/WebGLNodeBuilder.js";
 
 import { isDevEnvironment, LogType, showBalloonError, showBalloonMessage } from './debug/index.js';
@@ -317,7 +318,7 @@ export class Context implements IContext {
 
 	scene: Scene;
 	renderer!: WebGLRenderer;
-	composer: EffectComposer | null = null;
+	composer: EffectComposer | ThreeEffectComposer | null = null;
 
 	// all scripts
 	readonly scripts: IComponent[] = [];
@@ -1450,7 +1451,7 @@ export class Context implements IContext {
 
 		if (this.composer && !this.isInXR) {
 			// if a camera is passed in we need to check if we need to update the composer's camera
-			if (camera) {
+			if (camera && "setMainCamera" in this.composer) {
 				const currentPassesCamera = this.composer.passes[0]?.mainCamera;
 				if (currentPassesCamera != camera)
 					this.composer.setMainCamera(camera);

package/src/engine/engine_gizmos.ts

@@ -44,9 +44,23 @@ export class Gizmos {
         return obj[$cacheSymbol] !== undefined;
     }
 
+    /** Set visibility of all currently rendered gizmos */
+    static setVisible(visible: boolean) {
+        for (const obj of Internal.timedObjectsBuffer) {
+            obj.visible = visible;
+        }
+    }
+
     /**
      * Draw a label in the scene or attached to an object (if a parent is provided)
-     * @returns a handle to the label that can be used to change the text
+     * @param position the position of the label in world space
+     * @param text the text of the label
+     * @param size the size of the label in world space
+     * @param duration the duration in seconds the label will be rendered. If 0 it will be rendered for one frame
+     * @param color the color of the label
+     * @param backgroundColor the background color of the label
+     * @param parent the parent object to attach the label to. If no parent is provided the label will be attached to the scene
+     * @returns a handle to the label that can be used to update the text
      */
     static DrawLabel(position: Vec3, text: string, size: number = .05, duration: number = 0, color?: ColorRepresentation, backgroundColor?: ColorRepresentation | ColorWithAlpha, parent?: Object3D,) {
         if (!Gizmos.enabled) return null;
@@ -60,6 +74,14 @@ export class Gizmos {
         return element as LabelHandle;
     }
 
+    /**
+     * Draw a ray gizmo in the scene
+     * @param origin the origin of the ray in world space
+     * @param dir the direction of the ray in world space
+     * @param color the color of the ray
+     * @param duration the duration in seconds the ray will be rendered. If 0 it will be rendered for one frame
+     * @param depthTest if true the ray will be rendered with depth test
+     */
     static DrawRay(origin: Vec3, dir: Vec3, color: ColorRepresentation = defaultColor, duration: number = 0, depthTest: boolean = true) {
         if (!Gizmos.enabled) return;
         const obj = Internal.getLine(duration);
@@ -73,6 +95,15 @@ export class Gizmos {
         obj.material["depthWrite"] = false;
     }
 
+    /**
+     * Draw a line gizmo in the scene
+     * @param pt0 the start point of the line in world space
+     * @param pt1 the end point of the line in world space
+     * @param color the color of the line
+     * @param duration the duration in seconds the line will be rendered. If 0 it will be rendered for one frame
+     * @param depthTest if true the line will be rendered with depth test
+     * @param lengthFactor the length of the line. Default is 1
+     */
     static DrawDirection(pt: Vec3, direction: Vec3 | Vec4, color: ColorRepresentation = defaultColor, duration: number = 0, depthTest: boolean = true, lengthFactor: number = 1) {
         if (!Gizmos.enabled) return;
         const obj = Internal.getLine(duration);
@@ -95,6 +126,14 @@ export class Gizmos {
 
     }
 
+    /**
+     * Draw a line gizmo in the scene
+     * @param pt0 the start point of the line in world space
+     * @param pt1 the end point of the line in world space
+     * @param color the color of the line
+     * @param duration the duration in seconds the line will be rendered. If 0 it will be rendered for one frame
+     * @param depthTest if true the line will be rendered with depth test
+     */
     static DrawLine(pt0: Vec3, pt1: Vec3, color: ColorRepresentation = defaultColor, duration: number = 0, depthTest: boolean = true) {
         if (!Gizmos.enabled) return;
         const obj = Internal.getLine(duration);
@@ -108,6 +147,15 @@ export class Gizmos {
         obj.material["fog"] = false;
     }
 
+    /**
+     * Draw a 2D circle gizmo in the scene
+     * @param pt0 the center of the circle in world space
+     * @param normal the normal of the circle in world space
+     * @param radius the radius of the circle in world space
+     * @param color the color of the circle
+     * @param duration the duration in seconds the circle will be rendered. If 0 it will be rendered for one frame
+     * @param depthTest if true the circle will be rendered with depth test
+     */
     static DrawCircle(pt0: Vec3, normal: Vec3, radius: number, color: ColorRepresentation = defaultColor, duration: number = 0, depthTest: boolean = true) {
         if (!Gizmos.enabled) return;
         const obj = Internal.getCircle(duration);
@@ -120,6 +168,14 @@ export class Gizmos {
         obj.material["fog"] = false;
     }
 
+    /**
+     * Draw a 3D wiremesh sphere gizmo in the scene
+     * @param center the center of the sphere in world space
+     * @param radius the radius of the sphere in world space
+     * @param color the color of the sphere
+     * @param duration the duration in seconds the sphere will be rendered. If 0 it will be rendered for one frame
+     * @param depthTest if true the sphere will be rendered with depth test
+     */
     static DrawWireSphere(center: Vec3, radius: number, color: ColorRepresentation = defaultColor, duration: number = 0, depthTest: boolean = true) {
         if (!Gizmos.enabled) return;
         const obj = Internal.getSphere(radius, duration, true);
@@ -130,6 +186,14 @@ export class Gizmos {
         obj.material["fog"] = false;
     }
 
+    /**
+     * Draw a 3D sphere gizmo in the scene
+     * @param center the center of the sphere in world space
+     * @param radius the radius of the sphere in world space
+     * @param color the color of the sphere
+     * @param duration the duration in seconds the sphere will be rendered. If 0 it will be rendered for one frame
+     * @param depthTest if true the sphere will be rendered with depth test
+     */
     static DrawSphere(center: Vec3, radius: number, color: ColorRepresentation = defaultColor, duration: number = 0, depthTest: boolean = true) {
         if (!Gizmos.enabled) return;
         const obj = Internal.getSphere(radius, duration, false);
@@ -139,6 +203,14 @@ export class Gizmos {
         obj.material["depthWrite"] = false;
     }
 
+    /**
+     * Draw a 3D wiremesh box gizmo in the scene
+     * @param center the center of the box in world space
+     * @param size the size of the box in world space
+     * @param color the color of the box
+     * @param duration the duration in seconds the box will be rendered. If 0 it will be rendered for one frame
+     * @param depthTest if true the box will be rendered with depth test
+     */
     static DrawWireBox(center: Vec3, size: Vec3, color: ColorRepresentation = defaultColor, duration: number = 0, depthTest: boolean = true) {
         if (!Gizmos.enabled) return;
         const obj = Internal.getBox(duration);
@@ -151,6 +223,13 @@ export class Gizmos {
         obj.material["fog"] = false;
     }
 
+    /**
+     * Draw a 3D wiremesh box gizmo in the scene
+     * @param box the box in world space
+     * @param color the color of the box
+     * @param duration the duration in seconds the box will be rendered. If 0 it will be rendered for one frame
+     * @param depthTest if true the box will be rendered with depth test
+     */
     static DrawWireBox3(box: Box3, color: ColorRepresentation = defaultColor, duration: number = 0, depthTest: boolean = true) {
         if (!Gizmos.enabled) return;
         const obj = Internal.getBox(duration);
@@ -164,6 +243,15 @@ export class Gizmos {
     }
 
     private static _up = new Vector3(0, 1, 0);
+    /**
+     * Draw an arrow gizmo in the scene
+     * @param pt0 the start point of the arrow in world space
+     * @param pt1 the end point of the arrow in world space
+     * @param color the color of the arrow
+     * @param duration the duration in seconds the arrow will be rendered. If 0 it will be rendered for one frame
+     * @param depthTest if true the arrow will be rendered with depth test
+     * @param wireframe if true the arrow will be rendered as wireframe
+     */
     static DrawArrow(pt0: Vec3, pt1: Vec3, color: ColorRepresentation = defaultColor, duration: number = 0, depthTest: boolean = true, wireframe: boolean = false) {
         if (!Gizmos.enabled) return;
         const obj = Internal.getArrowHead(duration);
@@ -209,13 +297,6 @@ export class Gizmos {
         mesh.material["depthTest"] = options.depthTest ?? true;
         mesh.material["wireframe"] = true;
     }
-
-    /** Set visibility of all currently rendered gizmos */
-    static setVisible(visible: boolean) {
-        for (const obj of Internal.timedObjectsBuffer) {
-            obj.visible = visible;
-        }
-    }
 }
 
 const box: BoxGeometry = new BoxGeometry(1, 1, 1);

package/src/engine/engine_texture.ts

@@ -1,5 +1,6 @@
 import type { EffectComposer } from "postprocessing";
 import { Camera, Mesh, Object3D, Texture, WebGLRenderer, WebGLRenderTarget } from "three";
+import type { EffectComposer as ThreeEffectComposer } from "three/examples/jsm/postprocessing/EffectComposer";
 
 import { findResourceUsers } from "./engine_assetdatabase.js";
 
@@ -27,9 +28,9 @@ export class RenderTexture extends WebGLRenderTarget {
      * @param camera The camera to render from
      * @param renderer The renderer or effectcomposer to use
      */
-    render(scene: Object3D, camera: Camera, renderer: WebGLRenderer | EffectComposer) {
+    render(scene: Object3D, camera: Camera, renderer: WebGLRenderer | EffectComposer | ThreeEffectComposer) {
 
-        const composer = renderer as EffectComposer;
+        const composer = renderer as (EffectComposer | ThreeEffectComposer);
 
         if ("addPass" in composer) {
             if (!this["_unsupported_effectcomposer_warning"]) {

package/src/engine/engine_tonemapping.ts

@@ -87,8 +87,8 @@ vec3 _agx(vec3 val) {
         0.0784335999999992,  0.878468636469772,  0.0784336,
         0.0792237451477643, 0.0791661274605434, 0.879142973793104);
     
-    const float min_ev = -12.47393f;
-    const float max_ev = 4.026069f;
+    const float min_ev = -12.47393;
+    const float max_ev = 4.026069;
 
     // val = pow(val, vec3(2.2));