mbgl::Map Class Reference

#include <map.hpp>

Inheritance diagram for mbgl::Map:

Public Types
using	StillImageCallback = std::function< void(std::exception_ptr)>

Public Member Functions
	Map (RendererFrontend &, MapObserver &, const MapOptions &, const ResourceOptions &, const ClientOptions &=ClientOptions())
	~Map ()
void	renderStill (StillImageCallback)
void	renderStill (const CameraOptions &, MapDebugOptions, StillImageCallback)
void	triggerRepaint ()
	Triggers a repaint. More...
style::Style &	getStyle ()
const style::Style &	getStyle () const
void	setStyle (std::unique_ptr< style::Style >)
void	cancelTransitions ()
void	setGestureInProgress (bool)
bool	isGestureInProgress () const
bool	isRotating () const
bool	isScaling () const
bool	isPanning () const
CameraOptions	getCameraOptions (const std::optional< EdgeInsets > &=std::nullopt) const
void	jumpTo (const CameraOptions &)
void	easeTo (const CameraOptions &, const AnimationOptions &)
void	flyTo (const CameraOptions &, const AnimationOptions &)
void	moveBy (const ScreenCoordinate &, const AnimationOptions &={})
void	scaleBy (double scale, const std::optional< ScreenCoordinate > &anchor, const AnimationOptions &animation={})
void	pitchBy (double pitch, const AnimationOptions &animation={})
void	rotateBy (const ScreenCoordinate &first, const ScreenCoordinate &second, const AnimationOptions &={})
CameraOptions	cameraForLatLngBounds (const LatLngBounds &, const EdgeInsets &, const std::optional< double > &bearing=std::nullopt, const std::optional< double > &pitch=std::nullopt) const
CameraOptions	cameraForLatLngs (const std::vector< LatLng > &, const EdgeInsets &, const std::optional< double > &bearing=std::nullopt, const std::optional< double > &pitch=std::nullopt) const
CameraOptions	cameraForGeometry (const Geometry< double > &, const EdgeInsets &, const std::optional< double > &bearing=std::nullopt, const std::optional< double > &pitch=std::nullopt) const
LatLngBounds	latLngBoundsForCamera (const CameraOptions &) const
LatLngBounds	latLngBoundsForCameraUnwrapped (const CameraOptions &) const
void	setNorthOrientation (NorthOrientation)
void	setConstrainMode (ConstrainMode)
void	setViewportMode (ViewportMode)
void	setSize (Size)
MapOptions	getMapOptions () const
void	setProjectionMode (const ProjectionMode &)
ProjectionMode	getProjectionMode () const
ScreenCoordinate	pixelForLatLng (const LatLng &) const
LatLng	latLngForPixel (const ScreenCoordinate &) const
std::vector< ScreenCoordinate >	pixelsForLatLngs (const std::vector< LatLng > &) const
std::vector< LatLng >	latLngsForPixels (const std::vector< ScreenCoordinate > &) const
TransformState	getTransfromState () const
void	addAnnotationImage (std::unique_ptr< style::Image >)
void	removeAnnotationImage (const std::string &)
double	getTopOffsetPixelsForAnnotationImage (const std::string &)
AnnotationID	addAnnotation (const Annotation &)
void	updateAnnotation (AnnotationID, const Annotation &)
void	removeAnnotation (AnnotationID)
void	setPrefetchZoomDelta (uint8_t delta)
uint8_t	getPrefetchZoomDelta () const
void	setDebug (MapDebugOptions)
MapDebugOptions	getDebug () const
bool	isFullyLoaded () const
void	dumpDebugLogs () const
void	setFreeCameraOptions (const FreeCameraOptions &camera)
FreeCameraOptions	getFreeCameraOptions () const
Bounds
void	setBounds (const BoundOptions &options)
BoundOptions	getBounds () const
	Returns the current map bound options. All optional fields in BoundOptions are set. More...

Protected Member Functions
	Map (std::unique_ptr< Impl >)

