RealityData Properties

This page describes the RealityData properties in detail. Below is a list of properties, their type, along with their description. More so, some properties below have additional information about them.

RealityData must use the required properties listed below.

• displayName
• classification
• type

AccessControl

To each reality data is associated an AccessControl property which can take one of four values that indicate who can use the data, explained below.

• Public: Indicates anyone, even users external to an organization can use the data.
• Organization: Indicates any member of the organization the data belongs to can use the data.
• Project: Indicates data can only be used as part of a project.
• Private: Only the owner can use the data.

Authoring

The Authoring property value is not controlled by the RealityData API, it is left to be managed by the application. The value also does not change the behavior of the API. The purpose of this property is to show if new model data is being uploaded to the RealityData. This is particularly useful when a RealityData is shared or possibly managed by multiple users. It is up to the creator of the application to implement behavior within the application that uses the Authoring property value.

Classification and Types

Classification

While Classification defines the nature of the RealityData, it is related to the Type property.

The following values are currently supported:

• Terrain: Data is a representation of the terrain.
• Imagery: Data is vertical, satellite or orthophoto imagery.
• Pinned: Any non-geographic data that may be pinned to a location on Earth.
• Model: Most common classification. Data is a modelisation of the a real world object or feature.
• Undefined: For non-reality data used as input for reality data creation.

Types

The Type property of the Reality Data indicates the format of the data contained in a reality data. Although the Type field is a free string some specific values are reserved.

The following are the reserved keywords:

Other types are commonly used that clearly indicate the type. For example tif, jpg, pdf can be used and the intended format is clear. Most of the time the format clearly imposes the Classification. Point Clouds, Web Ready Scalable mesh 3MX are necessarily Model data since they are modelisation of the real world. On the other hand, some format can be of different classification. For example the tif format supports the storage of Terrain data when the pixel is elevation data or Imagery for satellite data. Likewise a jpg file can represent an orthophoto (Imagery) or be an oblique picture of a feature (a neighborhood, people,…) then these are to be classified as Pinned data. Similarly, a pdf document could be a written document (Pinned) or a Map (Model).

DataCenterLocation

DataCenterLocation represents a data center location. The RealityData API supports many different data location geographically located at different places. Usually, the data center location is the same as the CONNECT Project in which the reality data is created.

Data center locations used by RealityData API are :

• East US
• North Europe
• Southeast Asia
• Japan East
• UK South
• Australia East

Acquisition

The Acquisition object contains the ISO-8601 compliant start time and end time (UTC) of data acquisition, as well as the Acquirer. The Acquirer is a text indicating by whom or what instance or process has acquired the data. See example below:

"acquisition": {
          "startDateTime": "2021-05-12T20:03:12Z",
          "endDateTime": "2021-05-15T05:07:18Z",
          "acquirer": "Data Acquisition Inc."
      },

Extent

The Extent contains the rectangular area on the Earth which encloses the reality data. Defined by the most southwestern point and the most northeastern point. The latitude and longitude types are double. See example below:

"extent": {
              "southWest": {
                  "latitude": 50.1171,
                  "longitude": -122.9543
              },
              "northEast": {
                  "latitude": 50.1172,
                  "longitude": -122.9543
              }
          },

Size

After the model data is uploaded successfully to the RealityData, whether due to the creation or a modification of the RealityData, the Size property is then scheduled to be recalculated. This process can take a few minutes, so the Size value might not be accurate immediately after the upload is complete. For large model uploads, meaning a few gigabytes or more, this process can take longer.