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

#include <Cesium3DTilesSelection/TileContent.h>

Public Member Functions
	TileRenderContent (CesiumGltf::Model &&model)
	Construct the content with a glTF model.

const CesiumGltf::Model &	getModel () const noexcept
	Retrieve a glTF model that is owned by this content.

CesiumGltf::Model &	getModel () noexcept
	Retrieve a glTF model that is owned by this content.

void	setModel (const CesiumGltf::Model &model)
	Set the glTF model for this content.

void	setModel (CesiumGltf::Model &&model)
	Set the glTF model for this content.

const CesiumRasterOverlays::RasterOverlayDetails &	getRasterOverlayDetails () const noexcept
	Get the `CesiumRasterOverlays::RasterOverlayDetails` which is the result of generating raster overlay UVs for the glTF model.

CesiumRasterOverlays::RasterOverlayDetails &	getRasterOverlayDetails () noexcept
	Get the `CesiumRasterOverlays::RasterOverlayDetails` which is the result of generating raster overlay UVs for the glTF model.

void	setRasterOverlayDetails (const CesiumRasterOverlays::RasterOverlayDetails &rasterOverlayDetails)
	Set the `CesiumRasterOverlays::RasterOverlayDetails` which is the result of generating raster overlay UVs for the glTF model.

void	setRasterOverlayDetails (CesiumRasterOverlays::RasterOverlayDetails &&rasterOverlayDetails)
	Set the `CesiumRasterOverlays::RasterOverlayDetails` which is the result of generating raster overlay UVs for the glTF model.

const std::vector< CesiumUtility::Credit > &	getCredits () const noexcept
	Get the list of Credit of the content.

std::vector< CesiumUtility::Credit > &	getCredits () noexcept
	Get the list of Credit of the content.

void	setCredits (std::vector< CesiumUtility::Credit > &&credits)
	Set the list of Credit for the content.

void	setCredits (const std::vector< CesiumUtility::Credit > &credits)
	Set the list of Credit for the content.

void *	getRenderResources () const noexcept
	Get the renderer resources created for the glTF model of the content.

void	setRenderResources (void *pRenderResources) noexcept
	Set the renderer resources created for the glTF model of the content.

float	getLodTransitionFadePercentage () const noexcept
	Get the fade percentage that this tile during an LOD transition.

void	setLodTransitionFadePercentage (float percentage) noexcept
	Set the fade percentage of this tile during an LOD transition with. Not to be used by clients.

GltfModifierState	getGltfModifierState () const noexcept
	Gets the state of the `GltfModifier` processing of this tile's content.

void	setGltfModifierState (GltfModifierState modifierState) noexcept
	Sets the state of the `GltfModifier` processing of this tile's content.

const std::optional< CesiumGltf::Model > &	getModifiedModel () const noexcept
	Gets the modified model produced by the `GltfModifier` that is not yet available for rendering.

void *	getModifiedRenderResources () const noexcept
	Gets the renderer resources for the modified model produced by the `GltfModifier` that is not yet available for rendering. These resources are created by `IPrepareRendererResources::prepareInLoadThread`.

void	setModifiedModelAndRenderResources (CesiumGltf::Model &&modifiedModel, void *pModifiedRenderResources) noexcept
	Stores the modified model and associated renderer resources produced by the `GltfModifier` that are not yet available for rendering. The renderer resources are created by `IPrepareRendererResources::prepareInLoadThread`.

void	resetModifiedModelAndRenderResources () noexcept
	Resets the modified model and renderer resources after they have been determined to be outdated and have been freed with `IPrepareRendererResources::free`.

void	replaceWithModifiedModel () noexcept
	Overwrites this instance's model and renderer resources with the modified ones produced by `GltfModifier`. The new model and resources become eligible for rendering.

Detailed Description

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

Definition at line 65 of file TileContent.h.

Constructor & Destructor Documentation

◆ TileRenderContent()

Cesium3DTilesSelection::TileRenderContent::TileRenderContent ( CesiumGltf::Model && model )

Construct the content with a glTF model.

Parameters

model A glTF model that will be owned by this content

Member Function Documentation

◆ getCredits() [1/2]

const std::vector< CesiumUtility::Credit > & Cesium3DTilesSelection::TileRenderContent::getCredits ( ) const

noexcept

Get the list of Credit of the content.

Returns: The list of Credit of the content

◆ getCredits() [2/2]

std::vector< CesiumUtility::Credit > & Cesium3DTilesSelection::TileRenderContent::getCredits ( )

noexcept

Get the list of Credit of the content.

Returns: The list of Credit of the content

◆ getLodTransitionFadePercentage()

float Cesium3DTilesSelection::TileRenderContent::getLodTransitionFadePercentage ( ) const

noexcept

Get the fade percentage that this tile during an LOD transition.

This will be used when TilesetOptions::enableLodTransitionPeriod is true. Tile fades can be used to make LOD transitions appear less abrupt and jarring. It is up to client implementations how to render the fade percentage, but dithered fading is recommended.

Returns: The fade percentage.

