XRScanshot

• webVis API Reference
• XRScanshot

Interface XRScanshotExperimental

Represents a texture scanshot of the current view in the XR environment.

A texture scanshot augments the digital model with the color of its real-world counterpart using the texture information from the camera stream.

Model-based tracking is required to map texture data to the model with the correct position and orientation.

See

• RealityAPI
• XRConfiguration
• RealityAPI.enterXRInitMode

interface XRScanshot {
    metadata: {
        projectionMatrix:
            | Float32Array<ArrayBufferLike>
            | [
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
                number,
            ];
        viewMatrix: | Float32Array<ArrayBufferLike>
        | [
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
        ];
    };
    pointCloudData?: { points: CloudPoint[] };
}

Index

Properties

metadata pointCloudData?

Properties

Experimentalmetadata

metadata: {
    projectionMatrix:
        | Float32Array<ArrayBufferLike>
        | [
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
        ];
    viewMatrix: | Float32Array<ArrayBufferLike>
    | [
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
    ];
}

Stores any additional information about the scanshot other than the raw data itself.

Type declaration

• projectionMatrix:
      | Float32Array<ArrayBufferLike>
      | [
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
      ]

  The projection matrix of the camera with which the scan has been made.

• viewMatrix:
      | Float32Array<ArrayBufferLike>
      | [
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
          number,
      ]

  The view matrix at which the scan was shot.

Optional ExperimentalpointCloudData

pointCloudData?: { points: CloudPoint[] }

Represents the scanshot as point cloud.

Type declaration

• points: CloudPoint[]

  The CloudPoints within the point cloud representing the scan.

---

Did you find this page useful? Please give it a rating:

★ ★ ★ ★ ★

Thank you for rating this page!

Any issues or feedback?

What kind of problem would you like to report?

• This page needs code samples
• Code samples do not work
• Information is missing
  Please tell us more about what's wrong:
• Information is incorrect
  Please tell us more about what's wrong:
• Information is unclear or confusing
  Please tell us more about what's wrong:
• The page is rendered incorrectly (styling/CSS)
• Give Feedback

Please tell us more about what's wrong: Name E-Mail Problem (required)