GraphQL Schema definition
Require by
- AnnotationCommon interface for annotations or virtual overlays added to the model.
- AssetA binary asset associated with the model.
- BundleProcessingInformationCurrent information about the processing of a bundle purchase.
- ClipA video clip
- CommentMarkdown text and/or attachments made on an annotation.
- CommonAssetA binary asset associated with the model.
- FloorplanA floorplan, often formatted as an image, although other
options may be available.
- Folderundefined
- HighlightReelAn ordered list of assets, typically pictures, highlighting features of the model.
- InferenceEvent@beta This field is part of a limited access beta.
- LabelA label of a room in the model.
- MattertagA point in the model with other information
such as clips, photos and text associated with it.
- MeasurementA measurement between two points within the model.
- MeasurementPathA representation of measurement path made up of a sequence of points within the model. This structure is intended to
replace measurements.
- MeshA 3D geometry of the model.
- ModelA digital twin, metadata and access to assets associated with a 3D model of a space.
- ModelLayerA layer within a model, this contains a slice of model data
about the model or mask out information from lower layers.
One layer is below another if the `position` is smaller. A position
of 0 is always the bottom layer.
- ModelProcessingDetailsProgress information about model processing.
- ModelSearchResultThis is a flattened representation of the model which removes or merges all lists of complex
objects so that the fields may be directly queried.
Any field on this object may be included as a keyword in the models query.
For example "name: Demo" would search for models with the word Demo in the name. A search for
"mattertags.labels: kitchen" would search for any models that have at least one mattertag with
the word kitchen in the label.
- ModelSummaryA base interface of common fields found on the model returned from a full get or from the search results.
- ModelViewAn alternative view of the same model.
- NoteA point in the model for users to comment and attach other media.
- ObjectAnnotation@beta This field is part of a limited access beta.
- PhotoA photo associated with the model as well
as some basic metadata including label and
dimensions.
- PhotoSummaryBasic url access to a photo and the
ability to retrieve it at multiple resolutions.
- PrivateModelLinkundefined
- Resourceundefined
- SkyboxPanoramaA panoramic image broken into 6 faces:
front, back, left, right, up, down
The full face images may be retrieved using `urlTemplate` or `children`.
Each face may also be retrieved as a set of tiles to improve progressive loading
of high resolution images. In these cases the tileUrlTemplate should be used.
- TextureAn image which may be mapped onto a 3D geometry.