Merge pull request #1597 from CesiumGS/request-headers-overlays

Add `RequestHeaders` properly to relevant raster overlays
CesiumGS · Jan 29, 2025 · 7440dcc · 7440dcc
2 parents 36a48bf + cd45d5c
commit 7440dcc
Show file tree

Hide file tree

Showing 9 changed files with 66 additions and 5 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -4,8 +4,10 @@
 
 ##### Additions :tada:
 
-- Added `RequestHeaders` property to `Cesium3DTileset`, allowing per-tileset headers to be specified.
 - Added `CesiumUrlTemplateRasterOverlay`, allowing a raster overlay to be added using tiles requested based on a specified URL template.
+- Added `RequestHeaders` property to `Cesium3DTileset`, allowing per-tileset headers to be specified.
+- Added `RequestHeaders` properties to `CesiumTileMapServiceRasterOverlay`, `CesiumUrlTemplateRasterOverlay`, `CesiumWebMapServiceRasterOverlay`,
+  and `CesiumWebMapTileServiceRasterOverlay`, allowing per-raster-overlay HTTP headers to be specified.
 
 ##### Fixes :wrench:
 

diff --git a/Source/CesiumRuntime/Private/CesiumTileMapServiceRasterOverlay.cpp b/Source/CesiumRuntime/Private/CesiumTileMapServiceRasterOverlay.cpp
@@ -17,10 +17,19 @@ UCesiumTileMapServiceRasterOverlay::CreateOverlay(
     tmsOptions.minimumLevel = MinimumLevel;
     tmsOptions.maximumLevel = MaximumLevel;
   }
+
+  std::vector<CesiumAsync::IAssetAccessor::THeader> headers;
+
+  for (const auto& [Key, Value] : this->RequestHeaders) {
+    headers.push_back(CesiumAsync::IAssetAccessor::THeader{
+        TCHAR_TO_UTF8(*Key),
+        TCHAR_TO_UTF8(*Value)});
+  }
+
   return std::make_unique<CesiumRasterOverlays::TileMapServiceRasterOverlay>(
       TCHAR_TO_UTF8(*this->MaterialLayerKey),
       TCHAR_TO_UTF8(*this->Url),
-      std::vector<CesiumAsync::IAssetAccessor::THeader>(),
+      headers,
       tmsOptions,
       options);
 }
diff --git a/Source/CesiumRuntime/Private/CesiumUrlTemplateRasterOverlay.cpp b/Source/CesiumRuntime/Private/CesiumUrlTemplateRasterOverlay.cpp
@@ -55,10 +55,18 @@ UCesiumUrlTemplateRasterOverlay::CreateOverlay(
         RootTilesY);
   }
 
+  std::vector<CesiumAsync::IAssetAccessor::THeader> headers;
+
+  for (const auto& [Key, Value] : this->RequestHeaders) {
+    headers.push_back(CesiumAsync::IAssetAccessor::THeader{
+        TCHAR_TO_UTF8(*Key),
+        TCHAR_TO_UTF8(*Value)});
+  }
+
   return std::make_unique<CesiumRasterOverlays::UrlTemplateRasterOverlay>(
       TCHAR_TO_UTF8(*this->MaterialLayerKey),
       TCHAR_TO_UTF8(*this->TemplateUrl),
-      std::vector<CesiumAsync::IAssetAccessor::THeader>(),
+      headers,
       urlTemplateOptions,
       options);
 }
diff --git a/Source/CesiumRuntime/Private/CesiumWebMapServiceRasterOverlay.cpp b/Source/CesiumRuntime/Private/CesiumWebMapServiceRasterOverlay.cpp
@@ -21,10 +21,19 @@ UCesiumWebMapServiceRasterOverlay::CreateOverlay(
   wmsOptions.layers = TCHAR_TO_UTF8(*Layers);
   wmsOptions.tileWidth = TileWidth;
   wmsOptions.tileHeight = TileHeight;
+
+  std::vector<CesiumAsync::IAssetAccessor::THeader> headers;
+
+  for (const auto& [Key, Value] : this->RequestHeaders) {
+    headers.push_back(CesiumAsync::IAssetAccessor::THeader{
+        TCHAR_TO_UTF8(*Key),
+        TCHAR_TO_UTF8(*Value)});
+  }
+
   return std::make_unique<CesiumRasterOverlays::WebMapServiceRasterOverlay>(
       TCHAR_TO_UTF8(*this->MaterialLayerKey),
       TCHAR_TO_UTF8(*this->BaseUrl),
-      std::vector<CesiumAsync::IAssetAccessor::THeader>(),
+      headers,
       wmsOptions,
       options);
 }
