Classes that implement the 3D Tiles standard. More...

Classes
class	CesiumIonTilesetContentLoaderFactory
	A factory for creating a TilesetContentLoader for assets from Cesium ion. More...

class	DebugTileStateDatabase
	Helps debug the tile selection algorithm by recording the state of tiles each frame to a SQLite database. More...

class	EllipsoidTilesetLoader
	A loader that will generate a tileset by tesselating the surface of an ellipsoid, producing a simple globe tileset without any terrain features. More...

struct	FogDensityAtHeight
	Defines the fog density at a certain height. More...

class	GltfModifier
	An abstract class that allows modifying a tile's glTF model after it has been loaded. More...

struct	GltfModifierInput
	The input to GltfModifier::apply. More...

struct	GltfModifierOutput
	The output of GltfModifier::apply. More...

struct	GltfModifierVersionExtension
	An extension holding the "version" of a glTF produced by GltfModifier. More...

class	IModelMeshExportContentLoaderFactory
	A factory for creating a TilesetContentLoader from data from the iModel Mesh Export API. More...

class	IPrepareRendererResources
	When implemented for a rendering engine, allows renderer resources to be created and destroyed under the control of a Tileset. More...

class	ITileExcluder
	An interface that allows tiles to be excluded from loading and rendering when provided in TilesetOptions::excluders. More...

class	ITilesetHeightSampler
	An interface to query heights from a tileset that can do so efficiently without necessarily downloading individual tiles. More...

class	ITwinCesiumCuratedContentLoaderFactory
	A factory for creating a TilesetContentLoader from data from the iTwin Cesium Curated Content API. More...

class	ITwinRealityDataContentLoaderFactory
	A factory for creating a TilesetContentLoader from data from the iTwin Reality Management API. More...

class	LoadedConstTileEnumerator
	A "virtual collection" that allows enumeration through the loaded tiles in a subtree rooted at a given Tile. More...

class	LoadedTileEnumerator
	A "virtual collection" that allows enumeration through the loaded tiles in a subtree rooted at a given Tile. More...

struct	LoaderCreditResult
	Credit information obtained from a TilesetContentLoader. More...

class	RasterizedPolygonsTileExcluder
	When provided to TilesetOptions::excluders, uses the polygons owned by a CesiumRasterOverlays::RasterizedPolygonsOverlay to exclude tiles that are entirely inside any of the polygon from loading. This is useful when the polygons will be used for clipping. More...

class	RasterMappedTo3DTile
	The result of applying a CesiumRasterOverlays::RasterOverlayTile to geometry. More...

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

struct	SampleHeightResult
	The result of sampling heights with Tileset::sampleHeightMostDetailed. More...

class	Tile
	A tile in a Tileset. More...

struct	TileChildrenResult
	Store the result of creating tile's children after invoking TilesetContentLoader::createTileChildren. More...

class	TileContent
	A tile content container that can store and query the content type that is currently being owned by the tile. More...

struct	TileEmptyContent
	A content tag that indicates a tile has no content. More...

struct	TileExternalContent
	A content tag that indicates a tile content points to an external tileset. When this tile is loaded, all the tiles in the external tileset will become children of this external content tile. More...

struct	TileIdUtilities
	Utility functions related to TileID objects. More...

struct	TileLoadInput
	Store the parameters that are needed to load a tile. More...

class	TileLoadRequester
	The base class for something that requests loading of specific tiles from a 3D Tiles Tileset. More...

struct	TileLoadResult
	Store the result of loading a tile content after invoking TilesetContentLoader::loadTileContent. More...

struct	TileLoadResultAndRenderResources

struct	TileLoadTask
	Represents the need to load a particular Cesium3DTilesSelection::Tile with a particular priority. More...

class	TileOcclusionRendererProxy
	An interface for client renderers to use to represent tile bounding volumes that should be occlusion tested. More...

class	TileOcclusionRendererProxyPool
	A pool of TileOcclusionRendererProxy objects. Allows quick remapping of tiles to occlusion renderer proxies so new proxies do not have to be created for each new tile requesting occlusion results. More...

