summaryrefslogtreecommitdiff
path: root/include/mbgl/map
diff options
context:
space:
mode:
Diffstat (limited to 'include/mbgl/map')
-rw-r--r--include/mbgl/map/camera.hpp26
1 files changed, 13 insertions, 13 deletions
diff --git a/include/mbgl/map/camera.hpp b/include/mbgl/map/camera.hpp
index 3f39ca2dc9..1c389577f0 100644
--- a/include/mbgl/map/camera.hpp
+++ b/include/mbgl/map/camera.hpp
@@ -14,23 +14,23 @@ namespace mbgl {
struct CameraOptions {
/** Coordinate at the center of the map. */
optional<LatLng> center;
-
+
/** Padding around the interior of the view that affects the frame of
reference for `center`. */
optional<EdgeInsets> padding;
-
+
/** Point of reference for `zoom` and `angle`, assuming an origin at the
top-left corner of the view. */
optional<ScreenCoordinate> anchor;
-
+
/** Zero-based zoom level. Constrained to the minimum and maximum zoom
levels. */
optional<double> zoom;
-
+
/** Bearing, measured in radians counterclockwise from true north. Wrapped
to [−π rad, π rad). */
optional<double> angle;
-
+
/** Pitch toward the horizon measured in radians, with 0 rad resulting in a
two-dimensional map. */
optional<double> pitch;
@@ -42,33 +42,33 @@ struct CameraOptions {
struct AnimationOptions {
/** Time to animate to the viewpoint defined herein. */
optional<Duration> duration;
-
+
/** Average velocity of a flyTo() transition, measured in screenfuls per
second, assuming a linear timing curve.
-
+
A <i>screenful</i> is the visible span in pixels. It does not correspond
to a fixed physical distance but rather varies by zoom level. */
optional<double> velocity;
-
+
/** Zero-based zoom level at the peak of the flyTo() transition’s flight
path. */
optional<double> minZoom;
-
+
/** The easing timing curve of the transition. */
optional<mbgl::util::UnitBezier> easing;
-
+
/** A function that is called on each frame of the transition, just before a
screen update, except on the last frame. The first parameter indicates
the elapsed time as a percentage of the duration. */
std::function<void(double)> transitionFrameFn;
-
+
/** A function that is called once on the last frame of the transition, just
before the corresponding screen update. */
std::function<void()> transitionFinishFn;
-
+
/** Creates an animation with no options specified. */
AnimationOptions() {}
-
+
/** Creates an animation with the specified duration. */
AnimationOptions(Duration d)
: duration(d) {}