MSFOptions

Checks if this object is equal to the specified object.

Returns the hash value of this object.

Returns the color of the ambient light.

Sets the ambient light color. Ambient light affects all lighting enabled models in the scene equally, it has no direction or location.

Returns the color of the main light.

Sets the color of the main light. The main light affects all lighting enabled models in the scene equally from a certain direction. This light can be used to simulate sun or moon light.

Returns the direction of the main light.

Sets the direction of the main light. The main light affects all lighting enabled models in the scene equally from a certain direction. This light can be used to simulate sun or moon light. The direction is always measured based on the local tangent frame of the focus point.

Returns the render projection mode.

Sets the render projection mode. The default is RenderProjectionMode::PLANAR.

Returns the state of the tile border debug overlay.

Sets the state of the tile border debug overlay. Every tile layer then outlines the tiles it actually draws, in 3D following the terrain, with a colour per zoom level and alternating brightness between neighbours - so a layer using a coarser tile set than the one under it, an overzoomed stand-in, or a tile that owns pixels it should not, is visible on screen. The default is false.

Returns the click type detection state.

Sets the state of the click type detection flag. If set to true clicks are categorized as normal clicks, double clicks, long clicks and dual clicks. The default is true.

Returns how far a pointer may travel before a press stops counting as a click.

Sets how far a pointer may travel before a press stops counting as a click and the map starts panning. The default, 32 dp, is a finger-sized threshold; a mouse wants far less (maplibre uses 3 px), which is why a desktop or web host lowers it.

Returns the double click detection state.

Sets the state of the double click detection flag. If set to true clicks, then double clicks are detected separately from normal clicks. are categorized as normal clicks, double clicks, The click type resolving takes about 400ms (configurable via setDoubleClickMaxDuration), so for applications that do not require this functionality, it can be turned off. The default is true.

Returns the long click duration in seconds.

Sets the long click duration in seconds. The default is value is 0.4 (400ms).

Returns the double click max duration in seconds.

Sets the double click max in seconds. The default is value is 0.4 (400ms).

Returns the tile size used for drawing map tiles.

Sets the tile size for drawing map tiles. Different datasources may have different tile sizes, this option can be used to compensate for bigger or smaller tiles than default. The default is 256.

A style’s own sizes do NOT follow it: a vector tile layer decodes against this size, so a label stays the same dp whatever tile the layer picks. Set it before adding the layer - a layer reads it when it joins the map.

Returns how many zoom levels the camera is offset from the tile-size convention.

Sets how many zoom levels the camera is offset from the tile-size convention.

The SDK calibrates on a 256-pixel tile, maplibre and mapbox-gl on a 512-pixel one, so an offset of 1 adopts theirs. It RENUMBERS and nothing else: label and line sizes do not move with it, which is why it is not just a bigger TileDrawSize. Changing it changes what getZoom() reports, so a stored camera and a visibleZoomRange move with it.

Returns the factor on the screen size a tile may cover before it is refined.

Sets how big a tile may get on screen before the next zoom level is used, as a factor on tangram’s rule (core/src/tile/tileManager.cpp): refine while the tile’s projected screen area is at least that of a 2x2 block of nominal tiles. A factor of 1 is that rule verbatim, larger keeps tiles coarser (fewer tiles, fewer labels, less detail), smaller refines further. Where it matters is a tilted view: a tile near the horizon collapses to a few pixels of screen while its distance barely grows, so this - not the view distance - is what decides how much of the horizon band is drawn at full detail.

Returns how many distinct zoom levels a tilted view may spread over.

Sets how many distinct zoom levels the frame may spread over when the horizon is at the top of the screen - maplibre’s maxZoomLevelsOnScreen (setSourceTileLodParams). It sets how fast the level decays toward the horizon: HIGHER spreads more levels over the frame, so the far field coarsens faster and costs fewer tiles; LOWER keeps far ground finer and costs more. maplibre’s 9.314 is our screen-area rule exactly, so it is the default and changing nothing changes nothing. This supersedes the old TileLODForeshorteningLimit, which bounded the same term from the other side with a number that had no reference behind it.

Returns how many times more tiles a tilted view may load than a top-down one.

Sets the cap on how many more tiles a tilted view may load than a top-down one - maplibre’s tileCountMaxMinRatio. When the cap would be exceeded the level is lowered uniformly across the frame until it fits. NOTE this binds only when TileLODMaxZoomLevelsOnScreen asks for a gentler far field than the default: at the default the pitched view never counts as asking for more tiles than a flat one, so the cap is inert. It bounds the cost of refining the horizon, it does not rescue a view that is slow for another reason.

