Cognite Docs

[Janne Desir]

Revealis a JavaScript library for visualizing big 3D models on the web.It supports complex CAD models and large point clouds.The library supports 3D model hosted by Cognite Data Fusion (CDF) which supports ingestion of a variety of 3D formats. If you do not have access you can use models provided through the Open Industrial Data project for testing.

If you have previously used the previous version of Reveal,@cognite/3d-viewer,and want to migrate to this package, please see the Migration guide.For details about the installation procedure and how to use Reveal in certain environments,see the Installation guide.

CAD (Computer-Aided Design) models are technical design 3D models. For the big asset industry these are typically very complex and can often consist of several million individual objects. To enable interactive visualization of such models Cognite Data Fusion (CDF) processes these models to optimize the geometry and the structure, enabling Reveal to visualize them on the web.

CAD models typically contain attributes/properties associated with each 3D object (also called node). These attributes can provide valuable metadata, such as extent, function, what system the object is part of and it's operation specifications. CDF and Reveal provide functionality for queries based on the attributes to perform filtering, styling and to collect information.

Point cloud models are 3D models generated from techniques such as 3D scanning or photogrammetry. Cognite Data Fusion (CDF) processes point clouds and stores them in a format suitable for visualization.

The models provided by CDF are stored in "CDF space", a coordinate system where the positive Z axis is the up direction. However, objects visualized in Reveal uses ThreeJS's coordinate system, which has the positive Y axis pointing upward. The transformation between these two coordinate systems is handled automatically behind the scenes for all CDF models. This difference can still introduce errors when combining models in Reveal with other data from CDF. To transform objects between the two coordinate systems, the @cognite/reveal package exports the transformation in the variable CDF_TO_VIEWER_TRANSFORMATION.

A file-system interface (cdffs) that allow users to work with CDF (Cognite Data Fusion) Files using fsspecsupported/compatible python packages (pandas, xarray etc). cdffs uses cognite-sdk-python to work with CDF Files.

REST API docs are now versioned. When you open an API reference page, a version selector appears above the table of contents. Make sure the API reference is from the Reference > Data Plane folder.

Key-based authentication relies on API keys that are generated for the search service. Having a valid key establishes trust, on a per request basis, between the application sending the request and the service that handles it. You can use an Admin API key for read-write operations or a Query API key for read access to the documents collection of a search index.

Microsoft Entra ID authentication and role-based access control requires that you have an established tenant in Microsoft Entra ID, with security principals and role assignments. Members of the following roles have data plane access. You can create custom roles if the built-in roles are insufficient.

You can disable key-based authentication or role-based authentication. If you disable role-based authentication, it only applies to data plane operations. Control plane operations, such as service administration, always use role-based authentication. See Microsoft Entra ID authentication and role-based access control for Azure AI Search for details.

The APIs documented in this section provide access to operations on search data, such as index creation and population, document upload, and queries. When calling APIs, keep the following points in mind:

Request URIs must include the api-version. The value must be set to a supported version, formatted as shown in this example: GET [search service name].search.windows.net/indexes?api-version=2023-11-01

Request headers must include either an api-key or a bearer token for authenticated connections. Optionally, you can set the Accept HTTP header. If the content type header isn't set, the default is assumed to be application/json.

3a8082e126