Protected Attributes
const std::unique_ptr< Impl >	impl

Detailed Description

Definition at line 34 of file map.hpp.

Member Typedef Documentation

StillImageCallback

using mbgl::Map::StillImageCallback = std::function<void (std::exception_ptr)>

Register a callback that will get called (on the render thread) when all resources have been loaded and a complete render occurs.

Definition at line 45 of file map.hpp.

Constructor & Destructor Documentation

Map() [1/2]

mbgl::Map::Map ( RendererFrontend &  , MapObserver &  , const MapOptions &  , const ResourceOptions &  , const ClientOptions &  = ClientOptions()  )

explicit

~Map()

mbgl::Map::~Map

(

)

Map() [2/2]

mbgl::Map::Map ( std::unique_ptr< Impl >  )

protected

Member Function Documentation

addAnnotation()

AnnotationID mbgl::Map::addAnnotation

(

const Annotation &

)

addAnnotationImage()

void mbgl::Map::addAnnotationImage

(

std::unique_ptr< style::Image >

)

cameraForGeometry()

CameraOptions mbgl::Map::cameraForGeometry	(	const Geometry< double > &	,
		const EdgeInsets &	,
		const std::optional< double > &	bearing = std::nullopt,
		const std::optional< double > &	pitch = std::nullopt
	)		const

cameraForLatLngBounds()

CameraOptions mbgl::Map::cameraForLatLngBounds	(	const LatLngBounds &	,
		const EdgeInsets &	,
		const std::optional< double > &	bearing = std::nullopt,
		const std::optional< double > &	pitch = std::nullopt
	)		const

cameraForLatLngs()

CameraOptions mbgl::Map::cameraForLatLngs	(	const std::vector< LatLng > &	,
		const EdgeInsets &	,
		const std::optional< double > &	bearing = std::nullopt,
		const std::optional< double > &	pitch = std::nullopt
	)		const

cancelTransitions()

void mbgl::Map::cancelTransitions

(

)

dumpDebugLogs()

void mbgl::Map::dumpDebugLogs

(

)

const

easeTo()

void mbgl::Map::easeTo	(	const CameraOptions &	,
		const AnimationOptions &
	)

flyTo()

void mbgl::Map::flyTo	(	const CameraOptions &	,
		const AnimationOptions &
	)

getBounds()

BoundOptions mbgl::Map::getBounds

(

)

const

Returns the current map bound options. All optional fields in BoundOptions are set.

getCameraOptions()

CameraOptions mbgl::Map::getCameraOptions

(

const std::optional< EdgeInsets > &

= std::nullopt

)

const

getDebug()

MapDebugOptions mbgl::Map::getDebug

(

)

const

getFreeCameraOptions()

FreeCameraOptions mbgl::Map::getFreeCameraOptions

(

)

const

getMapOptions()

MapOptions mbgl::Map::getMapOptions

(

)

const

getPrefetchZoomDelta()

uint8_t mbgl::Map::getPrefetchZoomDelta

(

)

const

getProjectionMode()

ProjectionMode mbgl::Map::getProjectionMode

(

)

const

getStyle() [1/2]

style::Style& mbgl::Map::getStyle

(

)

getStyle() [2/2]

const style::Style& mbgl::Map::getStyle

(

)

const

getTopOffsetPixelsForAnnotationImage()

double mbgl::Map::getTopOffsetPixelsForAnnotationImage

(

const std::string &

)

getTransfromState()

TransformState mbgl::Map::getTransfromState

(

)

const

isFullyLoaded()

bool mbgl::Map::isFullyLoaded

(

)

const

isGestureInProgress()

bool mbgl::Map::isGestureInProgress

(

)

const

isPanning()

bool mbgl::Map::isPanning

(

)

const

isRotating()

bool mbgl::Map::isRotating

(

)

const

isScaling()

bool mbgl::Map::isScaling

(

)

const

jumpTo()

void mbgl::Map::jumpTo

(

const CameraOptions &

)

latLngBoundsForCamera()