Applies a named set of the tile LOD numbers - TileLODFactor, TileLODMaxZoomLevelsOnScreen, TileLODTileCountRatio and TileStyleZoomLift at once. They multiply into the tile count, so tuning them separately is how a map ends up four times more expensive than any reference renderer without anyone deciding to. Set a profile for the platform, then override one number if a specific map needs it.

Returns how many zoom levels above its own a coarsened tile may be styled at.

Sets how many zoom levels above its own zoom a coarsened tile matches its style rules at. The LOD rule (see setTileLODFactor) hands back a tile coarser than the camera asked for, and a CartoCSS [zoom] filter gates on the TILE, so a converted MapBox style’s minzoom - a VIEW-zoom gate in the original - stops matching the moment the tile coarsens: one level, and the far half of a tilted view loses every building along a straight tile edge. This lifts the zoom the rules are matched at, without changing which tiles are drawn. It is bounded because a far tile styled at the camera’s zoom emits the whole near-field content - every label, every arrow - over ground tens of times wider. 2 covers the first two coarsening steps, where the visible edge is; 0 restores the tile’s own zoom.

Returns the dots per inch value.

Sets the dots per inch value. This is calculated automatically by the SDK when the MapView is created using the device screen parameters. The purpose of this value is to compensate for very high or low resolution devices, so that the map remains readable.

Returns the draw distance value.

Sets a new draw distance value. The higher the draw distance the more tiles can be seen, if the map is tilted. Changing the draw distance will cause the horizon to move, which means that the if the sky bitmap is used, the horizon may not match up anymore. Increasing this value will decrease performance and increase network traffic, if online map is used. The default is 16.

Returns the vertial field of view angle.

Sets the vertial field of view angle. Larger values increase the viewable area, at the cost of performance and additional perspective distortion. The default is 70.

Returns the panning mode.

Sets the panning mode. The default is PanningMode::FREE.

Returns the pivot mode.

Sets the pivot mode. The default is PIVOT_MODE_TOUCHPOINT

Returns the state of seamless horizontal panning flag.

Sets the state of seamless horizontal panning flag. If set to true, the user can scroll seamlessly from the left side of the map to the right, and the other way around. The default is true.

Returns the state of the restricted panning flag.

Sets the restricted panning flag. If set to true, then focus point coordinates and zoom level of the map view will be adjusted to display as little empty background as possible. The default is false.

Returns true if tilting gesture direction is reversed (and same as with Google Maps).

Sets the tilting gesture direction. By default, the gesture is not reversed.

Returns the state of zoom gestures.

Sets the zoom gestures flag. Zoom gestures allow to use double click and dual click to zoom in/out of the map. Enabled by default. Note that zoom gestures require that click detection mode is enabled and also that double click detection is enabled.

Returns the state of rotation gestures.

Sets the rotation gestures flag. Rotation gestures allow to use pinch to rotate the map. By default, rotation gestures are not enabled.

Returns the number of threads used by the envelope task pool.

Sets the number of threads used by the envelope task pool. More threads means more envelope tasks are executed in parallel. This might speed up the data query, but may cause performance drops. Default is 1.

Returns the number of threads used by the tile task pool.

Sets the number of threads used by the tile task pool. More threads means more tile tasks are executed in parallel. This might speed up the data query, but may cause performance drops. Default is 1.

Returns the clear color used by the renderer before drawing anything else. By default, this is white. It should be set to (0, 0, 0, 0) if transparent MapView is needed.

Sets the clear color of the renderer.

Returns the sky color.

Sets the sky color. The purpose of the sky bitmap is to fill out the empty space visible at low tilt angles.

Returns the background bitmap. May be null.

Sets the background bitmap. The purpose of the background bitmap is to fill out the empty space when there’s no map data visible. The bitmap will get scaled and repeated to cover the hole visible area. If a null pointer is passed, the background won’t be drawn. The width and height of the bitmap must be power of two (for example: 256 * 256 or 128 * 512). It’s also preferred if the bitmap was square (width == height), but this is not a requirement. The default is “default_background.png”.

Returns the state of the user input flag.

Sets the state of the user input flag. If set to false the user won’t be able to pan the map using touch controls, programmatic map panning using MapView methods is still possible. The default is false.

Returns the panning speed mode.

