cesium-native 0.46.0
Loading...
Searching...
No Matches
CesiumITwinClient Namespace Reference

Classes for interacting with the iTwin API. More...

Classes

class  AuthenticationToken
 An authentication token obtained from the iTwin OAuth2 flow. More...
 
struct  CesiumCuratedContentAsset
 A single asset obtained from the iTwin Cesium Curated Content API. More...
 
class  Connection
 Represents a connection to the Bentley iTwin API. More...
 
struct  IModel
 An iModel. More...
 
struct  IModelMeshExport
 An iModel mesh export. More...
 
struct  ITwin
 Information on a single iTwin. More...
 
struct  ITwinRealityData
 Information on reality data. More...
 
class  PagedList
 Allows access to a set of resources from a paginated list. More...
 
struct  QueryParameters
 A common set of query parameters used across list operations in the Bentley API. More...
 
struct  UserProfile
 Information on a user. More...
 

Enumerations

enum class  CesiumCuratedContentType : uint8_t {
  Unknown = 0 , Cesium3DTiles = 1 , Gltf = 2 , Imagery = 3 ,
  Terrain = 4 , Kml = 5 , Czml = 6 , GeoJson = 7
}
 The type of content obtained from the iTwin Cesium Curated Content API. More...
 
enum class  CesiumCuratedContentStatus : uint8_t {
  Unknown = 0 , AwaitingFiles = 1 , NotStarted = 2 , InProgress = 3 ,
  Complete = 4 , Error = 5 , DataError = 6
}
 Describes the state of the content during the upload and tiling processes. More...
 
enum class  IModelState : uint8_t { Unknown = 0 , Initialized = 1 , NotInitialized = 2 }
 The possible states for an iModel. More...
 
enum class  IModelMeshExportStatus : uint8_t {
  Unknown = 0 , NotStarted = 1 , InProgress = 2 , Complete = 3 ,
  Invalid = 4
}
 The status of an iModel Mesh Export. More...
 
enum class  IModelMeshExportType : uint8_t {
  Unknown = 0 , ITwin3DFT = 1 , IModel = 2 , Cesium = 3 ,
  Cesium3DTiles = 4
}
 The type of mesh exported. More...
 
enum class  ITwinStatus : uint8_t { Unknown = 0 , Active = 1 , Inactive = 2 , Trial = 3 }
 The status of the iTwin. More...
 
enum class  ITwinRealityDataClassification : uint8_t {
  Unknown = 0 , Terrain = 1 , Imagery = 2 , Pinned = 3 ,
  Model = 4 , Undefined = 5
}
 Indicates the nature of the reality data. More...
 

Functions

CesiumCuratedContentType cesiumCuratedContentTypeFromString (const std::string &str)
 Obtains a CesiumCuratedContentType value from the provided string.
 
CesiumCuratedContentStatus cesiumCuratedContentStatusFromString (const std::string &str)
 Obtains a CesiumCuratedContentStatus value from the provided string.
 
IModelState iModelStateFromString (const std::string &str)
 Obtains an IModelState value from the provided string.
 
IModelMeshExportStatus iModelMeshExportStatusFromString (const std::string &str)
 Obtains an IModelMeshExportStatus value from the provided string.
 
IModelMeshExportType iModelMeshExportTypeFromString (const std::string &str)
 Obtains an IModelMeshExportType value from the provided string.
 
ITwinStatus iTwinStatusFromString (const std::string &str)
 Obtains an ITwinStatus value from the provided string.
 
ITwinRealityDataClassification iTwinRealityDataClassificationFromString (const std::string &str)
 Obtains an ITwinRealityDataClassification value from the provided string.
 

Detailed Description

Classes for interacting with the iTwin API.

--- comment: This file was generated by dep-graph-gen. DO NOT EDIT THIS FILE! title: CesiumITwinClient 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 CesiumITwinClient[CesiumITwinClient] --> CesiumAsync[CesiumAsync] CesiumITwinClient[CesiumITwinClient] --> CesiumClientCommon[CesiumClientCommon] CesiumITwinClient[CesiumITwinClient] --> CesiumGeospatial[CesiumGeospatial] CesiumITwinClient[CesiumITwinClient] --> CesiumUtility[CesiumUtility] CesiumITwinClient[CesiumITwinClient] --> modp_b64_modp_b64{{modp_b64::modp_b64}} class modp_b64_modp_b64 dependencyNode class CesiumAsync,CesiumClientCommon,CesiumGeospatial,CesiumUtility,CesiumITwinClient libraryNode

Enumeration Type Documentation

◆ CesiumCuratedContentStatus

enum class CesiumITwinClient::CesiumCuratedContentStatus : uint8_t
strong

Describes the state of the content during the upload and tiling processes.