struct	TileRasterOverlayStatus
	Captures the tile overlay status as produced by RasterOverlayCollection::updateTileOverlays. More...

class	TileRenderContent
	A content tag that indicates a tile has a glTF model content and render resources for the model. More...

struct	TileSelectionContext
	Per-frame inputs for the tile selection algorithm. More...

class	TileSelectionState
	A description of the selection state of a Tile during the Tileset::updateViewGroup process. More...

class	Tileset
	A 3D Tiles tileset, used for streaming massive heterogeneous 3D geospatial datasets. More...

class	TilesetContentLoader
	The loader interface to load the tile content. More...

class	TilesetContentLoaderFactory
	A factory to create a tileset loader. More...

struct	TilesetContentLoaderResult
	The result of creating a TilesetContentLoader, including the status, request, and any errors, as well as the root tile, credits, and the loader itself. More...

struct	TilesetContentOptions
	Options for configuring the parsing the contents of a Tileset, including construction of its glTF models. More...

class	TilesetExternals
	External interfaces used by a Tileset. More...

class	TilesetFrameState
	Captures information about the current frame during a call to Tileset::updateViewGroup. More...

class	TilesetLoadFailureDetails

class	TilesetMetadata
	Holds the metadata associated with a Tileset or an external tileset. This holds all of the fields of Cesium3DTiles::Tileset except for the root tile. More...

struct	TilesetOptions
	Additional options for configuring a Tileset. More...

class	TilesetSharedAssetSystem
	Contains assets that are potentially shared across multiple Tilesets. More...

class	TilesetViewGroup
	Represents a group of views that collectively select tiles from a particular Tileset. More...

struct	TileUnknownContent
	A content tag that indicates the TilesetContentLoader does not know if a tile's content will point to a mesh content or an external tileset. The content of the tile is only known when the loader loads the tile to inspect the content. More...

class	ViewState
	The state of the view that is used during the traversal of a tileset. More...

class	ViewUpdateResult
	Reports the results of Tileset::updateViewGroup. More...

Typedefs
typedef std::variant< CesiumGeometry::BoundingSphere, CesiumGeometry::OrientedBoundingBox, CesiumGeospatial::BoundingRegion, CesiumGeospatial::BoundingRegionWithLooseFittingHeights, CesiumGeospatial::S2CellBoundingVolume, CesiumGeometry::BoundingCylinderRegion >	BoundingVolume
	A bounding volume.

using	GeneralCullingVolume
	A general culling volume for selecting and filtering tiles.

typedef std::variant< std::string, CesiumGeometry::QuadtreeTileID, CesiumGeometry::OctreeTileID, CesiumGeometry::UpsampledQuadtreeNode >	TileID
	An identifier for a Tile inside the tile hierarchy.

using	TileContentKind
	Store the content of the tile after finishing loading tile using TilesetContentLoader::loadTileContent :

Enumerations
enum class	GltfModifierState { Idle , WorkerRunning , WorkerDone }

enum class	TileLoadState { Unloading = -2 , FailedTemporarily = -1 , Unloaded = 0 , ContentLoading = 1 , ContentLoaded = 2 , Done = 3 , Failed = 4 }

enum class	TileLoadResultState { Success , Failed , RetryLater }
	Indicate the status of Cesium3DTilesSelection::TilesetContentLoader::loadTileContent and Cesium3DTilesSelection::TilesetContentLoader::createTileChildren operations. More...

enum class	TileLoadPriorityGroup { Preload = 0 , Normal = 1 , Urgent = 2 }
	Enumerates broad categories of priority for loading a Cesium3DTilesSelection::Tile for a Cesium3DTilesSelection::TilesetViewGroup. More...

enum class	TileOcclusionState { OcclusionUnavailable , NotOccluded , Occluded }
	The occlusion state of a tile as reported by the renderer proxy. More...

enum class	TileRefine { Add = 0 , Replace = 1 }
	Refinement strategies for a Cesium3DTilesSelection::Tile. More...

