@polygonjs/polygonjs/src/engine/scene/utils/SceneCamerasController.ts

node-based WebGL 3D engine https://polygonjs.com

import {PolyScene} from '../PolyScene';
import {Camera, Object3D} from 'three';
import {Poly} from '../../Poly';
import {CoreGraphNode} from '../../../core/graph/CoreGraphNode';
import {CreateViewerOptions} from '../../viewers/_Base';

type OnCameraObjectsUpdated = () => void;
interface MainCameraOptions {
	cameraMaskOverride?: string;
	findAnyCamera?: boolean;
	printCameraNotFoundError?: boolean;
}
const _cameras: Array<Camera> = [];

export class SceneCamerasController {
	private _coreGraphNode: CoreGraphNode;
	constructor(private scene: PolyScene) {
		this._coreGraphNode = new CoreGraphNode(this.scene, 'SceneCamerasController');
	}
	coreGraphNode() {
		return this._coreGraphNode;
	}
	dispose() {
		this._coreGraphNode.dispose();
	}
	private _cameraObjectsRecentlyUpdated: Array<Camera> = [];
	updateFromChangeInObject(object: Object3D) {
		this._cameraObjects(object, this._cameraObjectsRecentlyUpdated);
		if (this._cameraObjectsRecentlyUpdated.length > 0) {
			this._coreGraphNode.setDirty();
		}
		for (const callback of this._onCameraObjectsUpdatedCallbacks) {
			callback();
		}
	}
	cameraObjects(target: Array<Camera>) {
		this._cameraObjects(this.scene.threejsScene(), target);
		return target;
	}

	private _cameraObjects(parent: Object3D, cameraObjects: Array<Camera>) {
		cameraObjects.splice(0, cameraObjects.length);
		parent.traverse((object) => {
			if (Poly.camerasRegister.objectRegistered(object)) {
				cameraObjects.push(object as Camera);
			}
		});
	}
	cameraObjectsRecentlyUpdated() {
		return this._cameraObjectsRecentlyUpdated;
	}

	// _mainCameraObjectPath: string | null = null;

	setMainCamera(camera: Camera) {
		// this._mainCameraObjectPath = camera_node_path;
		this.scene.root().mainCameraController.setCamera(camera);
	}
	setMainCameraPath(path: string) {
		this.scene.root().mainCameraController.setCameraPath(path);
	}
	mainCameraPath() {
		return this.scene.root().mainCameraController.rawCameraPath();
	}
	// async mainCameraObjectPath() {
	// 	return this._mainCameraObjectPath;
	// }
	private _errorMessageDisplayed: boolean = false;
	async mainCamera(options?: MainCameraOptions): Promise<Camera | null> {
		if (this.scene.disposed()) {
			return null;
		}

		let printCameraNotFoundError = true;
		if (options?.printCameraNotFoundError != null) {
			printCameraNotFoundError = options.printCameraNotFoundError;
		}
		const cameraMaskOverride = options?.cameraMaskOverride;
		if (cameraMaskOverride != null) {
			this.scene.root().mainCameraController.setCameraPath(cameraMaskOverride);
		}

		const _printWarningMessage = (warningMessage: string) => {
			if (this._errorMessageDisplayed == true) {
				return;
			}
			if (printCameraNotFoundError) {
				console.error(warningMessage);
				this._errorMessageDisplayed = true;
			}
		};

		const camera = await this.scene.root().mainCameraController.camera();
		if (camera) {
			return camera;
		}
		let findAnyCamera = true;
		if (options?.findAnyCamera != null) {
			findAnyCamera = options.findAnyCamera;
		}
		const cameraPath = await this.scene.root().mainCameraController.cameraPath();
		const warningMessage = `No camera found at path '${cameraPath}'. Make sure to set the root parameter 'mainCameraPath' to match a camera (from the top menu Windows->Root Node Params)`;
		if (findAnyCamera) {
			const firstAnyCamera = this._findAnyCameraObject();
			if (firstAnyCamera) {
				_printWarningMessage(warningMessage);

				return firstAnyCamera;
			}
		}

		_printWarningMessage(warningMessage);

		return null;
	}

	private _findAnyCameraObject(): Camera | null {
		this.cameraObjects(_cameras);
		return _cameras[0];
	}

	async createMainViewer(options?: CreateViewerOptions) {
		const camera = await this.mainCamera({
			cameraMaskOverride: options?.cameraMaskOverride,
		});
		if (!camera) {
			return;
		}
		return Poly.camerasRegister.createViewer({
			...options,
			camera,
			scene: this.scene,
		});
	}

	private _onCameraObjectsUpdatedCallbacks: OnCameraObjectsUpdated[] = [];
	onCameraObjectsUpdated(callback: OnCameraObjectsUpdated) {
		const index = this._onCameraObjectsUpdatedCallbacks.indexOf(callback);
		if (index >= 0) {
			return;
		}
		this._onCameraObjectsUpdatedCallbacks.push(callback);
	}
	removeOnCameraObjectsUpdated(callback: OnCameraObjectsUpdated) {
		const index = this._onCameraObjectsUpdatedCallbacks.indexOf(callback);
		if (index >= 0) {
			this._onCameraObjectsUpdatedCallbacks.splice(index, 1);
		}
	}
}