lume/src/core/Events.ts

Build next-level interactive web applications.

import type {Constructor} from 'lowclass/dist/Constructor.js'
import type {GLTF} from 'three/examples/jsm/loaders/GLTFLoader.js'
import type {Collada} from 'three/examples/jsm/loaders/ColladaLoader.js'
import type {Group} from 'three/src/objects/Group.js'
import type {BufferGeometry} from 'three/src/core/BufferGeometry.js'

export class EventTypes {
	constructor(
		// This event is fired when a *-model element, or a node element with a
		// *-model behavior, has loaded it's model.
		public MODEL_LOAD: {
			format: 'obj' | 'gltf' | 'collada' | 'fbx' | 'ply'
			model: Group | GLTF | Collada | BufferGeometry
		},
		// Fired if a *-model element, or node element with *-model behavior,
		// has an error during load.
		public MODEL_ERROR: Error,
		// Fired by elements that load resources. See
		// https://developer.mozilla.org/en-US/docs/Web/API/ProgressEvent
		public PROGRESS: ProgressEvent,
	) {}
}

export const Events = makeEnumFromClassProperties(EventTypes)

// loop on the keys of a dummy class instance in order to create an enum-like
// object.
export function makeEnumFromClassProperties<T>(Class: Constructor<T>) {
	const Enum = {} as any

	for (const key in new (Class as any)()) {
		Enum[key] = key
	}

	return Object.freeze(Enum as {[k in keyof T]: k})
}