enum class	TilesetLoadType { Unknown , CesiumIon , TilesetJson }
	The type of load that failed in `TilesetLoadFailureDetails`. More...

Functions
BoundingVolume	transformBoundingVolume (const glm::dmat4x4 &transform, const BoundingVolume &boundingVolume)
	Transform the given BoundingVolume with the given matrix.

glm::dvec3	getBoundingVolumeCenter (const BoundingVolume &boundingVolume)
	Returns the center of the given BoundingVolume.

std::optional< CesiumGeospatial::GlobeRectangle >	estimateGlobeRectangle (const BoundingVolume &boundingVolume, const CesiumGeospatial::Ellipsoid &ellipsoid=CesiumGeospatial::Ellipsoid::WGS84)
	Estimates the bounding CesiumGeospatial::GlobeRectangle of the given BoundingVolume.

const CesiumGeospatial::BoundingRegion *	getBoundingRegionFromBoundingVolume (const BoundingVolume &boundingVolume)
	Returns the bounding region if the bounding volume is a CesiumGeospatial::BoundingRegion or a CesiumGeospatial::BoundingRegionWithLooseFittingHeights.

CesiumGeometry::OrientedBoundingBox	getOrientedBoundingBoxFromBoundingVolume (const BoundingVolume &boundingVolume, const CesiumGeospatial::Ellipsoid &ellipsoid=CesiumGeospatial::Ellipsoid::WGS84)
	Returns an oriented bounding box that contains the given BoundingVolume.

bool	testIntersection (const BoundingVolume &volume0, const BoundingVolume &volume1)
	Returns true if two bounding volumes intersect.

bool	isBoundingVolumeVisible (const GeneralCullingVolume &cullingVolume, const BoundingVolume &boundingVolume)
	Test if a general culling volume intersects a bounding volume.

Detailed Description

Classes that implement the 3D Tiles standard.

--- comment: This file was generated by dep-graph-gen. DO NOT EDIT THIS FILE! title: Cesium3DTilesSelection Dependency Graph --- graph TD classDef dependencyNode fill:#fff,stroke:#ccc,color:#666,font-weight:bold,font-size:28px classDef libraryNode fill:#9f9,font-weight:bold,font-size:28px Cesium3DTilesSelection[Cesium3DTilesSelection] --> Cesium3DTiles[Cesium3DTiles] Cesium3DTilesSelection[Cesium3DTilesSelection] --> Cesium3DTilesContent[Cesium3DTilesContent] Cesium3DTilesSelection[Cesium3DTilesSelection] --> Cesium3DTilesReader[Cesium3DTilesReader] Cesium3DTilesSelection[Cesium3DTilesSelection] --> CesiumAsync[CesiumAsync] Cesium3DTilesSelection[Cesium3DTilesSelection] --> CesiumGeometry[CesiumGeometry] Cesium3DTilesSelection[Cesium3DTilesSelection] --> CesiumGeospatial[CesiumGeospatial] Cesium3DTilesSelection[Cesium3DTilesSelection] --> CesiumGltf[CesiumGltf] Cesium3DTilesSelection[Cesium3DTilesSelection] --> CesiumGltfReader[CesiumGltfReader] Cesium3DTilesSelection[Cesium3DTilesSelection] --> CesiumImage[CesiumImage] Cesium3DTilesSelection[Cesium3DTilesSelection] --> CesiumQuantizedMeshTerrain[CesiumQuantizedMeshTerrain] Cesium3DTilesSelection[Cesium3DTilesSelection] --> CesiumRasterOverlays[CesiumRasterOverlays] Cesium3DTilesSelection[Cesium3DTilesSelection] --> CesiumUtility[CesiumUtility] Cesium3DTilesSelection[Cesium3DTilesSelection] --> CesiumVectorData[CesiumVectorData] Cesium3DTilesSelection[Cesium3DTilesSelection] --> draco_draco{{draco::draco}} Cesium3DTilesSelection[Cesium3DTilesSelection] --> libmorton_libmorton{{libmorton::libmorton}} Cesium3DTilesSelection[Cesium3DTilesSelection] --> nonstd_expected-lite{{nonstd::expected-lite}} Cesium3DTilesSelection[Cesium3DTilesSelection] --> spdlog_spdlog{{spdlog::spdlog}} Cesium3DTilesSelection[Cesium3DTilesSelection] --> tinyxml2_tinyxml2{{tinyxml2::tinyxml2}} class draco_draco,libmorton_libmorton,nonstd_expected-lite,spdlog_spdlog,tinyxml2_tinyxml2 dependencyNode class Cesium3DTiles,Cesium3DTilesContent,Cesium3DTilesReader,CesiumAsync,CesiumGeometry,CesiumGeospatial,CesiumGltf,CesiumGltfReader,CesiumImage,CesiumQuantizedMeshTerrain,CesiumRasterOverlays,CesiumUtility,CesiumVectorData,Cesium3DTilesSelection libraryNode

Typedef Documentation

◆ BoundingVolume

typedef std::variant< CesiumGeometry::BoundingSphere, CesiumGeometry::OrientedBoundingBox, CesiumGeospatial::BoundingRegion, CesiumGeospatial::BoundingRegionWithLooseFittingHeights, CesiumGeospatial::S2CellBoundingVolume, CesiumGeometry::BoundingCylinderRegion> Cesium3DTilesSelection::BoundingVolume

A bounding volume.

This is a std::variant for different types of bounding volumes.

See also: CesiumGeometry::BoundingSphere; CesiumGeometry::OrientedBoundingBox; CesiumGeospatial::BoundingRegion; CesiumGeospatial::BoundingRegionWithLooseFittingHeights; CesiumGeospatial::S2CellBoundingVolume; CesiumGeometry::BoundingCylinderRegion

Definition at line 37 of file BoundingVolume.h.

◆ GeneralCullingVolume

using Cesium3DTilesSelection::GeneralCullingVolume

Initial value:

std::variant<CesiumGeometry::CullingVolume, BoundingVolume>

A general culling volume for selecting and filtering tiles.

While CesiumGeometry::CullingVolume represents orthographic and perspective view frustums, GeneralCullingVolume also includes Cesium3DTilesSelection::BoundingVolume, which allows more general filtering (e.g., on geographic areas).

Definition at line 19 of file GeneralCullingVolume.h.

◆ TileContentKind

using Cesium3DTilesSelection::TileContentKind

Initial value:

 std::variant<
    TileUnknownContent,
    TileEmptyContent,
    TileExternalContent,
    CesiumGltf::Model>

Store the content of the tile after finishing loading tile using TilesetContentLoader::loadTileContent :

Returning TileUnknownContent means that the loader doesn't know the content of the tile. This content type is useful when loader fails to load the tile content; or a background task is running to determine the tile content and the loader wants the client to retry later at some point in the future
Returning TileEmptyContent means that this tile has no content and mostly used for efficient culling during the traversal process
Returning TileExternalContent means that this tile points to an external tileset
Returning CesiumGltf::Model means that this tile has glTF model

Definition at line 38 of file TileLoadResult.h.

◆ TileID

typedef std::variant< std::string, CesiumGeometry::QuadtreeTileID, CesiumGeometry::OctreeTileID, CesiumGeometry::UpsampledQuadtreeNode> Cesium3DTilesSelection::TileID

An identifier for a Tile inside the tile hierarchy.

This ID is stored in the tile as the Tile::getTileID. It is assigned to the tile at construction time, and may be used to identify and access the children of a given tile.

Depending on the exact type of the tile and its contents, this identifier may have different forms:

A std::string: This is an explicitly-described tile and the ID is the URL of the tile's content.
A CesiumGeometry::QuadtreeTileID : This is an implicit tile in the quadtree. The URL of the tile's content is formed by instantiating the context's template URL with this ID.
A CesiumGeometry::OctreeTileID : This is an implicit tile in the octree. The URL of the tile's content is formed by instantiating the context's template URL with this ID.
A CesiumGeometry::UpsampledQuadtreeNode : This tile doesn't have any content, but content for it can be created by subdividing the parent tile's content.

