Summarizes the result of loading an image of a RasterOverlay. More...

#include <CesiumRasterOverlays/RasterOverlayTileProvider.h>

Public Member Functions
int64_t	getSizeBytes () const
	Returns the size of this `LoadedRasterOverlayImage` in bytes.

Public Attributes
CesiumUtility::IntrusivePointer< CesiumGltf::ImageAsset >	pImage {nullptr}
	The loaded image.

CesiumGeometry::Rectangle	rectangle {}
	The projected rectangle defining the bounds of this image.

std::vector< CesiumUtility::Credit >	credits {}
	The `CesiumUtility::Credit` objects that decribe the attributions that are required when using the image.

CesiumUtility::ErrorList	errorList {}
	Errors and warnings from loading the image.

bool	moreDetailAvailable = false
	Whether more detailed data, beyond this image, is available within the bounds of this image.

Detailed Description

Summarizes the result of loading an image of a RasterOverlay.

Definition at line 28 of file RasterOverlayTileProvider.h.

Member Function Documentation

◆ getSizeBytes()

int64_t CesiumRasterOverlays::LoadedRasterOverlayImage::getSizeBytes ( ) const

inline

Returns the size of this LoadedRasterOverlayImage in bytes.

Definition at line 68 of file RasterOverlayTileProvider.h.

Member Data Documentation

◆ credits

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

The CesiumUtility::Credit objects that decribe the attributions that are required when using the image.

Definition at line 49 of file RasterOverlayTileProvider.h.

◆ errorList

CesiumUtility::ErrorList CesiumRasterOverlays::LoadedRasterOverlayImage::errorList {}

Errors and warnings from loading the image.

If the image was loaded successfully, there should not be any errors (but there may be warnings).

Definition at line 57 of file RasterOverlayTileProvider.h.

◆ moreDetailAvailable

bool CesiumRasterOverlays::LoadedRasterOverlayImage::moreDetailAvailable = false

Whether more detailed data, beyond this image, is available within the bounds of this image.

Definition at line 63 of file RasterOverlayTileProvider.h.

◆ pImage

CesiumUtility::IntrusivePointer<CesiumGltf::ImageAsset> CesiumRasterOverlays::LoadedRasterOverlayImage::pImage {nullptr}

The loaded image.

This will be an empty optional if the loading failed. In this case, the errors vector will contain the corresponding error messages.

Definition at line 35 of file RasterOverlayTileProvider.h.

◆ rectangle

CesiumGeometry::Rectangle CesiumRasterOverlays::LoadedRasterOverlayImage::rectangle {}

The projected rectangle defining the bounds of this image.

The rectangle extends from the left side of the leftmost pixel to the right side of the rightmost pixel, and similar for the vertical direction.

Definition at line 43 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

Public Member Functions

Public Attributes