diff --git a/Source/CesiumRuntime/Private/CesiumWebMapTileServiceRasterOverlay.cpp b/Source/CesiumRuntime/Private/CesiumWebMapTileServiceRasterOverlay.cpp
@@ -103,10 +103,19 @@ UCesiumWebMapTileServiceRasterOverlay::CreateOverlay(
       wmtsOptions.tileMatrixLabels = labels;
     }
   }
+
+  std::vector<CesiumAsync::IAssetAccessor::THeader> headers;
+
+  for (const auto& [Key, Value] : this->RequestHeaders) {
+    headers.push_back(CesiumAsync::IAssetAccessor::THeader{
+        TCHAR_TO_UTF8(*Key),
+        TCHAR_TO_UTF8(*Value)});
+  }
+
   return std::make_unique<CesiumRasterOverlays::WebMapTileServiceRasterOverlay>(
       TCHAR_TO_UTF8(*this->MaterialLayerKey),
       TCHAR_TO_UTF8(*this->BaseUrl),
-      std::vector<CesiumAsync::IAssetAccessor::THeader>(),
+      headers,
       wmtsOptions,
       options);
 }
diff --git a/Source/CesiumRuntime/Public/CesiumTileMapServiceRasterOverlay.h b/Source/CesiumRuntime/Public/CesiumTileMapServiceRasterOverlay.h
@@ -52,6 +52,12 @@ class CESIUMRUNTIME_API UCesiumTileMapServiceRasterOverlay
       meta = (EditCondition = "bSpecifyZoomLevels", ClampMin = 0))
   int32 MaximumLevel = 10;
 
+  /**
+   * HTTP headers to be attached to each request made for this raster overlay.
+   */
+  UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Cesium")
+  TMap<FString, FString> RequestHeaders;
+
 protected:
   virtual std::unique_ptr<CesiumRasterOverlays::RasterOverlay> CreateOverlay(
       const CesiumRasterOverlays::RasterOverlayOptions& options = {}) override;

diff --git a/Source/CesiumRuntime/Public/CesiumUrlTemplateRasterOverlay.h b/Source/CesiumRuntime/Public/CesiumUrlTemplateRasterOverlay.h
@@ -220,6 +220,12 @@ class CESIUMRUNTIME_API UCesiumUrlTemplateRasterOverlay
       meta = (ClampMin = 64, ClampMax = 2048))
   int32 TileHeight = 256;
 
+  /**
+   * HTTP headers to be attached to each request made for this raster overlay.
+   */
+  UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Cesium")
+  TMap<FString, FString> RequestHeaders;
+
 protected:
   virtual std::unique_ptr<CesiumRasterOverlays::RasterOverlay> CreateOverlay(
       const CesiumRasterOverlays::RasterOverlayOptions& options = {}) override;

diff --git a/Source/CesiumRuntime/Public/CesiumWebMapServiceRasterOverlay.h b/Source/CesiumRuntime/Public/CesiumWebMapServiceRasterOverlay.h
@@ -75,6 +75,12 @@ class CESIUMRUNTIME_API UCesiumWebMapServiceRasterOverlay
       meta = (ClampMin = 0))
   int32 MaximumLevel = 14;
 
+  /**
+   * HTTP headers to be attached to each request made for this raster overlay.
+   */
+  UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Cesium")
+  TMap<FString, FString> RequestHeaders;
+
 protected:
   virtual std::unique_ptr<CesiumRasterOverlays::RasterOverlay> CreateOverlay(
       const CesiumRasterOverlays::RasterOverlayOptions& options = {}) override;

diff --git a/Source/CesiumRuntime/Public/CesiumWebMapTileServiceRasterOverlay.h b/Source/CesiumRuntime/Public/CesiumWebMapTileServiceRasterOverlay.h
@@ -267,6 +267,12 @@ class CESIUMRUNTIME_API UCesiumWebMapTileServiceRasterOverlay
       meta = (ClampMin = 64, ClampMax = 2048))
   int32 TileHeight = 256;
 
+  /**
+   * HTTP headers to be attached to each request made for this raster overlay.
+   */
+  UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Cesium")
+  TMap<FString, FString> RequestHeaders;
+
   virtual void Serialize(FArchive& Ar) override;
 
 protected: