PanoramicImageLocation

open_in_new

GraphQL Schema definition

  • type PanoramicImageLocation {
  • id: ID!
  • model: Model!
  • anchor: AnchorLocation
  • # The combination of formats and resolutions
  • # that the panoramic image is available in.
  • options: [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
  • resolutions(format: PanoramicImageFormat): [String!]
  • # Describes the placement of the panorama within the model.
  • placement: PanoramaPlacement
  • # Source of the panorama.
  • source: PanoramaSource
  • # The position of the centroid within the model for rendering the panorama.
  • position: Point
  • # The vector describing the directionality and rotation of the camera for
  • # rendering the panorama.
  • rotation: 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'.
  • variant: 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
  • image(format: PanoramicImageFormat!, resolution: String): PanoramicImage
  • # Lists all the images associated with this location.
  • #
  • # Arguments
  • # resolutions: If specified only return resolutions matching one
  • # in this list
  • images(resolutions: [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
  • skybox(resolution: String): SkyboxPanorama
  • # Helper for images(formats: [skybox]) that specifies the return
  • # type will all be SkyboxPanoramicImage.
  • #
  • # Arguments
  • # resolutions: undefined
  • skyboxes(resolutions: [String!]): [SkyboxPanorama!]
  • # The panoramic image location's label visible in showcase/workshop.
  • label: String!
  • }