LatLngBounds mbgl::Map::latLngBoundsForCamera

(

const CameraOptions &

)

const

latLngBoundsForCameraUnwrapped()

LatLngBounds mbgl::Map::latLngBoundsForCameraUnwrapped

(

const CameraOptions &

)

const

latLngForPixel()

LatLng mbgl::Map::latLngForPixel

(

const ScreenCoordinate &

)

const

latLngsForPixels()

std::vector<LatLng> mbgl::Map::latLngsForPixels

(

const std::vector< ScreenCoordinate > &

)

const

moveBy()

void mbgl::Map::moveBy	(	const ScreenCoordinate &	,
		const AnimationOptions &	= {}
	)

pitchBy()

void mbgl::Map::pitchBy	(	double	pitch,
		const AnimationOptions &	animation = {}
	)

pixelForLatLng()

ScreenCoordinate mbgl::Map::pixelForLatLng

(

const LatLng &

)

const

pixelsForLatLngs()

std::vector<ScreenCoordinate> mbgl::Map::pixelsForLatLngs

(

const std::vector< LatLng > &

)

const

removeAnnotation()

void mbgl::Map::removeAnnotation

(

AnnotationID

)

removeAnnotationImage()

void mbgl::Map::removeAnnotationImage

(

const std::string &

)

renderStill() [1/2]

void mbgl::Map::renderStill	(	const CameraOptions &	,
		MapDebugOptions	,
		StillImageCallback
	)

renderStill() [2/2]

void mbgl::Map::renderStill

(

StillImageCallback

)

rotateBy()

void mbgl::Map::rotateBy	(	const ScreenCoordinate &	first,
		const ScreenCoordinate &	second,
		const AnimationOptions &	= {}
	)

scaleBy()

void mbgl::Map::scaleBy	(	double	scale,
		const std::optional< ScreenCoordinate > &	anchor,
		const AnimationOptions &	animation = {}
	)

setBounds()

void mbgl::Map::setBounds

(

const BoundOptions &

options

)

setConstrainMode()

void mbgl::Map::setConstrainMode

(

ConstrainMode

)

setDebug()

void mbgl::Map::setDebug

(

MapDebugOptions

)

setFreeCameraOptions()

void mbgl::Map::setFreeCameraOptions

(

const FreeCameraOptions &

camera

)

FreeCameraOptions provides more direct access to the underlying camera entity. For backwards compatibility the state set using this API must be representable with CameraOptions as well. Parameters are clamped to a valid range or discarded as invalid if the conversion to the pitch and bearing presentation is ambiguous. For example orientation can be invalid if it leads to the camera being upside down or the quaternion has zero length.

setGestureInProgress()

void mbgl::Map::setGestureInProgress

(

bool

)

setNorthOrientation()

void mbgl::Map::setNorthOrientation

(

NorthOrientation

)

setPrefetchZoomDelta()

void mbgl::Map::setPrefetchZoomDelta

(

uint8_t

delta

)

When loading a map, if PrefetchZoomDelta is set to any number greater than 0, the map will first request a tile for zoom - delta in a attempt to display a full map at lower resolution as quick as possible. It will get clamped at the tile source minimum zoom. The default delta is 4.

setProjectionMode()

void mbgl::Map::setProjectionMode

(

const ProjectionMode &

)

setSize()

void mbgl::Map::setSize

(

Size

)

setStyle()

void mbgl::Map::setStyle

(

std::unique_ptr< style::Style >

)

setViewportMode()

void mbgl::Map::setViewportMode

(

ViewportMode

)

triggerRepaint()

void mbgl::Map::triggerRepaint

(

)

Triggers a repaint.

updateAnnotation()

void mbgl::Map::updateAnnotation	(	AnnotationID	,
		const Annotation &
	)

Member Data Documentation

impl

const std::unique_ptr<Impl> mbgl::Map::impl

protected

Definition at line 154 of file map.hpp.

---

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

• /home/runner/work/maplibre-native/maplibre-native/include/mbgl/map/map.hpp