@shapediver/viewer.rendering-engine.camera-engine 3.3.4 → 3.3.7

package/src/implementation/camera/AbstractCamera.ts

@@ -1,324 +0,0 @@
-import * as detectIt from 'detect-it';
-import { AbstractTreeNodeData, ITreeNode } from '@shapediver/viewer.shared.node-tree';
-import { Box, IBox } from '@shapediver/viewer.shared.math';
-import { CAMERA_TYPE } from '../../interfaces/ICameraEngine';
-import { ICamera, ICameraOptions } from '../../interfaces/camera/ICamera';
-import { ICameraControls } from '../../interfaces/controls/ICameraControls';
-import { IRenderingEngine } from '@shapediver/viewer.rendering-engine.rendering-engine';
-import { vec2, vec3 } from 'gl-matrix';
-import {
-    EventEngine,
-    EVENTTYPE,
-    SettingsEngine,
-    StateEngine,
-} from '@shapediver/viewer.shared.services';
-
-export abstract class AbstractCamera extends AbstractTreeNodeData implements ICamera {
-    // #region Properties (24)
-
-    #active: boolean = false;
-    #autoAdjust: boolean = true;
-    #cameraMovementDuration: number = 800;
-    #defaultPosition: vec3 = vec3.create();
-    #defaultTarget: vec3 = vec3.create();
-    #domEventListenerToken: string | undefined;
-    #enableCameraControls: boolean = true;
-    #far: number = 1000;
-    #name?: string;
-    #near: number = 1;
-    #node?: ITreeNode;
-    #order?: number;
-    #revertAtMouseUp: boolean = false;
-    #revertAtMouseUpDuration: number = 800;
-    #sceneRotation: vec2 = vec2.create();
-    #useNodeData: boolean = false;
-    #zoomExtentsFactor: number = 1;
-
-    protected readonly _eventEngine: EventEngine = EventEngine.instance;
-    protected readonly _stateEngine: StateEngine = StateEngine.instance;
-
-    protected _boundingBox: IBox = new Box();
-    protected abstract _controls: ICameraControls;
-    protected _position: vec3 = vec3.create();
-    protected _target: vec3 = vec3.create();
-    protected _viewportId?: string;
-
-    // #endregion Properties (24)
-
-    // #region Constructors (1)
-
-    constructor(private readonly _id: string, private readonly _type: CAMERA_TYPE, version?: string, private readonly _isDefault: boolean = false) {
-        super(_id, version);
-    }
-
-    // #endregion Constructors (1)
-
-    // #region Public Getters And Setters (43)
-
-    public get active(): boolean {
-        return this.#active;
-    }
-
-    public set active(value: boolean) {
-        this.#active = value;
-    }
-
-    public get autoAdjust(): boolean {
-        return this.#autoAdjust;
-    }
-
-    public set autoAdjust(value: boolean) {
-        this.#autoAdjust = value;
-    }
-
-    public set boundingBox(value: IBox) {
-        this._boundingBox = value;
-    }
-
-    public get cameraMovementDuration(): number {
-        return this.#cameraMovementDuration;
-    }
-
-    public set cameraMovementDuration(value: number) {
-        this.#cameraMovementDuration = value;
-    }
-
-    public get controls(): ICameraControls {
-        return this._controls;
-    }
-
-    public get defaultPosition(): vec3 {
-        return this.#defaultPosition;
-    }
-
-    public set defaultPosition(value: vec3) {
-        this.#defaultPosition = value;
-    }
-
-    public get defaultTarget(): vec3 {
-        return this.#defaultTarget;
-    }
-
-    public set defaultTarget(value: vec3) {
-        this.#defaultTarget = value;
-    }
-
-    public get domEventListenerToken(): string | undefined {
-        return this.#domEventListenerToken;
-    }
-
-    public set domEventListenerToken(value: string | undefined) {
-        this.#domEventListenerToken = value;
-    }
-
-    public get enableCameraControls(): boolean {
-        return this.#enableCameraControls;
-    }
-
-    public set enableCameraControls(value: boolean) {
-        this.#enableCameraControls = value;
-    }
-
-    public get far(): number {
-        return this.#far;
-    }
-
-    public set far(value: number) {
-        this.#far = value;
-    }
-
-    public get id(): string {
-        return this._id;
-    }
-
-    public get isDefault(): boolean {
-        return this._isDefault;
-    }
-
-    public get name(): string | undefined {
-        return this.#name;
-    }
-
-    public set name(value: string | undefined) {
-        this.#name = value;
-    }
-
-    public get near(): number {
-        return this.#near;
-    }
-
-    public set near(value: number) {
-        this.#near = value;
-    }
-
-    public get node(): ITreeNode | undefined {
-        return this.#node;
-    }
-
-    public set node(value: ITreeNode | undefined) {
-        this.#node = value;
-    }
-
-    public get order(): number | undefined {
-        return this.#order;
-    }
-
-    public set order(value: number | undefined) {
-        this.#order = value;
-    }
-
-    public get position(): vec3 {
-        return this._position;
-    }
-
-    public set position(value: vec3) {
-        this._position = value;
-        this._controls.position = value;
-    }
-
-    public get revertAtMouseUp(): boolean {
-        return this.#revertAtMouseUp;
-    }
-
-    public set revertAtMouseUp(value: boolean) {
-        this.#revertAtMouseUp = value;
-    }
-
-    public get revertAtMouseUpDuration(): number {
-        return this.#revertAtMouseUpDuration;
-    }
-
-    public set revertAtMouseUpDuration(value: number) {
-        this.#revertAtMouseUpDuration = value;
-    }
-
-    public get sceneRotation(): vec2 {
-        return this.#sceneRotation;
-    }
-
-    public set sceneRotation(value: vec2) {
-        this.#sceneRotation = value;
-    }
-
-    public get target(): vec3 {
-        return this._target;
-    }
-
-    public set target(value: vec3) {
-        this._target = value;
-        this._controls.target = value;
-    }
-
-    public get type(): CAMERA_TYPE {
-        return this._type;
-    }
-
-    public get useNodeData(): boolean {
-        return this.#useNodeData;
-    }
-
-    public set useNodeData(value: boolean) {
-        this.#useNodeData = value;
-    }
-
-    public get viewportId(): string | undefined {
-        return this._viewportId;
-    }
-
-    public get zoomExtentsFactor(): number {
-        return this.#zoomExtentsFactor;
-    }
-
-    public set zoomExtentsFactor(value: number) {
-        this.#zoomExtentsFactor = value;
-    }
-
-    // #endregion Public Getters And Setters (43)
-
-    // #region Public Methods (5)
-
-    public async animate(path: { position: vec3; target: vec3; }[], options?: ICameraOptions): Promise<boolean> {
-        if (path.length === 0) return Promise.resolve(false);
-
-        if (!options) options = {};
-        options.duration = options.duration! >= 0 ? options.duration : this.cameraMovementDuration;
-
-        const res = await this._controls.animate(path, options);
-        if (res) {
-            this._position = this._controls.position;
-            this._target = this._controls.target;
-        }
-        return res;
-    }
-
-    public reset(options?: ICameraOptions): Promise<boolean> {
-        if ((this.defaultPosition[0] === 0 && this.defaultPosition[1] === 0 && this.defaultPosition[2] === 0) && (this.defaultTarget[0] === 0 && this.defaultTarget[1] === 0 && this.defaultTarget[2] === 0)) {
-            return this.zoomTo(undefined, options);
-        } else {
-            return this.set(vec3.clone(this.defaultPosition), vec3.clone(this.defaultTarget), options);
-        }
-    }
-
-    public async set(position: vec3, target: vec3, options?: ICameraOptions): Promise<boolean> {
-        if (!options) options = {};
-        options.duration = options.duration! >= 0 ? options.duration : this.cameraMovementDuration;
-
-        const res = await this._controls.animate([
-            { position: vec3.clone(this.position), target: vec3.clone(this.target) },
-            { position, target }], options);
-        if (res) {
-            this._position = this._controls.position;
-            this._target = this._controls.target;
-        }
-        return res;
-    }
-
-    public update(time: number): boolean {
-        if (this.useNodeData && this.node && this._viewportId) {
-            return true;
-        } else {
-            const { position, target, sceneRotation } = this._controls.update(time);
-            let changed = true;
-            if (vec3.equals(position, this.position) && vec3.equals(target, this.target))
-                changed = false;
-
-            this.position = vec3.clone(position);
-            this.target = vec3.clone(target);
-            this.sceneRotation = vec2.clone(sceneRotation);
-            return changed;
-        }
-    }
-
-    public zoomTo(zoomTarget?: Box, options?: ICameraOptions): Promise<boolean> {
-        const { position, target } = this.calculateZoomTo(zoomTarget);
-        return this.set(position, target, options);
-    }
-
-    // #endregion Public Methods (5)
-
-    // #region Public Abstract Methods (5)
-
-    public abstract applySettings(settingsEngine?: SettingsEngine): void;
-    public abstract assignViewer(renderingEngine: IRenderingEngine): void;
-    public abstract calculateZoomTo(zoomTarget?: Box, startingPosition?: vec3, startingTarget?: vec3): { position: vec3; target: vec3; };
-    public abstract project(p: vec3): vec2;
-    public abstract unproject(p: vec3): vec3;
-
-    // #endregion Public Abstract Methods (5)
-
-    // #region Protected Methods (1)
-
-    protected assignViewerInternal(viewportId: string) {
-        this._viewportId = viewportId;
-        this._eventEngine.addListener(EVENTTYPE.SESSION.SESSION_CUSTOMIZED, async () => {
-            if (this.#autoAdjust === true) {
-                const innerListenerToken = this._eventEngine.addListener(EVENTTYPE.VIEWPORT.VIEWPORT_UPDATED, async () => {
-                    this.zoomTo();
-                    this._eventEngine.removeListener(innerListenerToken);
-                });
-            }
-        });
-    }
-
-    // #endregion Protected Methods (1)
-}

package/src/implementation/camera/OrthographicCamera.ts

@@ -1,282 +0,0 @@
-import { AbstractCamera } from './AbstractCamera';
-import { Box, IBox } from '@shapediver/viewer.shared.math';
-import { CAMERA_TYPE } from '../../interfaces/ICameraEngine';
-import { ICameraControls } from '../../interfaces/controls/ICameraControls';
-import { IOrthographicCamera, ORTHOGRAPHIC_CAMERA_DIRECTION } from '../../interfaces/camera/IOrthographicCamera';
-import { IOrthographicCameraSettings } from '@shapediver/viewer.settings';
-import { IRenderingEngine } from '@shapediver/viewer.rendering-engine.rendering-engine';
-import { ITree, Tree } from '@shapediver/viewer.shared.node-tree';
-import { mat4, vec2, vec3 } from 'gl-matrix';
-import { OrthographicCameraControls } from '../controls/OrthographicCameraControls';
-import {
-  Converter,
-  DomEventEngine,
-  Logger,
-  SettingsEngine,
-  ShapeDiverViewerCameraError,
-} from '@shapediver/viewer.shared.services';
-
-export class OrthographicCamera extends AbstractCamera implements IOrthographicCamera {
-  // #region Properties (11)
-
-  readonly #converter: Converter = Converter.instance;
-  readonly #logger: Logger = Logger.instance;
-  readonly #tree: ITree = Tree.instance;
-
-  #bottom: number = -100;
-  #direction: ORTHOGRAPHIC_CAMERA_DIRECTION = ORTHOGRAPHIC_CAMERA_DIRECTION.CUSTOM;
-  #domEventEngine?: DomEventEngine;
-  #left: number = -100;
-  #right: number = 100;
-  #top: number = 100;
-  #up: vec3 = vec3.fromValues(0, 0, 1);
-
-  protected _controls: ICameraControls;
-
-  // #endregion Properties (11)
-
-  // #region Constructors (1)
-
-  constructor(id: string, version?: string, isDefault: boolean = false) {
-    super(id, CAMERA_TYPE.ORTHOGRAPHIC, version, isDefault);
-    this._controls = new OrthographicCameraControls(this, true);
-  }
-
-  // #endregion Constructors (1)
-
-  // #region Public Getters And Setters (14)
-
-  public get bottom(): number {
-    return this.#bottom;
-  }
-
-  public set bottom(value: number) {
-    this.#bottom = value;
-  }
-
-  public get controls(): ICameraControls {
-    return this._controls;
-  }
-
-  public set controls(value: ICameraControls) {
-    this._controls = value;
-  }
-
-  public get direction(): ORTHOGRAPHIC_CAMERA_DIRECTION {
-    return this.#direction;
-  }
-
-  public set direction(value: ORTHOGRAPHIC_CAMERA_DIRECTION) {
-    const changedDirection = this.#direction !== value;
-
-    this.#direction = value;
-    switch (this.#direction) {
-      case ORTHOGRAPHIC_CAMERA_DIRECTION.TOP:
-      case ORTHOGRAPHIC_CAMERA_DIRECTION.BOTTOM:
-        this.up = vec3.fromValues(0, 1, 0);
-        break;
-      case ORTHOGRAPHIC_CAMERA_DIRECTION.RIGHT:
-      case ORTHOGRAPHIC_CAMERA_DIRECTION.LEFT:
-        this.up = vec3.fromValues(0, 0, 1);
-        break;
-      case ORTHOGRAPHIC_CAMERA_DIRECTION.BACK:
-      case ORTHOGRAPHIC_CAMERA_DIRECTION.FRONT:
-        this.up = vec3.fromValues(0, 0, 1);
-        break;
-      default:
-        this.up = vec3.fromValues(0, 0, 1);
-    }
-
-    if (changedDirection) {
-      const { position, target } = this.calculateZoomTo(undefined);
-      this.defaultPosition = vec3.clone(position);
-      this.defaultTarget = vec3.clone(target);
-
-      this.position = vec3.clone(position);
-      this.target = vec3.clone(target);
-    }
-  }
-
-  public get left(): number {
-    return this.#left;
-  }
-
-  public set left(value: number) {
-    this.#left = value;
-  }
-
-  public get right(): number {
-    return this.#right;
-  }
-
-  public set right(value: number) {
-    this.#right = value;
-  }
-
-  public get top(): number {
-    return this.#top;
-  }
-
-  public set top(value: number) {
-    this.#top = value;
-  }
-
-  public get up(): vec3 {
-    return this.#up;
-  }
-
-  public set up(value: vec3) {
-    this.#up = value;
-  }
-
-  // #endregion Public Getters And Setters (14)
-
-  // #region Public Methods (6)
-
-  public applySettings(settingsEngine: SettingsEngine) {
-    const cameraSetting = <IOrthographicCameraSettings>settingsEngine.camera.cameras[this.id];
-    if (cameraSetting) {
-      this.name = cameraSetting.name;
-      this.autoAdjust = cameraSetting.autoAdjust;
-      this.cameraMovementDuration = cameraSetting.cameraMovementDuration;
-      this.enableCameraControls = cameraSetting.enableCameraControls;
-      this.revertAtMouseUp = cameraSetting.revertAtMouseUp;
-      this.revertAtMouseUpDuration = cameraSetting.revertAtMouseUpDuration;
-      this.sceneRotation = vec2.fromValues(cameraSetting.sceneRotation.x, cameraSetting.sceneRotation.y);
-      this.zoomExtentsFactor = cameraSetting.zoomExtentsFactor;
-
-      const position = this.#converter.toVec3(cameraSetting.position);
-      const target = this.#converter.toVec3(cameraSetting.target);
-      this.defaultPosition = vec3.clone(position);
-      this.defaultTarget = vec3.clone(target);
-
-      this.position = position;
-      this.target = target;
-    }
-
-    if (this.position[0] === this.target[0] && this.position[1] === this.target[1] && this.position[2] === this.target[2]) {
-      if (this._viewportId) {
-        this._stateEngine.viewportEngines[this._viewportId]?.boundingBoxCreated
-          .then(async () => {
-            await this.zoomTo(undefined, { duration: 0 });
-            this.defaultPosition = vec3.clone(this._controls.position);
-            this.defaultTarget = vec3.clone(this._controls.target);
-          });
-      }
-    }
-    (<OrthographicCameraControls>this._controls).applySettings(settingsEngine);
-  }
-
-  public assignViewer(renderingEngine: IRenderingEngine): void {
-    if (renderingEngine.closed)
-      throw new ShapeDiverViewerCameraError(`OrthographicCamera(${this.id}).assignViewer: Viewer with id ${renderingEngine.id} not found.`);
-
-    this.assignViewerInternal(renderingEngine.id);
-    this._controls.assignViewer(renderingEngine.id, renderingEngine.canvas);
-
-    if (this.domEventListenerToken && this.#domEventEngine)
-      this.#domEventEngine.removeDomEventListener(this.domEventListenerToken);
-
-    this.#domEventEngine = renderingEngine.domEventEngine;
-    this.domEventListenerToken = this.#domEventEngine.addDomEventListener((<OrthographicCameraControls>this._controls).cameraControlsEventDistribution);
-
-    this.boundingBox = this.#tree.root.boundingBox.clone();
-
-    this._stateEngine.viewportEngines[renderingEngine.id]?.boundingBoxCreated.then(async () => {
-      if (this.position[0] === this.target[0] && this.position[1] === this.target[1] && this.position[2] === this.target[2])
-        await this.zoomTo(undefined, { duration: 0 });
-    });
-  }
-
-  public calculateZoomTo(zoomTarget?: Box, startingPosition: vec3 = this.position, startingTarget: vec3 = this.target): { position: vec3; target: vec3; } {
-    let box: IBox;
-
-    // Part 1 - calculate the bounding box that we should zoom to
-    if (!zoomTarget) {
-      // complete scene
-      box = this._boundingBox.clone();
-    } else {
-      // specified Box
-      box = zoomTarget.clone();
-    }
-
-    if (box.isEmpty()) return { position: vec3.create(), target: vec3.create() };
-
-    const target = vec3.fromValues((box.max[0] + box.min[0]) / 2, (box.max[1] + box.min[1]) / 2, (box.max[2] + box.min[2]) / 2);
-    if (startingPosition[0] === startingTarget[0] && startingPosition[1] === startingTarget[1] && startingPosition[2] === startingTarget[2])
-      startingPosition = vec3.fromValues(target[0], target[1] - 7.5, target[2] + 5);
-
-    const factor = 2 * box.boundingSphere.radius * this.zoomExtentsFactor;
-
-    switch (this.#direction) {
-      case ORTHOGRAPHIC_CAMERA_DIRECTION.TOP:
-        return {
-          position: vec3.fromValues(target[0], target[1], target[2] + factor),
-          target: vec3.clone(target)
-        };
-      case ORTHOGRAPHIC_CAMERA_DIRECTION.BOTTOM:
-        return {
-          position: vec3.fromValues(target[0], target[1], target[2] - factor),
-          target: vec3.clone(target)
-        };
-      case ORTHOGRAPHIC_CAMERA_DIRECTION.RIGHT:
-        return {
-          position: vec3.fromValues(target[0] + factor, target[1], target[2]),
-          target: vec3.clone(target)
-        };
-      case ORTHOGRAPHIC_CAMERA_DIRECTION.LEFT:
-        return {
-          position: vec3.fromValues(target[0] - factor, target[1], target[2]),
-          target: vec3.clone(target)
-        };
-      case ORTHOGRAPHIC_CAMERA_DIRECTION.BACK:
-        return {
-          position: vec3.fromValues(target[0], target[1] + factor, target[2]),
-          target: vec3.clone(target)
-        };
-      case ORTHOGRAPHIC_CAMERA_DIRECTION.FRONT:
-        return {
-          position: vec3.fromValues(target[0], target[1] - factor, target[2]),
-          target: vec3.clone(target)
-        };
-      default:
-        {
-          // get the direction from the starting position to the starting target
-          const direction = vec3.subtract(vec3.create(), startingPosition, target);
-          // normalize the direction
-          vec3.normalize(direction, direction);
-          // get the new position
-          return {
-            position: vec3.add(vec3.create(), target, vec3.scale(vec3.create(), direction, factor)),
-            target: vec3.clone(target)
-          };
-        }
-    }
-  }
-
-  public clone(): IOrthographicCamera {
-    return new OrthographicCamera(this.id, this.version);
-  }
-
-  public project(pos: vec3): vec2 {
-    const m = mat4.targetTo(mat4.create(), this.position, this.target, this.up);
-    const p = mat4.ortho(mat4.create(), this.left, this.right, this.bottom, this.top, this.near, this.far);
-    let inverse = mat4.invert(mat4.create(), m);
-    if (!inverse) inverse = mat4.create();
-    vec3.transformMat4(pos, pos, inverse);
-    vec3.transformMat4(pos, pos, p);
-    return vec2.fromValues(pos[0], pos[1]);
-  }
-
-  public unproject(pos: vec3): vec3 {
-    const m = mat4.targetTo(mat4.create(), this.position, this.target, this.up);
-    const p = mat4.ortho(mat4.create(), this.left, this.right, this.bottom, this.top, this.near, this.far);
-    let inverse = mat4.invert(mat4.create(), p);
-    if (!inverse) inverse = mat4.create();
-    vec3.transformMat4(pos, pos, inverse);
-    vec3.transformMat4(pos, pos, m);
-    return vec3.clone(pos);
-  }
-
-  // #endregion Public Methods (6)
-}