@hmscore/cordova-plugin-hms-map/src/www/polyline.ts

Cordova HMS Map Plugin

/*
    Copyright 2020-2024. Huawei Technologies Co., Ltd. All rights reserved.

    Licensed under the Apache License, Version 2.0 (the "License")
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        https://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/

import {
    LatLng,
    PatternItem,
    JointType,
    Color,
    BitmapDescriptor,
} from "./interfaces";
import { asyncExec, setComponentOptions, getComponentOptions } from "./utils";

export interface Polyline {
    getColor(): Promise<Color>;
    getEndCap(): Promise<Cap>;
    getStartCap(): Promise<Cap>;
    getId(): string;
    getJointType(): Promise<JointType>;
    getPattern(): Promise<PatternItem[]>;
    getPoints(): Promise<LatLng[]>;
    getTag(): Promise<any>;
    getWidth(): Promise<number>;
    getZIndex(): Promise<number>;
    isClickable(): Promise<boolean>;
    isGeodesic(): Promise<boolean>;
    isVisible(): Promise<boolean>;

    remove(): Promise<void>;

    setClickable(clickable: boolean): Promise<void>;
    setColor(color: Color): Promise<void>;
    setStartCap(startCap: Cap): Promise<void>;
    setEndCap(endCap: Cap): Promise<void>;
    setGeodesic(geodesic: boolean): Promise<void>;
    setJointType(jointType: JointType): Promise<void>;
    setPattern(pattern: PatternItem[]): Promise<void>;
    setPoints(points: LatLng[]): Promise<void>;
    setTag(tag: any): Promise<void>;
    setVisible(visible: boolean): Promise<void>;
    setWidth(width: number): Promise<void>;
    setZIndex(zIndex: number): Promise<void>;
    setGradient(on: boolean): Promise<void>;
    setColorValues(colors: Color[]): Promise<void>;
}

export class PolylineImpl implements Polyline {
    private readonly mapDivId: string;
    private readonly mapCapsuleId: number;
    private readonly id: string;

    constructor(mapDivId: string, mapCapsuleId: number, componentId: string) {
        this.mapDivId = mapDivId;
        this.mapCapsuleId = mapCapsuleId;
        this.id = componentId;
    }

    getColor(): Promise<Color> {
        return getComponentOptions("getColor", this.mapDivId, this.id);
    }

    getEndCap(): Promise<Cap> {
        return this.parseCap(getComponentOptions("getEndCap", this.mapDivId, this.id));
    }

    getStartCap(): Promise<Cap> {
        return this.parseCap(getComponentOptions("getStartCap", this.mapDivId, this.id));
    }

    getId(): string {
        return this.id;
    }

    getJointType(): Promise<JointType> {
        return getComponentOptions("getJointType", this.mapDivId, this.id);
    }

    getPattern(): Promise<PatternItem[]> {
        return getComponentOptions("getPattern", this.mapDivId, this.id);
    }

    getPoints(): Promise<LatLng[]> {
        return getComponentOptions("getPoints", this.mapDivId, this.id);
    }

    getTag(): Promise<any> {
        return getComponentOptions("getTag", this.mapDivId, this.id);
    }

    getWidth(): Promise<number> {
        return getComponentOptions("getWidth", this.mapDivId, this.id);
    }

    getZIndex(): Promise<number> {
        return getComponentOptions("getZIndex", this.mapDivId, this.id);
    }

    isClickable(): Promise<boolean> {
        return getComponentOptions("isClickable", this.mapDivId, this.id);
    }

    isGeodesic(): Promise<boolean> {
        return getComponentOptions("isGeodesic", this.mapDivId, this.id);
    }

    isVisible(): Promise<boolean> {
        return getComponentOptions("isVisible", this.mapDivId, this.id);
    }

    remove(): Promise<void> {
        return asyncExec("HMSMap", "removeComponent", [this.mapDivId, this.id]);
    }

    setClickable(clickable: boolean): Promise<void> {
        return setComponentOptions("setClickable", { clickable: clickable }, this.mapDivId, this.id);
    }

    setColor(color: Color): Promise<void> {
        return setComponentOptions("setColor", { color: color }, this.mapDivId, this.id);
    }

    setStartCap(startCap: Cap): Promise<void> {
        return this.setCap(startCap, "setStartCap");
    }

    setEndCap(endCap: Cap): Promise<void> {
        return this.setCap(endCap, "setEndCap");
    }

    setGeodesic(geodesic: boolean): Promise<void> {
        return setComponentOptions("setGeodesic", { geodesic: geodesic }, this.mapDivId, this.id);
    }

    setJointType(jointType: JointType): Promise<void> {
        return setComponentOptions("setJointType", { jointType: jointType, }, this.mapDivId, this.id);
    }

    setPattern(pattern: PatternItem[]): Promise<void> {
        return setComponentOptions("setPattern", { pattern: pattern }, this.mapDivId, this.id);
    }

    setPoints(points: LatLng[]): Promise<void> {
        return setComponentOptions("setPoints", { points: points }, this.mapDivId, this.id);
    }

    setTag(tag: any): Promise<void> {
        return setComponentOptions("setTag", { tag: tag }, this.mapDivId, this.id);
    }

    setVisible(visible: boolean): Promise<void> {
        return setComponentOptions("setVisible", { visible: visible }, this.mapDivId, this.id);
    }

    setWidth(width: number): Promise<void> {
        return setComponentOptions("setWidth", { width: width }, this.mapDivId, this.id);
    }

    setZIndex(zIndex: number): Promise<void> {
        return setComponentOptions("setZIndex", { zIndex: zIndex }, this.mapDivId, this.id);
    }

    setGradient(on: boolean): Promise<void> {
        return setComponentOptions("setGradient", { on: on }, this.mapDivId, this.id);
    }

    setColorValues(colors: Color[]): Promise<void> {
        return setComponentOptions("setColorValues", { colors: colors }, this.mapDivId, this.id);
    }

    // TODO: Don't forget to parse cap when get method triggered.
    private async parseCap(promise: Promise<any>): Promise<Cap> {
        const value = await promise;
        if (value.type === Cap.TYPE_BUTT_CAP) return new ButtCap();
        else if (value.type === Cap.TYPE_SQUARE_CAP) return new SquareCap();
        else if (value.type === Cap.TYPE_ROUND_CAP) return new RoundCap();
        return new CustomCap(value.bitmapDescriptor, value.refWidth);
    }

    private setCap(cap: Cap, methodName: string): Promise<void> {
        let props: any = {};
        props["type"] = cap.getType();
        if (cap.getType() === Cap.TYPE_CUSTOM_CAP) {
            // Let's say custom cap
            props["bitmapDescriptor"] = (<CustomCap>cap).getBitmapDescriptor();
            if ((<CustomCap>cap).getRefWidth() !== null)
                props["refWidth"] = (<CustomCap>cap).getRefWidth();
        }
        return setComponentOptions(methodName, { cap: props }, this.mapDivId, this.id);
    }
}

export class Cap {
    static readonly TYPE_BUTT_CAP = 0;
    static readonly TYPE_SQUARE_CAP = 1;
    static readonly TYPE_ROUND_CAP = 2;
    static readonly TYPE_CUSTOM_CAP = 3;
    protected type: number = -1;
    protected refWidth?: number = -1;
    protected bitmapDescriptor?: BitmapDescriptor = {};

    getType(): number {
        return this.type;
    }
}

export class ButtCap extends Cap {
    constructor() {
        super();
        this.type = 0;
    }
}

export class RoundCap extends Cap {
    constructor() {
        super();
        this.type = 2;
    }
}

export class SquareCap extends Cap {
    constructor() {
        super();
        this.type = 1;
    }
}

export class CustomCap extends Cap {
    constructor(bitmapDescriptor: BitmapDescriptor, refWidth?: number) {
        super();
        this.type = 3;
        this.bitmapDescriptor = bitmapDescriptor;
        this.refWidth = refWidth;
    }

    getRefWidth(): number {
        return this.refWidth == null ? -1 : this.refWidth;
    }

    getBitmapDescriptor(): BitmapDescriptor {
        return this.bitmapDescriptor == undefined ? {} : this.bitmapDescriptor;
    }
}