OBJECT
PanoramicImageLocation
link GraphQL Schema definition
- type PanoramicImageLocation {
- : ID!
- : Model!
- : AnchorLocation
- # The combination of formats and resolutions
- # that the panoramic image is available in.
- : [PanoramicImageOption!]!
- # The resolutions the given format is available in.
- # Default: skybox
- #
- # @error request.invalid If the specified format is not in the available options.
- #
- # Arguments
- # format: undefined
- (: PanoramicImageFormat): [String!]
- # Describes the placement of the panorama within the model.
- : PanoramaPlacement
- # Source of the panorama.
- : PanoramaSource
- # The position of the centroid within the model for rendering the panorama.
- : Point
- # The vector describing the directionality and rotation of the camera for
- # rendering the panorama.
- : Quaternion
- # An identifier for a PanoramicImageLocation to differentiate
- # different images with the same anchor.
- # If set the variant must be unique for all the images
- # with the same parent location.
- # The first PanoramicImageLocation associated with an AnchorLocation
- # will be assigned a variant of 'default'.
- : String!
- # Gets a single image at a given resolution.
- #
- # @error request.invalid If the specified format and resolution is not in the
- # available
- # in the options.
- #
- # Arguments
- # format: undefined
- # resolution: undefined
- (: PanoramicImageFormat!, : String): PanoramicImage
- # Lists all the images associated with this location.
- #
- # Arguments
- # resolutions: If specified only return resolutions matching one
- # in this list
- (: [String!]): [PanoramicImage!]
- # Helper for image(format: skybox) that specifies the return
- # type will be a SkyboxPanoramicImage.
- #
- # @error request.invalid If the specified resolution is not available.
- #
- # Arguments
- # resolution: The resolution from the resolutions attribute to
- # use.
- # If not specified the highest avialable resolution will be used.
- #
- # Common options are:
- #
- # * low - 512x512 pixels per face
- #
- # * high - 1024x1024 pixels per face
- #
- # * 2k - 2048x2048 pixels per face
- #
- # * 4k - 4096x4096 pixels per face
- (: String): SkyboxPanorama
- # Helper for images(formats: [skybox]) that specifies the return
- # type will all be SkyboxPanoramicImage.
- #
- # Arguments
- # resolutions: undefined
- (: [String!]): [SkyboxPanorama!]
- # The panoramic image location's label visible in showcase/workshop.
- : String!
- }
link Require by
- AnchorLocationProvides an anchor within the model to attach other information.
- ModelA digital twin, metadata and access to assets associated with a 3D model of a space.
- ModelFloorRepresents a floor within the model. This is generally used as a navigation helper as well as a container for rooms, locations and annotations.
- ModelRoomA room within the model, this acts as a container for other information.
- PanoramicImageA 360 degree panoramic image.
- 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.