com.mapbox.mapboxsdk.annotations.MultiPoint Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mapbox-android-sdk Show documentation

Mapbox GL Android SDK

There is a newer version: 9.2.1

package com.mapbox.mapboxsdk.annotations;

import com.mapbox.mapboxsdk.geometry.LatLng;

import java.util.ArrayList;
import java.util.List;

/**
 * Multipoint is an abstract annotation for combining geographical locations.
 */
public abstract class MultiPoint extends Annotation {

    private List points;
    private float alpha = 1.0f;

    protected MultiPoint() {
        super();
        points = new ArrayList<>();
    }

    /**
     * Returns a copy of the points.
     *
     * @return A {@link List} of points.
     */
    public List getPoints() {
        return new ArrayList<>(points);
    }

    /**
     * Sets the points of this polyline. This method will take a copy of the points, so further
     * mutations to points will have no effect on this polyline.
     *
     * @param points A {@link List} of {@link LatLng} points making up the polyline.
     */
    public void setPoints(List points) {
        this.points = new ArrayList<>(points);
        update();
    }

    /**
     * Add a point to the polyline.
     *
     * @param point A {@link LatLng} point to be added.
     */
    public void addPoint(LatLng point) {
        points.add(point);
        update();
    }

    /**
     * Value between 0 and 1 defining the polyline alpha.
     *
     * @return float value between 0 and 1.
     */
    public float getAlpha() {
        return alpha;
    }

    /**
     * Set this {@link MultiPoint}s alpha.
     *
     * @param alpha float value between 0 and 1.
     */
    public void setAlpha(float alpha) {
        this.alpha = alpha;
        update();
    }

    abstract void update();
}