Sets how fast a one-finger pan moves the map on a tilted view. The default is PANNING_SPEED_MODE_ANCHORED, which keeps the speed a gesture starts with for as long as it lasts; PANNING_SPEED_MODE_MAP is the exact grab-the-world pan, which changes speed as the finger moves between near and far parts of the screen.

Returns the free roam mode.

Sets the free roam mode: what a one-finger drag does, and which camera model the tilt and the rotation follow. Free roam is what makes content placed in the sky (CelestialLayer) reachable, since it is normally off the top of the screen. To look ABOVE the horizon the tilt range has to allow a negative tilt - e.g. setTiltRange(MapRange(-90, 90)) - as it stops at the horizon by default. The default is FREE_ROAM_MODE_OFF.

Returns how fast a free roam drag turns the view.

Sets how fast a free roam drag turns the view, in degrees per inch of drag. The default is 90, i.e. an inch of drag turns a quarter turn.

Returns how far a first person move drag travels.

Sets how far a two-finger move travels in FREE_ROAM_MODE_FIRST_PERSON, per inch of drag, as a fraction of the distance from the camera to its focus point - so a move covers the same part of the view at any zoom. The default is 0.5.

Returns the state of the kinetic panning flag.

Sets the state of the kinetic panning flag. Kinetic panning allows the map to pan automatically using the inertia of the last swipe, after the user has finished interacting with the touch screen. Default is true.

Returns the state of the kinetic rotation flag.

Sets the state of the kinetic rotation flag. Kinetic rotation allows the map to rotate automatically using the inertia of the last swipe, after the user has finished interacting with the touch screen. Default is true.

Returns the state of kinetic zoom flag.

Sets the state of the kinetic zooming flag. Kinetic zooming allows the map to zoom automatically using the inertia of the last swipe, after the user has finished interacting with the touch screen. Default is true.

Returns the state of the map rotatability flag.

Sets the state of the map rotatability flag. If set to false the map can’t be rotated by any means. The default is true.

Returns the tilt range constraint.

Sets the tilt range constraint. This will limit the tilt angle of the camera to the specified range. The current tilt angle will remain unaffected, until the next time the tilt angle changes. The minimum tilt angle is -90 degrees and the maximum is 90 degrees. Values that are out of range will be clamped. The default value is MapRange(0, 90). A NEGATIVE tilt looks above the horizon: the camera stays where it is and the view pitches up, which is what an application showing the sky needs. It is opt-in, as the default range stops at the horizon.

Returns the zoom range constraint.

Sets the zoom range constraint. This will limit the zoom level of the camera to the specified range. The current zoom level will remain unaffected, until the next time the zoom level changes. The minimum zoom value is 0 and the maximum is 24. Values that are out of range will be clamped. The default value is MapRange(0, 24).

Returns the map panning bounds constraints. Map bounds minimum and maximum points are in the base projection’s coordinate system.

Sets the map panning bounds constraints. This will limit camera movement to the specified bounds. The current camera position will remain unaffected, until the next time camera position changes. Map bounds minimum and maximum points are expected to be in the base projection’s coordinate system. If the bounds are larger than the world size, they will be clamped to world bounds. The default value covers the whole world.

Returns the focus point offset (from screen center) in pixels.

Sets the focus point offset (from screen center) in pixels.

Returns the base projection.

Sets the base projection. All MapView, MapEventListener and Options methods use the coordinate system of this projection. For example, if base projection is set to EPSG3857 then MapView::getFocusPos returns the coordinates in the EPSG3857 coordinate system, The same applies to setter methods like MapView::setFocusPos which expect the input coordinates to be in the base projection’s coordinate system. The default is EPSG3857.

Returns the terrain options. May be null if no terrain is configured.

Sets the terrain options. When set, 3D terrain is rendered using the elevation data source of the terrain options. Note that terrain is currently only supported with the PLANAR render projection mode. Setting null disables terrain. Note: this feature is experimental and may change in future SDK versions.

Returns the sky options. May be null.

Sets the sky options. Attaching a SkyOptions object replaces the legacy sky bitmap band with a full-screen shader sky. Pass a null pointer to go back to the legacy sky.

Returns the fog (atmosphere) options. May be null.

Sets the fog options - the haze distant ground fades into and the colours it carries into the sky. Setting null, or leaving the fog color transparent, means no fog.

Returns the light (sun) options. May be null.

Sets the light (sun) options. The sun direction drives the shader sky, terrain surface lighting and shadows.

Sets wether layers are processed in reversed order to process labels. The default is true.

Returns wether layers are processed in reversed order to process labels.

Undocumented