Definition at line 39 of file TileID.h.

Enumeration Type Documentation

◆ GltfModifierState

enum class Cesium3DTilesSelection::GltfModifierState

strong

The state of the GltfModifier process for a given tile content's model.

Enumerator
Idle	Modifier is not currently processing this tile.
WorkerRunning	Worker-thread phase is in progress.
WorkerDone	The worker-thread phase is complete, but the main-thread phase is not done yet. When the main thread phase eventually runs, it will call TileRenderContent::replaceWithModifiedModel and then transition the GltfModifier back to the `Idle` state.

Definition at line 7 of file GltfModifierState.h.

◆ TileLoadPriorityGroup

enum class Cesium3DTilesSelection::TileLoadPriorityGroup

strong

Enumerates broad categories of priority for loading a Cesium3DTilesSelection::Tile for a Cesium3DTilesSelection::TilesetViewGroup.

Enumerator
Preload	Low priority tiles that aren't needed right now, but are being preloaded for the future.
Normal	Medium priority tiles that are needed to render the current view at the appropriate level-of-detail.
Urgent	High priority tiles whose absence is causing extra detail to be rendered in the scene, potentially creating a performance problem and aliasing artifacts.

Definition at line 12 of file TileLoadTask.h.

◆ TileLoadResultState

enum class Cesium3DTilesSelection::TileLoadResultState

strong

Indicate the status of Cesium3DTilesSelection::TilesetContentLoader::loadTileContent and Cesium3DTilesSelection::TilesetContentLoader::createTileChildren operations.

Enumerator
Success	The operation is successful and all the fields in TileLoadResult or TileChildrenResult are applied to the tile.
Failed	The operation is failed and none of the fields in TileLoadResult or TileChildrenResult are applied to the tile.
RetryLater	The operation requires the client to retry later due to some background work happenning and none of the fields in TileLoadResult or TileChildrenResult are applied to the tile.

Definition at line 50 of file TileLoadResult.h.

◆ TileLoadState

enum class Cesium3DTilesSelection::TileLoadState

strong

The current state of this tile in the loading process.

Enumerator
Unloading	This tile is in the process of being unloaded, but could not be fully unloaded because an asynchronous process is using its loaded data.
FailedTemporarily	Something went wrong while loading this tile, but it may be a temporary problem.
Unloaded	The tile is not yet loaded at all, beyond the metadata in tileset.json.
ContentLoading	The tile content is currently being loaded. Note that while a tile is in this state, its Tile::getContent, and Tile::getState, methods may be called from the load thread, and the state may change due to the internal loading process.
ContentLoaded	The tile content has finished loading.
Done	The tile is completely done loading.
Failed	Something went wrong while loading this tile and it will not be retried.

Definition at line 55 of file Tile.h.

◆ TileOcclusionState

enum class Cesium3DTilesSelection::TileOcclusionState

strong

The occlusion state of a tile as reported by the renderer proxy.

Enumerator

OcclusionUnavailable

The renderer does not yet know if the tile's bounding volume is occluded or not.

This can be due to the typical occlusion delay caused by buffered rendering or otherwise be due to postponed occlusion queries. We can choose to wait for the occlusion information to become available before commiting to load the tile. This might prevent unneeded tile loads at the cost of a small delay.

NotOccluded

The tile's bounding volume is known by the renderer to be visible.

Occluded

The tile's bounding volume is known by the renderer to be occluded.

Definition at line 15 of file TileOcclusionRendererProxy.h.

◆ TileRefine

enum class Cesium3DTilesSelection::TileRefine

strong

Refinement strategies for a Cesium3DTilesSelection::Tile.

Enumerator
Add	The content of the child tiles will be added to the content of the parent tile.
Replace	The content of the child tiles will replace the content of the parent tile.

Definition at line 8 of file TileRefine.h.

