summaryrefslogtreecommitdiff
path: root/include/mbgl/map/view.hpp
blob: 41d57bdc9164dca3a39a88f950eba9e90a762c5f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
#ifndef MBGL_MAP_VIEW
#define MBGL_MAP_VIEW

#include <mbgl/util/chrono.hpp>
#include <functional>

#include <memory>

namespace mbgl {

class Map;
class StillImage;

enum MapChange : uint8_t {
    MapChangeRegionWillChange = 0,
    MapChangeRegionWillChangeAnimated = 1,
    MapChangeRegionIsChanging = 2,
    MapChangeRegionDidChange = 3,
    MapChangeRegionDidChangeAnimated = 4,
    MapChangeWillStartLoadingMap = 5,
    MapChangeDidFinishLoadingMap = 6,
    MapChangeDidFailLoadingMap = 7,
    MapChangeWillStartRenderingMap = 8,
    MapChangeDidFinishRenderingMap = 9,
    MapChangeDidFinishRenderingMapFullyRendered = 10
};

class View {
public:
    virtual void initialize(Map *map_);

    // Called from the render thread. Makes the GL context active in the current
    // thread. This is typically just called once at the beginning of the
    // renderer setup since the render thread doesn't switch the contexts.
    virtual void activate() = 0;

    // Called from the render thread. Makes the GL context inactive in the current
    // thread. This is called once just before the rendering thread terminates.
    virtual void deactivate() = 0;

    virtual void notify() = 0;

    // Called from the render thread. The implementation should resize the framebuffer.
    virtual void resize(uint16_t width, uint16_t height, float pixelRatio);

    // Called from the render thread. The implementation must trigger a rerender.
    // (i.e. either the passed render() function for rendering immediately on the map thread,
    // or map->renderSync() from the main thread must be called as a result of this)
    virtual void invalidate(std::function<void()> render) = 0;

    // Reads the pixel data from the current framebuffer. If your View implementation
    // doesn't support reading from the framebuffer, return a null pointer.
    virtual std::unique_ptr<StillImage> readStillImage();

    // Notifies a watcher of map x/y/scale/rotation changes.
    // Must only be called from the same thread that caused the change.
    // Must not be called from the render thread.
    virtual void notifyMapChange(
        MapChange change,
        Duration delay = Duration::zero());

protected:
    mbgl::Map *map = nullptr;
};
}

#endif