UI Maps/com.mapbox.navigation.ui.maps.camera.data/FollowingFrameOptions

FollowingFrameOptions

class FollowingFrameOptions

Options that impact the generation of the following frame.

Constructors

fun FollowingFrameOptions()

Types

BearingSmoothing

class BearingSmoothing

Options that impact bearing generation to not be fixed to location's bearing but also taking into the direction to the upcoming maneuver.

FocalPoint

class FocalPoint(@FloatRange(from = 0.0, to = 1.0) val x: Double, @FloatRange(from = 0.0, to = 1.0) val y: Double)

Focal point that defines the position of the first framed geometry point.

FrameGeometryAfterManeuver

class FrameGeometryAfterManeuver

Options that modify the framed route geometries by appending additional points after maneuver to extend the view.

IntersectionDensityCalculation

class IntersectionDensityCalculation

Options that modify the framed route geometries based on the intersection density.

PitchNearManeuvers

class PitchNearManeuvers

Options that modify the framed route geometries when approaching a maneuver.

Properties

bearingSmoothing

val bearingSmoothing: FollowingFrameOptions.BearingSmoothing

Options that impact bearing generation to not be fixed to location's bearing but also taking into the direction to the upcoming maneuver.

bearingUpdatesAllowed

var bearingUpdatesAllowed: Boolean = true

If true, the source will manipulate Camera Bearing Property when producing following frame updates as necessary.

centerUpdatesAllowed

var centerUpdatesAllowed: Boolean = true

If true, the source will manipulate Camera Center Property when producing following frame updates as necessary.

defaultPitch

var defaultPitch: Double = 45.0

The default pitch that will be generated for following camera frames.

focalPoint

var focalPoint: FollowingFrameOptions.FocalPoint

Focal point that defines the position of the first framed geometry point (typically the user location indicator, if available) in the MapboxNavigationViewportDataSource.followingPadding.

frameGeometryAfterManeuver

val frameGeometryAfterManeuver: FollowingFrameOptions.FrameGeometryAfterManeuver

Options that modify the framed route geometries by appending additional points after maneuver to extend the view.

framingStrategy

var framingStrategy: FollowingCameraFramingStrategy

Set a FollowingCameraFramingStrategy used to calculate points to be framed for the following camera.

intersectionDensityCalculation

val intersectionDensityCalculation: FollowingFrameOptions.IntersectionDensityCalculation

Options that modify the framed route geometries based on the intersection density.

maximizeViewableGeometryWhenPitchZero

var maximizeViewableGeometryWhenPitchZero: Boolean = true

When a produced following frame has pitch 0 and there are at least 2 points available for framing, the puck will not be tied to the bottom edge of the MapboxNavigationViewportDataSource.followingPadding and instead move around the centroid of the framed geometry (user location plus additional points to frame together or maneuver if route is available) to maximize the view of that geometry within the MapboxNavigationViewportDataSource.followingPadding.

maxZoom

var maxZoom: Double = 16.35

The max zoom that will be generated for camera following frames.

minZoom

var minZoom: Double = 10.5

The min zoom that will be generated for camera following frames.

paddingUpdatesAllowed

var paddingUpdatesAllowed: Boolean = true

If true, the source will manipulate Camera Padding Property when producing following frame updates as necessary.

pitchNearManeuvers

val pitchNearManeuvers: FollowingFrameOptions.PitchNearManeuvers

Options that modify the framed route geometries when approaching a maneuver.