mapillary-js/src/component/util/HandlerBase.ts

A WebGL interactive street imagery library

import { Component } from "../Component";
import { ComponentConfiguration } from "../interfaces/ComponentConfiguration";

import { Container } from "../../viewer/Container";
import { Navigator } from "../../viewer/Navigator";

export abstract class HandlerBase<TConfiguration extends ComponentConfiguration> {
    protected _component: Component<TConfiguration>;
    protected _container: Container;
    protected _navigator: Navigator;

    protected _enabled: boolean;

    /** @ignore */
    constructor(
        component: Component<TConfiguration>,
        container: Container,
        navigator: Navigator) {
        this._component = component;
        this._container = container;
        this._navigator = navigator;

        this._enabled = false;
    }

    /**
     * Returns a Boolean indicating whether the interaction is enabled.
     *
     * @returns {boolean} `true` if the interaction is enabled.
     */
    public get isEnabled(): boolean {
        return this._enabled;
    }

    /**
     * Enables the interaction.
     *
     * @example
     * ```js
     * <component-name>.<handler-name>.enable();
     * ```
     */
    public enable(): void {
        if (this._enabled || !this._component.activated) { return; }

        this._enable();
        this._enabled = true;

        this._component.configure(this._getConfiguration(true));
    }

    /**
     * Disables the interaction.
     *
     * @example
     * ```js
     * <component-name>.<handler-name>.disable();
     * ```
     */
    public disable(): void {
        if (!this._enabled) { return; }

        this._disable();
        this._enabled = false;

        if (this._component.activated) {
            this._component.configure(this._getConfiguration(false));
        }
    }

    protected abstract _enable(): void;

    protected abstract _disable(): void;

    protected abstract _getConfiguration(enable: boolean): TConfiguration;
}