threear/src/PatternMarker.ts

A marker based Augmented Reality library for Three.js

import { Object3D } from "three";
import { BaseMarker } from "./BaseMarker";

/**
 * PatternMarker takes a given image (as a URL) and use this as the pattern to detect to place
 * a given marker from three.js, in this case an given Object3D
 * @param parameters parameters for determining things the pattern URL and minimum confidence
 */

interface PatternMarkerParameters {
	patternUrl: string;
	markerObject: Object3D;
	size?: number;
	minConfidence?: number;
}

export class PatternMarker extends BaseMarker {
	public static count = 0;
	public patternUrl: string;
	public markerObject: Object3D;

	constructor(parameters: PatternMarkerParameters) {
		super(parameters);

		if (!parameters.patternUrl) {
			throw Error("Pattern Marker requires a patternUrl to be passed");
		}

		if (parameters.markerObject === undefined) {
			throw Error("Pattern Marker requires a markerObject to be passed");
		}

		this.patternUrl = parameters.patternUrl;
		this.markerObject = parameters.markerObject;

		this.markerObject.visible = false;
	}
}

export default PatternMarker;