◆ TilesetLoadType

enum class Cesium3DTilesSelection::TilesetLoadType

strong

The type of load that failed in TilesetLoadFailureDetails.

Enumerator
Unknown	An unknown load error.
CesiumIon	A Cesium ion asset endpoint.
TilesetJson	The root tileset.json.

Definition at line 17 of file TilesetLoadFailureDetails.h.

Function Documentation

◆ estimateGlobeRectangle()

std::optional< CesiumGeospatial::GlobeRectangle > Cesium3DTilesSelection::estimateGlobeRectangle	(	const BoundingVolume &	boundingVolume,
		const CesiumGeospatial::Ellipsoid &	ellipsoid = CesiumGeospatial::Ellipsoid::WGS84 )

Estimates the bounding CesiumGeospatial::GlobeRectangle of the given BoundingVolume.

Parameters

boundingVolume	The bounding volume.
ellipsoid	The ellipsoid to use for globe calculations.

Returns: The bounding CesiumGeospatial::GlobeRectangle.

◆ getBoundingRegionFromBoundingVolume()

const CesiumGeospatial::BoundingRegion * Cesium3DTilesSelection::getBoundingRegionFromBoundingVolume ( const BoundingVolume & boundingVolume )

Returns the bounding region if the bounding volume is a CesiumGeospatial::BoundingRegion or a CesiumGeospatial::BoundingRegionWithLooseFittingHeights.

Parameters

boundingVolume The bounding volume.

Returns: A pointer to the bounding region, or nullptr is the bounding volume is not a bounding region.

◆ getBoundingVolumeCenter()

glm::dvec3 Cesium3DTilesSelection::getBoundingVolumeCenter ( const BoundingVolume & boundingVolume )

Returns the center of the given BoundingVolume.

Parameters

boundingVolume The bounding volume.

Returns: The center point.

◆ getOrientedBoundingBoxFromBoundingVolume()

CesiumGeometry::OrientedBoundingBox Cesium3DTilesSelection::getOrientedBoundingBoxFromBoundingVolume	(	const BoundingVolume &	boundingVolume,
		const CesiumGeospatial::Ellipsoid &	ellipsoid = CesiumGeospatial::Ellipsoid::WGS84 )

Returns an oriented bounding box that contains the given BoundingVolume.

Parameters

boundingVolume	The bounding volume.
ellipsoid	The ellipsoid used for this BoundingVolume.

Returns: The oriented bounding box.

◆ isBoundingVolumeVisible()

bool Cesium3DTilesSelection::isBoundingVolumeVisible	(	const GeneralCullingVolume &	cullingVolume,
		const BoundingVolume &	boundingVolume )

Test if a general culling volume intersects a bounding volume.

Parameters

cullingVolume	The general culling volume.
boundingVolume	The bounding volume.

Returns: true if volumes intersect.

◆ transformBoundingVolume()

BoundingVolume Cesium3DTilesSelection::transformBoundingVolume	(	const glm::dmat4x4 &	transform,
		const BoundingVolume &	boundingVolume )

Transform the given BoundingVolume with the given matrix.

If the given bounding volume is a CesiumGeometry::BoundingSphere or CesiumGeometry::OrientedBoundingBox, then it will be transformed with the given matrix. Bounding regions will not be transformed.

Parameters

transform	The transform matrix.
boundingVolume	The bounding volume.

Returns: The transformed bounding volume.

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ BoundingVolume

◆ GeneralCullingVolume

◆ TileContentKind

◆ TileID

Enumeration Type Documentation

◆ GltfModifierState

◆ TileLoadPriorityGroup

◆ TileLoadResultState

◆ TileLoadState

◆ TileOcclusionState

◆ TileRefine

◆ TilesetLoadType

Function Documentation

◆ estimateGlobeRectangle()

◆ getBoundingRegionFromBoundingVolume()

◆ getBoundingVolumeCenter()

◆ getOrientedBoundingBoxFromBoundingVolume()

◆ isBoundingVolumeVisible()

◆ transformBoundingVolume()