@polygonjs/polygonjs/src/engine/operations/sop/CameraControls.ts

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

import {BaseSopOperation} from './_Base';
import {CoreGroup} from '../../../core/geometry/Group';
import {InputCloneMode} from '../../../engine/poly/InputCloneMode';
import {DefaultOperationParams} from '../../../core/operations/_Base';
import {TypedNodePathParamValue} from '../../../core/Walker';
import {ThreejsCoreObject} from '../../../core/geometry/modules/three/ThreejsCoreObject';
import {CameraAttribute} from '../../../core/camera/CoreCamera';
import {CameraSopNodeType} from '../../poly/NodeContext';
import {BaseNodeType} from '../../nodes/_Base';
import {CoreObjectType, ObjectContent} from '../../../core/geometry/ObjectContent';
import {CoreMask} from '../../../core/geometry/Mask';

interface CameraControlsSopParams extends DefaultOperationParams {
	group: string;
	node: TypedNodePathParamValue;
}
interface UpdateObjectOptions {
	objects: ObjectContent<CoreObjectType>[];
	params: CameraControlsSopParams;
	node: BaseNodeType;
	active: boolean;
	errorIfNodeNotFound: boolean;
}

export class CameraControlsSopOperation extends BaseSopOperation {
	static override readonly DEFAULT_PARAMS: CameraControlsSopParams = {
		group: '',
		node: new TypedNodePathParamValue(''),
	};
	static override readonly INPUT_CLONED_STATE = InputCloneMode.FROM_NODE;
	static override type(): Readonly<CameraSopNodeType.CONTROLS> {
		return CameraSopNodeType.CONTROLS;
	}
	override cook(inputCoreGroups: CoreGroup[], params: CameraControlsSopParams) {
		const coreGroup = inputCoreGroups[0];
		const objects = CoreMask.filterObjects(coreGroup, {
			group: params.group,
		});

		if (this._node) {
			CameraControlsSopOperation.updateObject({
				objects,
				params,
				node: this._node,
				active: true,
				errorIfNodeNotFound: true,
			});
		}

		return coreGroup;
	}
	static updateObject(options: UpdateObjectOptions) {
		const {objects, params, node, active, errorIfNodeNotFound} = options;

		const relativeOrAbsolutePath = params.node.path();
		const foundNode = node.node(relativeOrAbsolutePath);
		if (foundNode && active) {
			// we need to give the absolute path, so that the creation of the viewer can find the node
			// without having to know which node set the path
			// Update: the absolute path on its own fails if some node in that path gets renamed.
			// Using the node id: this would fail if the target node was to be deleted and replaced.
			// Although that should really recook the camera
			const nodeId = foundNode.graphNodeId();
			for (let object of objects) {
				ThreejsCoreObject.addAttribute(object, CameraAttribute.CONTROLS_NODE_ID, nodeId);
			}
		} else {
			for (let object of objects) {
				ThreejsCoreObject.deleteAttribute(object, CameraAttribute.CONTROLS_NODE_ID);
			}
			if (errorIfNodeNotFound) {
				node.states.error.set('controls node not found');
			}
		}
	}
}