FollowCameraOperatorConfig
The configuration for follow camera operators.
Applicable to CameraTrackingMode.FollowNorthUp, CameraTrackingMode.FollowRouteDirection, CameraTrackingMode.FollowDirection, CameraTrackingMode.FollowRouteNorthUp
Important: This is a Public Preview API. It may be changed or removed at any time.
Constructors
Types
Array of control points, each of which contains the camera configuration for a given distance to the next instruction on the route. Intermediate values are obtained by linear interpolation between the corresponding points.
Road class that is used along with ControlPoint to describe follow route camera operator behaviour.
Properties
Dictionary of control points named after the corresponding road classes. This part of the configuration is only valid for the CameraTrackingMode.FollowRouteDirection camera operator. The follow route camera operator interpolates the tilt and scale according to the current camera position in relation to the next instruction, using the control points. Different control points can be defined for different road classes. The "default" road class is reserved for cases when there is no entry for a specific road class, or if the road class information is not available. If the entry for the "default" road class is missing, default internal values will be used in such cases. An example of a default internal value is a 0 tilt for both north-up follow camera operators.
Optional default field of view.
Optional default tilt allowed for this camera operator. The camera tilt is set to the default tilt upon activation of this camera operator.
Optional default zoom allowed for this camera operator. The camera zoom is set to the default zoom upon activation of this camera operator. When defined, should be greater than min-zoom if min-scale is defined; smaller than max-zoom if max-zoom is defined.
Determines the maximum zoom that can be applied to keep a combined next instruction in the safe area. This only applies in cases where the next instruction is combined with the one after it. If the zoom needed to keep the combined next instruction inside the safe area is greater than this value, the camera operator skips the current scale change. Future zoom changes are not affected.
Determines the maximum amount that the zoom can change per meter. This is needed because at each geometry point, the algorithm checks whether the combined instruction arrow fits within the safe area. If not, the zoom is increased. Changing the zoom too quickly is distracting. So zoom adjustments are smoothed: the zoom is gradually changed before the increased level is actually needed, then gradually changed back afterwards. Scale smoothing means that there are points when the view is more zoomed out than the combined instruction arrow needs. If too much smoothing is used, the zoom may not have time to return to its optimal level between adjustments.