MapLibre Native Core
Public Member Functions | Public Attributes | List of all members
mbgl::BoundOptions Struct Reference

Holds options to limit what parts of a map are visible. All fields are optional. More...

#include <bound_options.hpp>

Public Member Functions

BoundOptions & withLatLngBounds (LatLngBounds b)
 Sets the latitude and longitude bounds to which the camera center are constrained. More...
 
BoundOptions & withMinZoom (double z)
 Sets the minimum zoom level. More...
 
BoundOptions & withMaxZoom (double z)
 Sets the maximum zoom level. More...
 
BoundOptions & withMinPitch (double p)
 Sets the minimum pitch. More...
 
BoundOptions & withMaxPitch (double p)
 Sets the maximum pitch. More...
 

Public Attributes

std::optional< LatLngBounds > bounds
 Constrain the center of the camera to be within these bounds. More...
 
std::optional< double > maxZoom
 Maximum zoom level allowed. More...
 
std::optional< double > minZoom
 Minimum zoom level allowed. More...
 
std::optional< double > maxPitch
 Maximum pitch allowed in degrees. More...
 
std::optional< double > minPitch
 Minimum pitch allowed in degrees. More...
 

Detailed Description

Holds options to limit what parts of a map are visible. All fields are optional.

Definition at line 13 of file bound_options.hpp.

Member Function Documentation

◆ withLatLngBounds()

BoundOptions& mbgl::BoundOptions::withLatLngBounds ( LatLngBounds  b)
inline

Sets the latitude and longitude bounds to which the camera center are constrained.

Definition at line 15 of file bound_options.hpp.

◆ withMaxPitch()

BoundOptions& mbgl::BoundOptions::withMaxPitch ( double  p)
inline

Sets the maximum pitch.

Definition at line 26 of file bound_options.hpp.

◆ withMaxZoom()

BoundOptions& mbgl::BoundOptions::withMaxZoom ( double  z)
inline

Sets the maximum zoom level.

Definition at line 19 of file bound_options.hpp.

◆ withMinPitch()

BoundOptions& mbgl::BoundOptions::withMinPitch ( double  p)
inline

Sets the minimum pitch.

Definition at line 21 of file bound_options.hpp.

◆ withMinZoom()

BoundOptions& mbgl::BoundOptions::withMinZoom ( double  z)
inline

Sets the minimum zoom level.

Definition at line 17 of file bound_options.hpp.

Member Data Documentation

◆ bounds

std::optional<LatLngBounds> mbgl::BoundOptions::bounds

Constrain the center of the camera to be within these bounds.

Definition at line 32 of file bound_options.hpp.

◆ maxPitch

std::optional<double> mbgl::BoundOptions::maxPitch

Maximum pitch allowed in degrees.

Definition at line 41 of file bound_options.hpp.

◆ maxZoom

std::optional<double> mbgl::BoundOptions::maxZoom

Maximum zoom level allowed.

Definition at line 35 of file bound_options.hpp.

◆ minPitch

std::optional<double> mbgl::BoundOptions::minPitch

Minimum pitch allowed in degrees.

Definition at line 44 of file bound_options.hpp.

◆ minZoom

std::optional<double> mbgl::BoundOptions::minZoom

Minimum zoom level allowed.

Definition at line 38 of file bound_options.hpp.

The documentation for this struct was generated from the following file: