A collection of CesiumRasterOverlays::RasterOverlay instances that are associated with a Tileset. More...

#include <Cesium3DTilesSelection/RasterOverlayCollection.h>

Public Types
typedef std::vector< CesiumUtility::IntrusivePointer< CesiumRasterOverlays::RasterOverlay > >::const_iterator	const_iterator
	A constant iterator for `CesiumRasterOverlays::RasterOverlay` instances.

Public Member Functions
	RasterOverlayCollection (Tile::LoadedLinkedList &loadedTiles, const TilesetExternals &externals, const CesiumGeospatial::Ellipsoid &ellipsoid=CesiumGeospatial::Ellipsoid::WGS84) noexcept
	Creates a new instance.

	RasterOverlayCollection (const RasterOverlayCollection &rhs)=delete
	Deleted Copy constructor.

	RasterOverlayCollection (RasterOverlayCollection &&rhs) noexcept=default
	Move constructor.

RasterOverlayCollection &	operator= (const RasterOverlayCollection &rhs)=delete
	Deleted copy assignment.

RasterOverlayCollection &	operator= (RasterOverlayCollection &&rhs) noexcept=default
	Move assignment.

void	add (const CesiumUtility::IntrusivePointer< CesiumRasterOverlays::RasterOverlay > &pOverlay)
	Adds the given `CesiumRasterOverlays::RasterOverlay` to this collection.

void	remove (const CesiumUtility::IntrusivePointer< CesiumRasterOverlays::RasterOverlay > &pOverlay) noexcept
	Remove the given `CesiumRasterOverlays::RasterOverlay` from this collection.

const std::vector< CesiumUtility::IntrusivePointer< CesiumRasterOverlays::RasterOverlay > > &	getOverlays () const
	Gets the overlays in this collection.

const std::vector< CesiumUtility::IntrusivePointer< CesiumRasterOverlays::RasterOverlayTileProvider > > &	getTileProviders () const
	Gets the tile providers in this collection. Each tile provider corresponds with the overlay at the same position in the collection returned by `getOverlays`.

const std::vector< CesiumUtility::IntrusivePointer< CesiumRasterOverlays::RasterOverlayTileProvider > > &	getPlaceholderTileProviders () const
	Gets the placeholder tile providers in this collection. Each placeholder tile provider corresponds with the overlay at the same position in the collection returned by `getOverlays`.

CesiumRasterOverlays::RasterOverlayTileProvider *	findTileProviderForOverlay (CesiumRasterOverlays::RasterOverlay &overlay) noexcept
	Finds the tile provider for a given overlay.

const CesiumRasterOverlays::RasterOverlayTileProvider *	findTileProviderForOverlay (const CesiumRasterOverlays::RasterOverlay &overlay) const noexcept
	Finds the tile provider for a given overlay.

CesiumRasterOverlays::RasterOverlayTileProvider *	findPlaceholderTileProviderForOverlay (CesiumRasterOverlays::RasterOverlay &overlay) noexcept
	Finds the placeholder tile provider for a given overlay.

const CesiumRasterOverlays::RasterOverlayTileProvider *	findPlaceholderTileProviderForOverlay (const CesiumRasterOverlays::RasterOverlay &overlay) const noexcept
	Finds the placeholder tile provider for a given overlay.

const_iterator	begin () const noexcept
	Returns an iterator at the beginning of this collection.

const_iterator	end () const noexcept
	Returns an iterator at the end of this collection.

size_t	size () const noexcept
	Gets the number of overlays in the collection.

Detailed Description

A collection of CesiumRasterOverlays::RasterOverlay instances that are associated with a Tileset.

The raster overlay instances may be added to the raster overlay collection of a tileset that is returned with Tileset::getOverlays. When the tileset is loaded, one CesiumRasterOverlays::RasterOverlayTileProvider will be created for each raster overlay that had been added. The raster overlay tile provider instances will be passed to the CesiumRasterOverlays::RasterOverlayTile instances that they create when the tiles are updated.

Definition at line 30 of file RasterOverlayCollection.h.

Member Typedef Documentation

◆ const_iterator

std::vector<CesiumUtility::IntrusivePointer<CesiumRasterOverlays::RasterOverlay>>::const_iterator Cesium3DTilesSelection::RasterOverlayCollection::const_iterator

A constant iterator for CesiumRasterOverlays::RasterOverlay instances.

Definition at line 170 of file RasterOverlayCollection.h.

Constructor & Destructor Documentation

◆ RasterOverlayCollection() [1/3]

Cesium3DTilesSelection::RasterOverlayCollection::RasterOverlayCollection	(	Tile::LoadedLinkedList &	loadedTiles,
		const TilesetExternals &	externals,
		const CesiumGeospatial::Ellipsoid &	ellipsoid = CesiumGeospatial::Ellipsoid::WGS84 )

noexcept

Creates a new instance.

Parameters

loadedTiles	The list of loaded tiles. The collection does not own this list, so the list needs to be kept alive as long as the collection's lifetime
externals	A collection of loading system to load a raster overlay
ellipsoid	The `CesiumGeospatial::Ellipsoid`.

