Inheritance diagram for Cesium3DTilesSelection::ITwinRealityDataContentLoaderFactory:

Public Types
using	TokenRefreshCallback
	Callback to obtain a new access token for the iTwin API. Receives the previous access token as parameter.

Public Types inherited from Cesium3DTilesSelection::TilesetContentLoaderFactory
using	AuthorizationHeaderChangeListener
	The type of a callback called when the Authorization header used by a tileset loader has changed.

Public Member Functions
	ITwinRealityDataContentLoaderFactory (const std::string &realityDataId, const std::optional< std::string > &iTwinId, const std::string &iTwinAccessToken, TokenRefreshCallback &&tokenRefreshCallback)
	Creates a new factory for loading iTwin reality data.

virtual CesiumAsync::Future< Cesium3DTilesSelection::TilesetContentLoaderResult< Cesium3DTilesSelection::TilesetContentLoader > >	createLoader (const TilesetExternals &externals, const TilesetOptions &tilesetOptions, const AuthorizationHeaderChangeListener &headerChangeListener) override
	Creates an instance of the loader corresponding to this factory.

virtual bool	isValid () const override
	Returns true if a valid TilesetContentLoader can be constructed from this factory.

Detailed Description

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

Member Typedef Documentation

Initial value:

 
      std::function<CesiumAsync::Future<CesiumUtility::Result<std::string>>(
          const std::string&)>

Callback to obtain a new access token for the iTwin API. Receives the previous access token as parameter.

Cesium3DTilesSelection::ITwinRealityDataContentLoaderFactory::ITwinRealityDataContentLoaderFactory	(	const std::string &	realityDataId,
		const std::optional< std::string > &	iTwinId,
		const std::string &	iTwinAccessToken,
		TokenRefreshCallback &&	tokenRefreshCallback )

Creates a new factory for loading iTwin reality data.

Parameters

realityDataId	The ID of the reality data to load.
iTwinId	The ID of the iTwin this reality data is associated with. As described in the iTwin Reality Management API documentation: The `iTwinId` parameter is optional, but it is preferable to provide it, because the permissions used to access the container are determined from the iTwin. With no iTwin specified, the operation can succeed in some cases (e.g. the user is the reality data's owner), but we recommend to provide a `iTwinId`.
iTwinAccessToken	The access token to use to access the API.
tokenRefreshCallback	Callback that will be called to obtain a new access token when the provided one has expired.

virtual CesiumAsync::Future< Cesium3DTilesSelection::TilesetContentLoaderResult< Cesium3DTilesSelection::TilesetContentLoader > > Cesium3DTilesSelection::ITwinRealityDataContentLoaderFactory::createLoader	(	const TilesetExternals &	externals,
		const TilesetOptions &	tilesetOptions,
		const AuthorizationHeaderChangeListener &	headerChangeListener )

overridevirtual

Creates an instance of the loader corresponding to this factory.

Parameters

externals	The TilesetExternals.
tilesetOptions	The TilesetOptions.
headerChangeListener	A callback that will be called when the Authorization header used by the tileset loader has changed.

virtual bool Cesium3DTilesSelection::ITwinRealityDataContentLoaderFactory::isValid ( ) const

overridevirtual

Returns true if a valid TilesetContentLoader can be constructed from this factory.

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

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