See https://developer.bentley.com/apis/cesium-curated-content/operations/list-content/#contentstatus for more information.

Definition at line 62 of file CesiumCuratedContent.h.

◆ CesiumCuratedContentType

enum class CesiumITwinClient::CesiumCuratedContentType : uint8_t
strong

The type of content obtained from the iTwin Cesium Curated Content API.

See https://developer.bentley.com/apis/cesium-curated-content/operations/list-content/#contenttype for more information.

Enumerator
Unknown 

The content type returned is not a known type.

Cesium3DTiles 

The content is a 3D Tiles tileset.

Gltf 

The content is a glTF model.

Imagery 

The content is imagery that can be loaded with CesiumRasterOverlays::ITwinCesiumCuratedContentRasterOverlay.

Terrain 

The content is quantized mesh terrain.

Kml 

The content is in the Keyhole Markup Language (KML) format.

Czml 

The content is in the Cesium Language (CZML) format.

See https://github.com/AnalyticalGraphicsInc/czml-writer/wiki/CZML-Guide for more information.

GeoJson 

The content is in the GeoJSON format.

Definition at line 16 of file CesiumCuratedContent.h.

◆ IModelMeshExportStatus

enum class CesiumITwinClient::IModelMeshExportStatus : uint8_t
strong

The status of an iModel Mesh Export.

See https://developer.bentley.com/apis/mesh-export/operations/get-export/#exportstatus for more information.

Definition at line 14 of file IModelMeshExport.h.

◆ IModelMeshExportType

enum class CesiumITwinClient::IModelMeshExportType : uint8_t
strong

The type of mesh exported.

See https://developer.bentley.com/apis/mesh-export/operations/get-export/#startexport-exporttype for more information.

Enumerator
ITwin3DFT 

iTwin "3D Fast Transmission" (3DFT) format.

Definition at line 38 of file IModelMeshExport.h.

◆ IModelState

enum class CesiumITwinClient::IModelState : uint8_t
strong

The possible states for an iModel.

See https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-details/#imodel-state for more information.

Definition at line 16 of file IModel.h.

◆ ITwinRealityDataClassification

Indicates the nature of the reality data.

See https://developer.bentley.com/apis/reality-management/rm-rd-details/#classification for more information.

Definition at line 16 of file ITwinRealityData.h.

◆ ITwinStatus

enum class CesiumITwinClient::ITwinStatus : uint8_t
strong

The status of the iTwin.

See https://developer.bentley.com/apis/itwins/operations/get-my-itwins/#itwinstatus for more information.

Definition at line 14 of file ITwin.h.

Function Documentation

◆ cesiumCuratedContentStatusFromString()

CesiumCuratedContentStatus CesiumITwinClient::cesiumCuratedContentStatusFromString ( const std::string & str)

Obtains a CesiumCuratedContentStatus value from the provided string.

See https://developer.bentley.com/apis/cesium-curated-content/operations/list-content/#contentstatus for the list of possible values.

◆ cesiumCuratedContentTypeFromString()

CesiumCuratedContentType CesiumITwinClient::cesiumCuratedContentTypeFromString ( const std::string & str)

Obtains a CesiumCuratedContentType value from the provided string.

See https://developer.bentley.com/apis/cesium-curated-content/operations/list-content/#contenttype for the list of possible values.

◆ iModelMeshExportStatusFromString()

IModelMeshExportStatus CesiumITwinClient::iModelMeshExportStatusFromString ( const std::string & str)

Obtains an IModelMeshExportStatus value from the provided string.

See https://developer.bentley.com/apis/mesh-export/operations/get-export/#exportstatus for a list of possible values.

◆ iModelMeshExportTypeFromString()

IModelMeshExportType CesiumITwinClient::iModelMeshExportTypeFromString ( const std::string & str)

Obtains an IModelMeshExportType value from the provided string.

See https://developer.bentley.com/apis/mesh-export/operations/get-export/#startexport-exporttype for a list of possible values.

◆ iModelStateFromString()

IModelState CesiumITwinClient::iModelStateFromString ( const std::string & str)

Obtains an IModelState value from the provided string.

See https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-details/#imodel-state for a list of possible values.

◆ iTwinRealityDataClassificationFromString()

ITwinRealityDataClassification CesiumITwinClient::iTwinRealityDataClassificationFromString ( const std::string & str)

Obtains an ITwinRealityDataClassification value from the provided string.

See https://developer.bentley.com/apis/reality-management/rm-rd-details/#classification for a list of possible values.

◆ iTwinStatusFromString()

ITwinStatus CesiumITwinClient::iTwinStatusFromString ( const std::string & str)

Obtains an ITwinStatus value from the provided string.

See https://developer.bentley.com/apis/itwins/operations/get-my-itwins/#itwinstatus for a list of possible values.