MapLibreParticleLab/include/mln/map/bound_options.hpp

#pragma once

#include <mln/util/geo.hpp>

#include <optional>

namespace mln {

/**
 * @brief Holds options to limit what parts of a map are visible. All fields are
 * optional.
 */
struct BoundOptions {
    /// Sets the latitude and longitude bounds to which the camera center are constrained
    /// If ConstrainMode is set to Screen these bounds describe what can be shown on screen.
    BoundOptions& withLatLngBounds(LatLngBounds b) {
        bounds = b;
        return *this;
    }
    /// Sets the minimum zoom level
    BoundOptions& withMinZoom(double z) {
        minZoom = z;
        return *this;
    }
    /// Sets the maximum zoom level
    BoundOptions& withMaxZoom(double z) {
        maxZoom = z;
        return *this;
    }
    /// Sets the minimum pitch
    BoundOptions& withMinPitch(double p) {
        minPitch = p;
        return *this;
    }
    /// Sets the maximum pitch
    BoundOptions& withMaxPitch(double p) {
        maxPitch = p;
        return *this;
    }

    /// Constrain the center of the camera to be within these bounds.
    /// If ConstrainMode is set to Screen these bounds describe what can be shown on screen.
    std::optional<LatLngBounds> bounds;

    /// Maximum zoom level allowed.
    std::optional<double> maxZoom;

    /// Minimum zoom level allowed.
    std::optional<double> minZoom;

    /// Maximum pitch allowed in degrees.
    std::optional<double> maxPitch;

    /// Minimum pitch allowed in degrees.
    std::optional<double> minPitch;
};

} // namespace mln