renderer.hpp

Go to the documentation of this file.

#pragma once
 
#include <mbgl/renderer/query.hpp>
#include <mbgl/annotation/annotation.hpp>
#include <mbgl/util/geo.hpp>
#include <mbgl/util/geojson.hpp>
 
#include <functional>
#include <memory>
#include <string>
#include <vector>
 
namespace mbgl {
 
class RendererObserver;
class RenderedQueryOptions;
class SourceQueryOptions;
class UpdateParameters;
 
namespace gfx {
class RendererBackend;
} // namespace gfx
 
struct PlacedSymbolData {
    std::u16string key;
    std::optional<mapbox::geometry::box<float>> textCollisionBox;
    std::optional<mapbox::geometry::box<float>> iconCollisionBox;
    bool textPlaced;
    bool iconPlaced;
    bool intersectsTileBorder;
    float viewportPadding;
    std::string layer;
};
 
class Renderer {
public:
    Renderer(gfx::RendererBackend&, float pixelRatio_, const std::optional<std::string>& localFontFamily = std::nullopt);
    ~Renderer();
 
    void markContextLost();
 
    void setObserver(RendererObserver*);
 
    void render(const std::shared_ptr<UpdateParameters>&);
 
    std::vector<Feature> queryRenderedFeatures(const ScreenLineString&, const RenderedQueryOptions& options = {}) const;
    std::vector<Feature> queryRenderedFeatures(const ScreenCoordinate& point, const RenderedQueryOptions& options = {}) const;
    std::vector<Feature> queryRenderedFeatures(const ScreenBox& box, const RenderedQueryOptions& options = {}) const;
    std::vector<Feature> querySourceFeatures(const std::string& sourceID, const SourceQueryOptions& options = {}) const;
    AnnotationIDs queryPointAnnotations(const ScreenBox& box) const;
    AnnotationIDs queryShapeAnnotations(const ScreenBox& box) const;
    AnnotationIDs getAnnotationIDs(const std::vector<Feature>&) const;
 
    FeatureExtensionValue queryFeatureExtensions(const std::string& sourceID,
                                                 const Feature& feature,
                                                 const std::string& extension,
                                                 const std::string& extensionField,
                                                 const std::optional<std::map<std::string, Value>>& args = std::nullopt) const;
 
    void setFeatureState(const std::string& sourceID, const std::optional<std::string>& sourceLayerID,
                         const std::string& featureID, const FeatureState& state);
 
    void getFeatureState(FeatureState& state,
                         const std::string& sourceID,
                         const std::optional<std::string>& sourceLayerID,
                         const std::string& featureID) const;
 
    void removeFeatureState(const std::string& sourceID,
                            const std::optional<std::string>& sourceLayerID,
                            const std::optional<std::string>& featureID,
                            const std::optional<std::string>& stateKey);
 
    // Debug
    void dumpDebugLogs();
 
    void collectPlacedSymbolData(bool enable);
 
    const std::vector<PlacedSymbolData>& getPlacedSymbolsData() const;
 
    // Memory
    void reduceMemoryUse();
    void clearData();
 
private:
    class Impl;
    std::unique_ptr<Impl> impl;
};
 
} // namespace mbgl