@needle-tools/engine 4.3.0-alpha → 4.3.0-alpha.1

package/lib/engine-components/Camera.d.ts

@@ -4,8 +4,11 @@ import { RenderTexture } from "../engine/engine_texture.js";
 import type { ICamera } from "../engine/engine_types.js";
 import { RGBAColor } from "../engine/js-extensions/index.js";
 import { Behaviour } from "./Component.js";
-/**  The ClearFlags enum is used to determine how the camera clears the background */
+/**
+ * The ClearFlags enum is used to determine how the camera clears the background
+ */
 export declare enum ClearFlags {
+    /** Don't clear the background */
     None = 0,
     /** Clear the background with a skybox */
     Skybox = 1,
@@ -15,68 +18,124 @@ export declare enum ClearFlags {
     Uninitialized = 4
 }
 /**
+ * Camera component that handles rendering from a specific viewpoint in the scene.
+ * Supports both perspective and orthographic cameras with various rendering options.
+ * Internally, this component uses {@link PerspectiveCamera} and {@link OrthographicCamera} three.js objects.
+ *
  * @category Camera Controls
  * @group Components
  */
 export declare class Camera extends Behaviour implements ICamera {
+    /**
+     * Returns whether this component is a camera
+     * @returns {boolean} Always returns true
+     */
     get isCamera(): boolean;
-    /** The camera's aspect ratio (width divided by height) if it is a perspective camera */
+    /**
+     * Gets or sets the camera's aspect ratio (width divided by height).
+     * For perspective cameras, this directly affects the camera's projection matrix.
+     * When set, automatically updates the projection matrix.
+     */
     get aspect(): number;
     set aspect(value: number);
-    /** The camera's field of view in degrees if it is a perspective camera. Calls updateProjectionMatrix when set */
+    /**
+     * Gets or sets the camera's field of view in degrees for perspective cameras.
+     * When set, automatically updates the projection matrix.
+     */
     get fieldOfView(): number | undefined;
     set fieldOfView(val: number | undefined);
-    /** The camera's near clipping plane. Calls updateProjectionMatrix when set */
+    /**
+     * Gets or sets the camera's near clipping plane distance.
+     * Objects closer than this distance won't be rendered.
+     * When set, automatically updates the projection matrix.
+     */
     get nearClipPlane(): number;
     set nearClipPlane(val: number);
     private _nearClipPlane;
-    /** The camera's far clipping plane. Calls updateProjectionMatrix when set */
+    /**
+     * Gets or sets the camera's far clipping plane distance.
+     * Objects farther than this distance won't be rendered.
+     * When set, automatically updates the projection matrix.
+     */
     get farClipPlane(): number;
     set farClipPlane(val: number);
     private _farClipPlane;
     /**
-     * Applys both the camera's near and far plane and calls updateProjectionMatrix on the camera.
+     * Applies both the camera's near and far clipping planes and updates the projection matrix.
+     * This ensures rendering occurs only within the specified distance range.
      */
     applyClippingPlane(): void;
-    /** The camera's clear flags - determines if the background is a skybox or a solid color or transparent */
+    /**
+     * Gets or sets the camera's clear flags that determine how the background is rendered.
+     * Options include skybox, solid color, or transparent background.
+     */
     get clearFlags(): ClearFlags;
     set clearFlags(val: ClearFlags);
+    /**
+     * Determines if the camera should use orthographic projection instead of perspective.
+     */
     orthographic: boolean;
+    /**
+     * The size of the orthographic camera's view volume when in orthographic mode.
+     * Larger values show more of the scene.
+     */
     orthographicSize: number;
+    /**
+     * Controls the transparency level of the camera background in AR mode on supported devices.
+     * Value from 0 (fully transparent) to 1 (fully opaque).
+     */
     ARBackgroundAlpha: number;
     /**
-     * The [`mask`](https://threejs.org/docs/#api/en/core/Layers.mask) value of the three camera object layers
-     * If you want to just see objects on one layer (e.g. layer 2) then you can use `cullingLayer = 2` on this camera component instead
-    */
+     * Gets or sets the layers mask that determines which objects this camera will render.
+     * Uses the {@link https://threejs.org/docs/#api/en/core/Layers.mask|three.js layers mask} convention.
+     */
     set cullingMask(val: number);
     get cullingMask(): number;
     private _cullingMask;
-    /** Set only a specific layer active to be rendered by the camera.
-     * This is equivalent to calling `layers.set(val)`
-     **/
+    /**
+     * Sets only a specific layer to be active for rendering by this camera.
+     * This is equivalent to calling `layers.set(val)` on the three.js camera object.
+     * @param val The layer index to set active
+     */
     set cullingLayer(val: number);
-    /** The blurriness of the background texture (when using a skybox) */
+    /**
+     * Gets or sets the blurriness of the skybox background.
+     * Values range from 0 (sharp) to 1 (maximum blur).
+     */
     set backgroundBlurriness(val: number | undefined);
     get backgroundBlurriness(): number | undefined;
     private _backgroundBlurriness?;
-    /** The intensity of the background texture (when using a skybox) */
+    /**
+     * Gets or sets the intensity of the skybox background.
+     * Values range from 0 (dark) to 10 (very bright).
+     */
     set backgroundIntensity(val: number | undefined);
     get backgroundIntensity(): number | undefined;
     private _backgroundIntensity?;
-    /** the rotation of the background texture (when using a skybox) */
+    /**
+     * Gets or sets the rotation of the skybox background.
+     * Controls the orientation of the environment map.
+     */
     set backgroundRotation(val: Euler | undefined);
     get backgroundRotation(): Euler | undefined;
     private _backgroundRotation?;
-    /** The intensity of the environment map */
+    /**
+     * Gets or sets the intensity of the environment lighting.
+     * Controls how strongly the environment map affects scene lighting.
+     */
     set environmentIntensity(val: number | undefined);
     get environmentIntensity(): number | undefined;
     private _environmentIntensity?;
-    /** The background color of the camera when {@link ClearFlags} are set to `SolidColor` */
+    /**
+     * Gets or sets the background color of the camera when {@link ClearFlags} is set to {@link ClearFlags.SolidColor}.
+     * The alpha component controls transparency.
+     */
     get backgroundColor(): RGBAColor | null;
     set backgroundColor(val: RGBAColor | null);
-    /** The texture that the camera should render to
-     * It can be used to render to a {@link Texture} instead of the screen.
-    */
+    /**
+     * Gets or sets the texture that the camera should render to instead of the screen.
+     * Useful for creating effects like mirrors, portals or custom post processing.
+     */
     set targetTexture(rt: RenderTexture | null);
     get targetTexture(): RenderTexture | null;
     private _targetTexture;
@@ -86,29 +145,47 @@ export declare class Camera extends Behaviour implements ICamera {
     private _clearFlags;
     private _skybox?;
     /**
-     * Get the three.js camera object. This will create a camera if it does not exist yet.
-     * @returns {PerspectiveCamera | OrthographicCamera} the three camera
-     * @deprecated use {@link threeCamera} instead
+     * Gets the three.js camera object. Creates one if it doesn't exist yet.
+     * @returns {PerspectiveCamera | OrthographicCamera} The three.js camera object
+     * @deprecated Use {@link threeCamera} instead
      */
     get cam(): PerspectiveCamera | OrthographicCamera;
     /**
-     * Get the three.js camera object. This will create a camera if it does not exist yet.
-     * @returns {PerspectiveCamera | OrthographicCamera} the three camera
+     * Gets the three.js camera object. Creates one if it doesn't exist yet.
+     * @returns {PerspectiveCamera | OrthographicCamera} The three.js camera object
      */
     get threeCamera(): PerspectiveCamera | OrthographicCamera;
     private static _origin;
     private static _direction;
+    /**
+     * Converts screen coordinates to a ray in world space.
+     * Useful for implementing picking or raycasting from screen to world.
+     *
+     * @param x The x screen coordinate
+     * @param y The y screen coordinate
+     * @param ray Optional ray object to reuse instead of creating a new one
+     * @returns {Ray} A ray originating from the camera position pointing through the screen point
+     */
     screenPointToRay(x: number, y: number, ray?: Ray): Ray;
     private _frustum?;
     /**
-     * Get a frustum - it will be created the first time this method is called and updated every frame in onBeforeRender when it exists.
-     * You can also manually update it using the updateFrustum method.
+     * Gets the camera's view frustum for culling and visibility checks.
+     * Creates the frustum if it doesn't exist and returns it.
+     *
+     * @returns {Frustum} The camera's view frustum
      */
     getFrustum(): Frustum;
-    /** Force frustum update - note that this also happens automatically every frame in onBeforeRender */
+    /**
+     * Forces an update of the camera's frustum.
+     * This is automatically called every frame in onBeforeRender.
+     */
     updateFrustum(): void;
     /**
-     * @returns {Matrix4} this camera's projection screen matrix.
+     * Gets this camera's projection-screen matrix.
+     *
+     * @param target Matrix4 object to store the result in
+     * @param forceUpdate Whether to force recalculation of the matrix
+     * @returns {Matrix4} The requested projection screen matrix
      */
     getProjectionScreenMatrix(target: Matrix4, forceUpdate?: boolean): Matrix4;
     private readonly _projScreenMatrix;
@@ -121,22 +198,34 @@ export declare class Camera extends Behaviour implements ICamera {
     /** @internal */
     onBeforeRender(): void;
     /**
-     * Creates a {@link PerspectiveCamera} if it does not exist yet and set the camera's properties. This is internally also called when accessing the {@link cam} property.
-     **/
+     * Creates a three.js camera object if it doesn't exist yet and sets its properties.
+     * This is called internally when accessing the {@link threeCamera} property.
+     */
     buildCamera(): void;
+    /**
+     * Applies clear flags if this is the active main camera.
+     * @param opts Options for applying clear flags
+     */
     applyClearFlagsIfIsActiveCamera(opts?: {
         applySkybox: boolean;
     }): void;
-    /** Apply this camera's clear flags and related settings to the renderer */
+    /**
+     * Applies this camera's clear flags and related settings to the renderer.
+     * This controls how the background is rendered (skybox, solid color, transparent).
+     * @param opts Options for applying clear flags
+     */
     applyClearFlags(opts?: {
         applySkybox: boolean;
     }): void;
     /**
-     * Apply the skybox to the scene
+     * Applies the skybox texture to the scene background.
      */
     applySceneSkybox(): void;
-    /** Used to determine if the background should be transparent when in pass through AR
-     * @returns true when in XR on a pass through device where the background shouldbe invisible
-     **/
+    /**
+     * Determines if the background should be transparent when in passthrough AR mode.
+     *
+     * @param context The current rendering context
+     * @returns {boolean} True when in XR on a pass through device where the background should be invisible
+     */
     static backgroundShouldBeTransparent(context: Context): boolean;
 }

package/lib/engine-components/Camera.js

@@ -14,9 +14,12 @@ import { getParam } from "../engine/engine_utils.js";
 import { RGBAColor } from "../engine/js-extensions/index.js";
 import { Behaviour, GameObject } from "./Component.js";
 import { OrbitControls } from "./OrbitControls.js";
-/**  The ClearFlags enum is used to determine how the camera clears the background */
+/**
+ * The ClearFlags enum is used to determine how the camera clears the background
+ */
 export var ClearFlags;
 (function (ClearFlags) {
+    /** Don't clear the background */
     ClearFlags[ClearFlags["None"] = 0] = "None";
     /** Clear the background with a skybox */
     ClearFlags[ClearFlags["Skybox"] = 1] = "Skybox";
@@ -28,14 +31,26 @@ export var ClearFlags;
 const debug = getParam("debugcam");
 const debugscreenpointtoray = getParam("debugscreenpointtoray");
 /**
+ * Camera component that handles rendering from a specific viewpoint in the scene.
+ * Supports both perspective and orthographic cameras with various rendering options.
+ * Internally, this component uses {@link PerspectiveCamera} and {@link OrthographicCamera} three.js objects.
+ *
  * @category Camera Controls
  * @group Components
  */
 export class Camera extends Behaviour {
+    /**
+     * Returns whether this component is a camera
+     * @returns {boolean} Always returns true
+     */
     get isCamera() {
         return true;
     }
-    /** The camera's aspect ratio (width divided by height) if it is a perspective camera */
+    /**
+     * Gets or sets the camera's aspect ratio (width divided by height).
+     * For perspective cameras, this directly affects the camera's projection matrix.
+     * When set, automatically updates the projection matrix.
+     */
     get aspect() {
         if (this._cam instanceof PerspectiveCamera)
             return this._cam.aspect;
@@ -49,7 +64,10 @@ export class Camera extends Behaviour {
             }
         }
     }
-    /** The camera's field of view in degrees if it is a perspective camera. Calls updateProjectionMatrix when set */
+    /**
+     * Gets or sets the camera's field of view in degrees for perspective cameras.
+     * When set, automatically updates the projection matrix.
+     */
     get fieldOfView() {
         if (this._cam instanceof PerspectiveCamera) {
             return this._cam.fov;
@@ -70,7 +88,11 @@ export class Camera extends Behaviour {
             }
         }
     }
-    /** The camera's near clipping plane. Calls updateProjectionMatrix when set */
+    /**
+     * Gets or sets the camera's near clipping plane distance.
+     * Objects closer than this distance won't be rendered.
+     * When set, automatically updates the projection matrix.
+     */
     get nearClipPlane() { return this._nearClipPlane; }
     set nearClipPlane(val) {
         const changed = this._nearClipPlane != val;
@@ -81,7 +103,11 @@ export class Camera extends Behaviour {
         }
     }
     _nearClipPlane = 0.1;
-    /** The camera's far clipping plane. Calls updateProjectionMatrix when set */
+    /**
+     * Gets or sets the camera's far clipping plane distance.
+     * Objects farther than this distance won't be rendered.
+     * When set, automatically updates the projection matrix.
+     */
     get farClipPlane() { return this._farClipPlane; }
     set farClipPlane(val) {
         const changed = this._farClipPlane != val;
@@ -93,7 +119,8 @@ export class Camera extends Behaviour {
     }
     _farClipPlane = 1000;
     /**
-     * Applys both the camera's near and far plane and calls updateProjectionMatrix on the camera.
+     * Applies both the camera's near and far clipping planes and updates the projection matrix.
+     * This ensures rendering occurs only within the specified distance range.
      */
     applyClippingPlane() {
         if (this._cam) {
@@ -102,7 +129,10 @@ export class Camera extends Behaviour {
             this._cam.updateProjectionMatrix();
         }
     }
-    /** The camera's clear flags - determines if the background is a skybox or a solid color or transparent */
+    /**
+     * Gets or sets the camera's clear flags that determine how the background is rendered.
+     * Options include skybox, solid color, or transparent background.
+     */
     get clearFlags() {
         return this._clearFlags;
     }
@@ -112,13 +142,24 @@ export class Camera extends Behaviour {
         this._clearFlags = val;
         this.applyClearFlagsIfIsActiveCamera();
     }
+    /**
+     * Determines if the camera should use orthographic projection instead of perspective.
+     */
     orthographic = false;
+    /**
+     * The size of the orthographic camera's view volume when in orthographic mode.
+     * Larger values show more of the scene.
+     */
     orthographicSize = 5;
+    /**
+     * Controls the transparency level of the camera background in AR mode on supported devices.
+     * Value from 0 (fully transparent) to 1 (fully opaque).
+     */
     ARBackgroundAlpha = 0;
     /**
-     * The [`mask`](https://threejs.org/docs/#api/en/core/Layers.mask) value of the three camera object layers
-     * If you want to just see objects on one layer (e.g. layer 2) then you can use `cullingLayer = 2` on this camera component instead
-    */
+     * Gets or sets the layers mask that determines which objects this camera will render.
+     * Uses the {@link https://threejs.org/docs/#api/en/core/Layers.mask|three.js layers mask} convention.
+     */
     set cullingMask(val) {
         this._cullingMask = val;
         if (this._cam) {
@@ -131,13 +172,18 @@ export class Camera extends Behaviour {
         return this._cullingMask;
     }
     _cullingMask = 0xffffffff;
-    /** Set only a specific layer active to be rendered by the camera.
-     * This is equivalent to calling `layers.set(val)`
-     **/
+    /**
+     * Sets only a specific layer to be active for rendering by this camera.
+     * This is equivalent to calling `layers.set(val)` on the three.js camera object.
+     * @param val The layer index to set active
+     */
     set cullingLayer(val) {
         this.cullingMask = (1 << val | 0) >>> 0;
     }
-    /** The blurriness of the background texture (when using a skybox) */
+    /**
+     * Gets or sets the blurriness of the skybox background.
+     * Values range from 0 (sharp) to 1 (maximum blur).
+     */
     set backgroundBlurriness(val) {
         if (val === this._backgroundBlurriness)
             return;
@@ -151,7 +197,10 @@ export class Camera extends Behaviour {
         return this._backgroundBlurriness;
     }
     _backgroundBlurriness = undefined;
-    /** The intensity of the background texture (when using a skybox) */
+    /**
+     * Gets or sets the intensity of the skybox background.
+     * Values range from 0 (dark) to 10 (very bright).
+     */
     set backgroundIntensity(val) {
         if (val === this._backgroundIntensity)
             return;
@@ -165,7 +214,10 @@ export class Camera extends Behaviour {
         return this._backgroundIntensity;
     }
     _backgroundIntensity = undefined;
-    /** the rotation of the background texture (when using a skybox) */
+    /**
+     * Gets or sets the rotation of the skybox background.
+     * Controls the orientation of the environment map.
+     */
     set backgroundRotation(val) {
         if (val === this._backgroundRotation)
             return;
@@ -179,7 +231,10 @@ export class Camera extends Behaviour {
         return this._backgroundRotation;
     }
     _backgroundRotation = undefined;
-    /** The intensity of the environment map */
+    /**
+     * Gets or sets the intensity of the environment lighting.
+     * Controls how strongly the environment map affects scene lighting.
+     */
     set environmentIntensity(val) {
         this._environmentIntensity = val;
     }
@@ -187,7 +242,10 @@ export class Camera extends Behaviour {
         return this._environmentIntensity;
     }
     _environmentIntensity = undefined;
-    /** The background color of the camera when {@link ClearFlags} are set to `SolidColor` */
+    /**
+     * Gets or sets the background color of the camera when {@link ClearFlags} is set to {@link ClearFlags.SolidColor}.
+     * The alpha component controls transparency.
+     */
     get backgroundColor() {
         return this._backgroundColor ?? null;
     }
@@ -206,9 +264,10 @@ export class Camera extends Behaviour {
             this._backgroundColor.alpha = 1;
         this.applyClearFlagsIfIsActiveCamera();
     }
-    /** The texture that the camera should render to
-     * It can be used to render to a {@link Texture} instead of the screen.
-    */
+    /**
+     * Gets or sets the texture that the camera should render to instead of the screen.
+     * Useful for creating effects like mirrors, portals or custom post processing.
+     */
     set targetTexture(rt) {
         this._targetTexture = rt;
     }
@@ -222,16 +281,16 @@ export class Camera extends Behaviour {
     _clearFlags = ClearFlags.SolidColor;
     _skybox;
     /**
-     * Get the three.js camera object. This will create a camera if it does not exist yet.
-     * @returns {PerspectiveCamera | OrthographicCamera} the three camera
-     * @deprecated use {@link threeCamera} instead
+     * Gets the three.js camera object. Creates one if it doesn't exist yet.
+     * @returns {PerspectiveCamera | OrthographicCamera} The three.js camera object
+     * @deprecated Use {@link threeCamera} instead
      */
     get cam() {
         return this.threeCamera;
     }
     /**
-     * Get the three.js camera object. This will create a camera if it does not exist yet.
-     * @returns {PerspectiveCamera | OrthographicCamera} the three camera
+     * Gets the three.js camera object. Creates one if it doesn't exist yet.
+     * @returns {PerspectiveCamera | OrthographicCamera} The three.js camera object
      */
     get threeCamera() {
         if (this.activeAndEnabled)
@@ -240,6 +299,15 @@ export class Camera extends Behaviour {
     }
     static _origin = new Vector3();
     static _direction = new Vector3();
+    /**
+     * Converts screen coordinates to a ray in world space.
+     * Useful for implementing picking or raycasting from screen to world.
+     *
+     * @param x The x screen coordinate
+     * @param y The y screen coordinate
+     * @param ray Optional ray object to reuse instead of creating a new one
+     * @returns {Ray} A ray originating from the camera position pointing through the screen point
+     */
     screenPointToRay(x, y, ray) {
         const cam = this.threeCamera;
         const origin = Camera._origin;
@@ -263,8 +331,10 @@ export class Camera extends Behaviour {
     }
     _frustum;
     /**
-     * Get a frustum - it will be created the first time this method is called and updated every frame in onBeforeRender when it exists.
-     * You can also manually update it using the updateFrustum method.
+     * Gets the camera's view frustum for culling and visibility checks.
+     * Creates the frustum if it doesn't exist and returns it.
+     *
+     * @returns {Frustum} The camera's view frustum
      */
     getFrustum() {
         if (!this._frustum) {
@@ -273,14 +343,21 @@ export class Camera extends Behaviour {
         }
         return this._frustum;
     }
-    /** Force frustum update - note that this also happens automatically every frame in onBeforeRender */
+    /**
+     * Forces an update of the camera's frustum.
+     * This is automatically called every frame in onBeforeRender.
+     */
     updateFrustum() {
         if (!this._frustum)
             this._frustum = new Frustum();
         this._frustum.setFromProjectionMatrix(this.getProjectionScreenMatrix(this._projScreenMatrix, true), this.context.renderer.coordinateSystem);
     }
     /**
-     * @returns {Matrix4} this camera's projection screen matrix.
+     * Gets this camera's projection-screen matrix.
+     *
+     * @param target Matrix4 object to store the result in
+     * @param forceUpdate Whether to force recalculation of the matrix
+     * @returns {Matrix4} The requested projection screen matrix
      */
     getProjectionScreenMatrix(target, forceUpdate) {
         if (forceUpdate) {
@@ -351,8 +428,9 @@ export class Camera extends Behaviour {
         }
     }
     /**
-     * Creates a {@link PerspectiveCamera} if it does not exist yet and set the camera's properties. This is internally also called when accessing the {@link cam} property.
-     **/
+     * Creates a three.js camera object if it doesn't exist yet and sets its properties.
+     * This is called internally when accessing the {@link threeCamera} property.
+     */
     buildCamera() {
         if (this._cam)
             return;
@@ -393,12 +471,20 @@ export class Camera extends Behaviour {
             this.context.setCurrentCamera(this);
         }
     }
+    /**
+     * Applies clear flags if this is the active main camera.
+     * @param opts Options for applying clear flags
+     */
     applyClearFlagsIfIsActiveCamera(opts) {
         if (this.context.mainCameraComponent === this) {
             this.applyClearFlags(opts);
         }
     }
-    /** Apply this camera's clear flags and related settings to the renderer */
+    /**
+     * Applies this camera's clear flags and related settings to the renderer.
+     * This controls how the background is rendered (skybox, solid color, transparent).
+     * @param opts Options for applying clear flags
+     */
     applyClearFlags(opts) {
         if (!this._cam) {
             if (debug)
@@ -465,16 +551,19 @@ export class Camera extends Behaviour {
         }
     }
     /**
-     * Apply the skybox to the scene
+     * Applies the skybox texture to the scene background.
      */
     applySceneSkybox() {
         if (!this._skybox)
             this._skybox = new CameraSkybox(this);
         this._skybox.apply();
     }
-    /** Used to determine if the background should be transparent when in pass through AR
-     * @returns true when in XR on a pass through device where the background shouldbe invisible
-     **/
+    /**
+     * Determines if the background should be transparent when in passthrough AR mode.
+     *
+     * @param context The current rendering context
+     * @returns {boolean} True when in XR on a pass through device where the background should be invisible
+     */
     static backgroundShouldBeTransparent(context) {
         const session = context.renderer.xr?.getSession();
         if (!session)
@@ -548,6 +637,10 @@ __decorate([
 __decorate([
     serializable(RenderTexture)
 ], Camera.prototype, "targetTexture", null);
+/**
+ * Helper class for managing skybox textures for cameras.
+ * Handles retrieving and applying skybox textures to the scene.
+ */
 class CameraSkybox {
     _camera;
     _skybox;
@@ -555,6 +648,10 @@ class CameraSkybox {
     constructor(camera) {
         this._camera = camera;
     }
+    /**
+     * Applies the skybox texture to the scene background.
+     * Retrieves the texture based on the camera's source ID.
+     */
     apply() {
         this._skybox = this.context.lightmaps.tryGetSkybox(this._camera.sourceId);
         if (!this._skybox) {
@@ -571,6 +668,11 @@ class CameraSkybox {
         }
     }
 }
+/**
+ * Adds orbit controls to the camera if the freecam URL parameter is enabled.
+ *
+ * @param cam The camera to potentially add orbit controls to
+ */
 function handleFreeCam(cam) {
     const isFreecam = getParam("freecam");
     if (isFreecam) {