CesiumRasterOverlays::LoadTileImageFromUrlOptions Struct Reference

Options for RasterOverlayTileProvider::loadTileImageFromUrl. More...

#include <CesiumRasterOverlays/RasterOverlayTileProvider.h>

Public Attributes
CesiumGeometry::Rectangle	rectangle {}
	The rectangle definining the bounds of the image being loaded, expressed in the RasterOverlayTileProvider's projection.
std::vector< CesiumUtility::Credit >	credits {}
	The credits to display with this tile. More...
bool	moreDetailAvailable = true
	Whether more detailed data, beyond this image, is available within the bounds of this image.
bool	allowEmptyImages = false
	Whether empty (zero length) images are accepted as a valid response. More...

Detailed Description

Options for RasterOverlayTileProvider::loadTileImageFromUrl.

Definition at line 69 of file RasterOverlayTileProvider.h.

Member Data Documentation

allowEmptyImages

bool CesiumRasterOverlays::LoadTileImageFromUrlOptions::allowEmptyImages = false

Whether empty (zero length) images are accepted as a valid response.

If true, an otherwise valid response with zero length will be accepted as a valid 0x0 image. If false, such a response will be reported as an error.

RasterOverlayTileProvider::loadTile and RasterOverlayTileProvider::loadTileThrottled will treat such an image as "failed" and use the quadtree parent (or ancestor) image instead, but will not report any error.

This flag should only be set to true when the tile source uses a zero-length response as an indication that this tile is - as expected - not available.

Definition at line 107 of file RasterOverlayTileProvider.h.

credits

std::vector<CesiumUtility::Credit> CesiumRasterOverlays::LoadTileImageFromUrlOptions::credits {}

The credits to display with this tile.

This property is copied verbatim to the LoadedRasterOverlayImage::credits property.

Definition at line 82 of file RasterOverlayTileProvider.h.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/cesium-native/cesium-native/CesiumRasterOverlays/include/CesiumRasterOverlays/RasterOverlayTileProvider.h