◆ RasterOverlayCollection() [2/3]

Cesium3DTilesSelection::RasterOverlayCollection::RasterOverlayCollection ( const RasterOverlayCollection & rhs )

delete

Deleted Copy constructor.

Parameters

rhs	The other instance.

◆ RasterOverlayCollection() [3/3]

Cesium3DTilesSelection::RasterOverlayCollection::RasterOverlayCollection ( RasterOverlayCollection && rhs )

defaultnoexcept

Move constructor.

Parameters

rhs	The other instance.

Member Function Documentation

◆ add()

void Cesium3DTilesSelection::RasterOverlayCollection::add ( const CesiumUtility::IntrusivePointer< CesiumRasterOverlays::RasterOverlay > & pOverlay )

Adds the given CesiumRasterOverlays::RasterOverlay to this collection.

Parameters

pOverlay The pointer to the overlay. This may not be nullptr.

◆ findPlaceholderTileProviderForOverlay() [1/2]

CesiumRasterOverlays::RasterOverlayTileProvider * Cesium3DTilesSelection::RasterOverlayCollection::findPlaceholderTileProviderForOverlay ( CesiumRasterOverlays::RasterOverlay & overlay )

noexcept

Finds the placeholder tile provider for a given overlay.

If the specified raster overlay is not part of this collection, this method will return nullptr.

This method will return the placeholder tile provider even if the real one has been created. This is useful to create placeholder tiles when the rectangle in the overlay's projection is not yet known.

Parameters

overlay The overlay for which to obtain the tile provider.

Returns: The placeholder tile provider, if any, corresponding to the raster overlay.

◆ findPlaceholderTileProviderForOverlay() [2/2]

const CesiumRasterOverlays::RasterOverlayTileProvider * Cesium3DTilesSelection::RasterOverlayCollection::findPlaceholderTileProviderForOverlay ( const CesiumRasterOverlays::RasterOverlay & overlay ) const

noexcept

Finds the placeholder tile provider for a given overlay.

If the specified raster overlay is not part of this collection, this method will return nullptr.

This method will return the placeholder tile provider even if the real one has been created. This is useful to create placeholder tiles when the rectangle in the overlay's projection is not yet known.

Parameters

overlay The overlay for which to obtain the tile provider.

Returns: The placeholder tile provider, if any, corresponding to the raster overlay.

◆ findTileProviderForOverlay() [1/2]

CesiumRasterOverlays::RasterOverlayTileProvider * Cesium3DTilesSelection::RasterOverlayCollection::findTileProviderForOverlay ( CesiumRasterOverlays::RasterOverlay & overlay )

noexcept

Finds the tile provider for a given overlay.

If the specified raster overlay is not part of this collection, this method will return nullptr.

If the overlay's real tile provider hasn't finished being created yet, a placeholder will be returned. That is, its CesiumRasterOverlays::RasterOverlayTileProvider::isPlaceholder method will return true.

Parameters

overlay The overlay for which to obtain the tile provider.

Returns: The tile provider, if any, corresponding to the raster overlay.

◆ findTileProviderForOverlay() [2/2]

const CesiumRasterOverlays::RasterOverlayTileProvider * Cesium3DTilesSelection::RasterOverlayCollection::findTileProviderForOverlay ( const CesiumRasterOverlays::RasterOverlay & overlay ) const

noexcept

Finds the tile provider for a given overlay.

If the specified raster overlay is not part of this collection, this method will return nullptr.

If the overlay's real tile provider hasn't finished being created yet, a placeholder will be returned. That is, its CesiumRasterOverlays::RasterOverlayTileProvider::isPlaceholder method will return true.

Parameters

overlay The overlay for which to obtain the tile provider.

Returns: The tile provider, if any, corresponding to the raster overlay.

◆ operator=() [1/2]

RasterOverlayCollection & Cesium3DTilesSelection::RasterOverlayCollection::operator= ( const RasterOverlayCollection & rhs )

delete

Deleted copy assignment.

Parameters

rhs	The other instance.

◆ operator=() [2/2]

RasterOverlayCollection & Cesium3DTilesSelection::RasterOverlayCollection::operator= ( RasterOverlayCollection && rhs )

defaultnoexcept

Move assignment.

Parameters

rhs	The other instance.

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

/home/runner/work/cesium-native/cesium-native/Cesium3DTilesSelection/include/Cesium3DTilesSelection/RasterOverlayCollection.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ const_iterator

Constructor & Destructor Documentation

◆ RasterOverlayCollection() [1/3]

◆ RasterOverlayCollection() [2/3]

◆ RasterOverlayCollection() [3/3]

Member Function Documentation

◆ add()

◆ findPlaceholderTileProviderForOverlay() [1/2]

◆ findPlaceholderTileProviderForOverlay() [2/2]

◆ findTileProviderForOverlay() [1/2]

◆ findTileProviderForOverlay() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]