polygonjs-engine/src/engine/nodes/utils/LifeCycleController.ts

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

import {BaseNodeType} from '../_Base';

type Callback = () => void;
type CallbackWithChildNode = (child_node: BaseNodeType) => void;

export class LifeCycleController {
	protected _creation_completed = false;
	protected _on_child_add_hooks: CallbackWithChildNode[] | undefined;
	private _on_child_remove_hooks: CallbackWithChildNode[] | undefined;
	// _on_creation_completed_hooks are used in the importer, once the node has been created, added and params are set
	// private _on_creation_completed_hooks: Callback[] | undefined;
	private _on_create_hooks: Callback[] | undefined;
	private _on_add_hooks: Callback[] | undefined;
	private _on_delete_hooks: Callback[] | undefined;
	constructor(protected node: BaseNodeType) {}

	dispose() {
		this._on_child_add_hooks = undefined;
		this._on_child_remove_hooks = undefined;
		this._on_create_hooks = undefined;
		this._on_add_hooks = undefined;
		this._on_delete_hooks = undefined;
	}

	set_creation_completed() {
		if (!this._creation_completed) {
			this._creation_completed = true;
			// this.run_on_creation_completed_hooks();
		}
	}
	get creation_completed() {
		return this.node.scene().loadingController.loaded() && this._creation_completed;
	}
	//
	//
	// ON CREATION COMPLETED
	//
	//
	// add_on_creation_completed_hook(callback: Callback) {
	// 	this._on_creation_completed_hooks = this._on_creation_completed_hooks || [];
	// 	this._on_creation_completed_hooks.push(callback);
	// }
	// private run_on_creation_completed_hooks() {
	// 	if (this._on_creation_completed_hooks) {
	// 		console.log('run_on_creation_completed_hooks', this.node.name);
	// 	}
	// 	this.execute_hooks(this._on_creation_completed_hooks);
	// }
	//
	//
	// ON CHILD ADD
	//
	//
	add_on_child_add_hook(callback: CallbackWithChildNode) {
		this._on_child_add_hooks = this._on_child_add_hooks || [];
		this._on_child_add_hooks.push(callback);
	}
	run_on_child_add_hooks(node: BaseNodeType) {
		this.execute_hooks_with_child_node(this._on_child_add_hooks, node);
	}

	//
	//
	// ON CHILD REMOVE
	//
	//
	add_on_child_remove_hook(callback: CallbackWithChildNode) {
		this._on_child_remove_hooks = this._on_child_remove_hooks || [];
		this._on_child_remove_hooks.push(callback);
	}
	run_on_child_remove_hooks(node: BaseNodeType) {
		this.execute_hooks_with_child_node(this._on_child_remove_hooks, node);
	}

	//
	//
	// ON CREATE
	//
	//
	add_on_create_hook(callback: Callback) {
		this._on_create_hooks = this._on_create_hooks || [];
		this._on_create_hooks.push(callback);
	}
	run_on_create_hooks() {
		this.execute_hooks(this._on_create_hooks);
	}

	//
	//
	// ON ADD
	//
	//
	add_on_add_hook(callback: Callback) {
		this._on_add_hooks = this._on_add_hooks || [];
		this._on_add_hooks.push(callback);
	}
	run_on_add_hooks() {
		this.execute_hooks(this._on_add_hooks);
	}

	//
	//
	// ON DELETE
	//
	//
	add_delete_hook(callback: Callback) {
		this._on_delete_hooks = this._on_delete_hooks || [];
		this._on_delete_hooks.push(callback);
	}
	run_on_delete_hooks() {
		this.execute_hooks(this._on_delete_hooks);
	}

	//
	//
	// UTILS
	//
	//
	protected execute_hooks(hooks: Callback[] | undefined) {
		if (hooks) {
			let hook: Callback | undefined;
			// do not flush, as this MAY BE needed multiple times
			for (hook of hooks) {
				hook();
			}
		}
	}
	protected execute_hooks_with_child_node(hooks: CallbackWithChildNode[] | undefined, child_node: BaseNodeType) {
		if (hooks) {
			let hook: CallbackWithChildNode | undefined;
			// do not flush, as this is needed multiple times
			for (hook of hooks) {
				hook(child_node);
			}
		}
	}
}