summaryrefslogtreecommitdiff
path: root/include/mbgl/style/source.hpp
blob: 92341066b14e116ee28de13d8ec686af0b96cdb4 (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
#pragma once

#include <mbgl/util/noncopyable.hpp>
#include <mbgl/style/types.hpp>

#include <memory>
#include <string>

namespace mbgl {
namespace style {

/**
 * The runtime representation of a [source](https://www.mapbox.com/mapbox-gl-style-spec/#sources) from the Mapbox Style
 * Specification.
 *
 * `Source` is an abstract base class; concrete derived classes are provided for each source type. `Source` contains
 * functionality that is common to all layer types:
 *
 * * Runtime type information: type predicates and casting
 * * Accessors for properties common to all source types: ID, etc.
 * * Cloning and copying
 *
 * All other functionality lives in the derived classes. To instantiate a source, create an instance of the desired
 * type, passing the ID:
 *
 *     auto vectorSource = std::make_unique<VectorSource>("my-vector-source");
 */
class Source : public mbgl::util::noncopyable {
public:
    virtual ~Source();

    // Check whether this source is of the given subtype.
    template <class T>
    bool is() const;

    // Dynamically cast this source to the given subtype.
    template <class T>
    T* as() {
        return is<T>() ? reinterpret_cast<T*>(this) : nullptr;
    }

    template <class T>
    const T* as() const {
        return is<T>() ? reinterpret_cast<const T*>(this) : nullptr;
    }

    const std::string& getID() const;

    // Create a new source with the specified `id`. All other properties
    // are copied from this source.
    std::unique_ptr<Source> copy(const std::string& id) const;

    // Private implementation
    class Impl;
    const std::unique_ptr<Impl> baseImpl;

protected:
    const SourceType type;
    Source(SourceType, std::unique_ptr<Impl>);
};

} // namespace style
} // namespace mbgl