FollowingFrameOptions

class FollowingFrameOptions

Options that impact the generation of the following frame.

Types

BearingSmoothing
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.
FrameGeometryAfterManeuver
Link copied to clipboard
class FrameGeometryAfterManeuver
Options that modify the framed route geometries by appending additional points after maneuver to extend the view.
IntersectionDensityCalculation
Link copied to clipboard
class IntersectionDensityCalculation
Options that modify the framed route geometries based on the intersection density.
PitchNearManeuvers
Link copied to clipboard
class PitchNearManeuvers
Options that modify the framed route geometries when approaching a maneuver.

Functions

equals
Link copied to clipboard
open operator fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
open fun hashCode(): Int
toString
Link copied to clipboard
open fun toString(): String

Properties

bearingSmoothing
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.
bearingUpdatesAllowed
Link copied to clipboard
var bearingUpdatesAllowed: Boolean = true
If true, the source will manipulate Camera Bearing Property when producing following frame updates as necessary.
centerUpdatesAllowed
Link copied to clipboard
var centerUpdatesAllowed: Boolean = true
If true, the source will manipulate Camera Center Property when producing following frame updates as necessary.
defaultPitch
Link copied to clipboard
var defaultPitch: Double = 45.0
The default pitch that will be generated for following camera frames.
frameGeometryAfterManeuver
Link copied to clipboard
Options that modify the framed route geometries by appending additional points after maneuver to extend the view.
intersectionDensityCalculation
Link copied to clipboard
Options that modify the framed route geometries based on the intersection density.
maximizeViewableGeometryWhenPitchZero
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.
maxZoom
Link copied to clipboard
var maxZoom: Double = 16.35
The max zoom that will be generated for camera following frames.
minZoom
Link copied to clipboard
var minZoom: Double = 10.5
The min zoom that will be generated for camera following frames.
paddingUpdatesAllowed
Link copied to clipboard
var paddingUpdatesAllowed: Boolean = true
If true, the source will manipulate Camera Padding Property when producing following frame updates as necessary.
pitchNearManeuvers
Link copied to clipboard
Options that modify the framed route geometries when approaching a maneuver.
pitchUpdatesAllowed
Link copied to clipboard
var pitchUpdatesAllowed: Boolean = true
If true, the source will manipulate Camera Pitch Property when producing following frame updates as necessary.
zoomUpdatesAllowed
Link copied to clipboard
var zoomUpdatesAllowed: Boolean = true
If true, the source will manipulate Camera Zoom Property when producing following frame updates as necessary.