FollowingFrameOptions

class FollowingFrameOptions

Options that impact the generation of the following frame.

Constructors

Link copied to clipboard
fun FollowingFrameOptions()

Types

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
class FrameGeometryAfterManeuver

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

Link copied to clipboard
class IntersectionDensityCalculation

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

Link copied to clipboard
class PitchNearManeuvers

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

Properties

Link copied to clipboard

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

Link copied to clipboard
var bearingUpdatesAllowed: Boolean = true

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

Link copied to clipboard
var centerUpdatesAllowed: Boolean = true

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

Link copied to clipboard
var defaultPitch: Double = 45.0

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

Link copied to clipboard
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.

Link copied to clipboard

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

Link copied to clipboard
var framingStrategy: FollowingCameraFramingStrategy

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

Link copied to clipboard

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

Link copied to clipboard
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.

Link copied to clipboard
var maxZoom: Double = 16.35

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

Link copied to clipboard
var minZoom: Double = 10.5

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

Link copied to clipboard
var paddingUpdatesAllowed: Boolean = true

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

Link copied to clipboard

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

Link copied to clipboard
var pitchUpdatesAllowed: Boolean = true

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

Link copied to clipboard
var zoomUpdatesAllowed: Boolean = true

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