Cesium3DTilesSelection::RasterOverlayCollection Class Reference

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

#include <Cesium3DTilesSelection/RasterOverlayCollection.h>

Public Types
using	const_iterator
	A constant iterator for CesiumRasterOverlays::RasterOverlay instances.

Public Member Functions
	RasterOverlayCollection (const LoadedTileEnumerator &loadedTiles, const TilesetExternals &externals, const CesiumGeospatial::Ellipsoid &ellipsoid=CesiumGeospatial::Ellipsoid::WGS84) noexcept
	Creates a new instance.
void	setLoadedTileEnumerator (const LoadedTileEnumerator &loadedTiles)
	Provides a new LoadedTileEnumerator to use to update loaded tiles when a raster overlay is added or removed.
	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.
	~RasterOverlayCollection () noexcept
	Destroys the collection.
const std::vector< CesiumUtility::IntrusivePointer< CesiumRasterOverlays::ActivatedRasterOverlay > > &	getActivatedOverlays () const noexcept
	Gets the activated raster overlays in this collection.
void	add (const CesiumUtility::IntrusivePointer< const CesiumRasterOverlays::RasterOverlay > &pOverlay) noexcept
	Adds the given CesiumRasterOverlays::RasterOverlay to this collection.
void	remove (const CesiumUtility::IntrusivePointer< const CesiumRasterOverlays::RasterOverlay > &pOverlay) noexcept
	Remove the given CesiumRasterOverlays::RasterOverlay from this collection.
void	remove (const CesiumUtility::IntrusivePointer< CesiumRasterOverlays::RasterOverlay > &pOverlay) noexcept
	Remove the given CesiumRasterOverlays::RasterOverlay from this collection.
void	remove (const CesiumUtility::IntrusivePointer< CesiumRasterOverlays::ActivatedRasterOverlay > &pActivated) noexcept
	Remove the given CesiumRasterOverlays::ActivatedRasterOverlay from this collection.
std::vector< CesiumGeospatial::Projection >	addTileOverlays (Tile &tile, const TilesetOptions &tilesetOptions) noexcept
	Adds raster overlays to a new Tile.
TileRasterOverlayStatus	updateTileOverlays (Tile &tile, const TilesetOptions &tilesetOptions) noexcept
	Updates the raster overlays associated with a tile.
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 69 of file RasterOverlayCollection.h.

Member Typedef Documentation

const_iterator

using Cesium3DTilesSelection::RasterOverlayCollection::const_iterator

Initial value:

 CesiumUtility::TransformIterator<
      GetOverlayFunctor,
      std::vector<CesiumUtility::IntrusivePointer<
          CesiumRasterOverlays::ActivatedRasterOverlay>>::const_iterator>

A constant iterator for CesiumRasterOverlays::RasterOverlay instances.

Definition at line 212 of file RasterOverlayCollection.h.

Constructor & Destructor Documentation

RasterOverlayCollection() [1/3]

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

noexcept

Creates a new instance.

Parameters

loadedTiles	An enumerator for the loaded tiles. The raster overlay collection will copy this enumerator, and the copy must remain valid for the lifetime of the overlay collection or until setLoadedTileEnumerator is called with a new enumerator.
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< const CesiumRasterOverlays::RasterOverlay > & pOverlay )

noexcept

Adds the given CesiumRasterOverlays::RasterOverlay to this collection.

Parameters

pOverlay

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

addTileOverlays()

std::vector< CesiumGeospatial::Projection > Cesium3DTilesSelection::RasterOverlayCollection::addTileOverlays ( Tile & tile, const TilesetOptions & tilesetOptions )

noexcept

Adds raster overlays to a new Tile.

The tile should be in the TileLoadState::Unloaded or TileLoadState::FailedTemporarily state.

Any existing raster overlays on the tile will be cleared.

Parameters

tile	The tile for which to add the overlays.
tilesetOptions	The TilesetOptions for the tileset to which the tile belongs.

Returns

The list of projections required by the overlays that were added to the tile.

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.

setLoadedTileEnumerator()

void Cesium3DTilesSelection::RasterOverlayCollection::setLoadedTileEnumerator

(

const LoadedTileEnumerator &

loadedTiles

)

Provides a new LoadedTileEnumerator to use to update loaded tiles when a raster overlay is added or removed.

The raster overlay collection will copy this enumerator, and the copy must remain valid for the lifetime of the overlay collection or until setLoadedTileEnumerator is called with a new enumerator.

Parameters

loadedTiles

The new loaded tile enumerator.

updateTileOverlays()

TileRasterOverlayStatus Cesium3DTilesSelection::RasterOverlayCollection::updateTileOverlays ( Tile & tile, const TilesetOptions & tilesetOptions )

noexcept

Updates the raster overlays associated with a tile.

This method is called internally for each tile that is rendered, and gives the raster overlay system a chance to replace raster overlay placeholders with real tiles. Its return value is also used to determine whether or not this tile should be upsampled in order to attach further raster overlay detail.

Parameters

tile	The tile for which to update the overlays.
tilesetOptions	The TilesetOptions for the tileset to which the tile belongs.

Returns

Details of the raster overlays attached to this tile.

---

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

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