◆ getModel() [1/2]

const CesiumGltf::Model & Cesium3DTilesSelection::TileRenderContent::getModel ( ) const

noexcept

Retrieve a glTF model that is owned by this content.

Returns: A glTF model that is owned by this content

◆ getModel() [2/2]

CesiumGltf::Model & Cesium3DTilesSelection::TileRenderContent::getModel ( )

noexcept

Retrieve a glTF model that is owned by this content.

Returns: A glTF model that is owned by this content

◆ getRasterOverlayDetails() [1/2]

const CesiumRasterOverlays::RasterOverlayDetails & Cesium3DTilesSelection::TileRenderContent::getRasterOverlayDetails ( ) const

noexcept

Get the CesiumRasterOverlays::RasterOverlayDetails which is the result of generating raster overlay UVs for the glTF model.

Returns: The CesiumRasterOverlays::RasterOverlayDetails that is owned by this content

◆ getRasterOverlayDetails() [2/2]

CesiumRasterOverlays::RasterOverlayDetails & Cesium3DTilesSelection::TileRenderContent::getRasterOverlayDetails ( )

noexcept

Get the CesiumRasterOverlays::RasterOverlayDetails which is the result of generating raster overlay UVs for the glTF model.

Returns: The CesiumRasterOverlays::RasterOverlayDetails that is owned by this content

◆ getRenderResources()

void * Cesium3DTilesSelection::TileRenderContent::getRenderResources ( ) const

noexcept

Get the renderer resources created for the glTF model of the content.

Returns: The renderer resources that are created for the glTF model

◆ replaceWithModifiedModel()

void Cesium3DTilesSelection::TileRenderContent::replaceWithModifiedModel ( )

noexcept

Overwrites this instance's model and renderer resources with the modified ones produced by GltfModifier. The new model and resources become eligible for rendering.

After this method returns, getModifiedModel will return std::nullopt and getModifiedRenderResources will return nullptr.

◆ setCredits() [1/2]

void Cesium3DTilesSelection::TileRenderContent::setCredits ( const std::vector< CesiumUtility::Credit > & credits )

Set the list of Credit for the content.

Parameters

credits The list of Credit to be owned by the content

◆ setCredits() [2/2]

void Cesium3DTilesSelection::TileRenderContent::setCredits ( std::vector< CesiumUtility::Credit > && credits )

Set the list of Credit for the content.

Parameters

credits The list of Credit to be owned by the content

◆ setLodTransitionFadePercentage()

void Cesium3DTilesSelection::TileRenderContent::setLodTransitionFadePercentage ( float percentage )

noexcept

Set the fade percentage of this tile during an LOD transition with. Not to be used by clients.

Parameters

percentage The new fade percentage.

◆ setModel() [1/2]

void Cesium3DTilesSelection::TileRenderContent::setModel ( CesiumGltf::Model && model )

Set the glTF model for this content.

Parameters

model A glTF model that will be owned by this content

◆ setModel() [2/2]

void Cesium3DTilesSelection::TileRenderContent::setModel ( const CesiumGltf::Model & model )

Set the glTF model for this content.

Parameters

model A glTF model that will be owned by this content

◆ setRasterOverlayDetails() [1/2]

void Cesium3DTilesSelection::TileRenderContent::setRasterOverlayDetails ( CesiumRasterOverlays::RasterOverlayDetails && rasterOverlayDetails )

Set the CesiumRasterOverlays::RasterOverlayDetails which is the result of generating raster overlay UVs for the glTF model.

Parameters

rasterOverlayDetails The CesiumRasterOverlays::RasterOverlayDetails that will be owned by this content

◆ setRasterOverlayDetails() [2/2]

void Cesium3DTilesSelection::TileRenderContent::setRasterOverlayDetails ( const CesiumRasterOverlays::RasterOverlayDetails & rasterOverlayDetails )

Set the CesiumRasterOverlays::RasterOverlayDetails which is the result of generating raster overlay UVs for the glTF model.

Parameters

rasterOverlayDetails The CesiumRasterOverlays::RasterOverlayDetails that will be owned by this content

◆ setRenderResources()

void Cesium3DTilesSelection::TileRenderContent::setRenderResources ( void * pRenderResources )

noexcept

Set the renderer resources created for the glTF model of the content.

Parameters

pRenderResources The renderer resources that are created for the glTF model.

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TileRenderContent()

Member Function Documentation

◆ getCredits() [1/2]

◆ getCredits() [2/2]

◆ getLodTransitionFadePercentage()

◆ getModel() [1/2]

◆ getModel() [2/2]

◆ getRasterOverlayDetails() [1/2]

◆ getRasterOverlayDetails() [2/2]

◆ getRenderResources()

◆ replaceWithModifiedModel()

◆ setCredits() [1/2]

◆ setCredits() [2/2]

◆ setLodTransitionFadePercentage()

◆ setModel() [1/2]

◆ setModel() [2/2]

◆ setRasterOverlayDetails() [1/2]

◆ setRasterOverlayDetails() [2/2]

◆ setRenderResources()