Reality Capture is a TypeScript package for interacting with Bentley Reality Capture services.

Available Services

• Reality Modeling: Create and run reality modeling workflows.
• Reality Analysis: Run analysis workflows on reality data.
• Reality Management: Upload, manage, and download reality data.
• Reality Conversion: Convert and optimize reality data.

Get started

npm

Install Reality Capture from the reality-capture npm package:

# Using npm
npm install @itwin/reality-capture --save

# Using yarn
yarn add @itwin/reality-capture

# Using pnpm
pnpm add @itwin/reality-capture

Then import the types and APIs you need in your application code:

import {
  FillImagePropertiesInputs,
} from "@itwin/reality-capture";

const fipInputs: FillImagePropertiesInputs = { imageCollections: ["reality_data_id"] };

Authentication

Create an application that can obtain an iTwin Platform access token, then provide an AuthorizationClient implementation when creating RealityCaptureService. The client must return a valid Bearer token for each API request. See the iTwin Platform authentication guide for application registration and authentication setup.

For a service application, install @itwin/service-authorization and initialize the SDK as follows:

npm install @itwin/service-authorization

import { ServiceAuthorizationClient } from "@itwin/service-authorization";
import { RealityCaptureService } from "@itwin/reality-capture";

const authorizationClient = new ServiceAuthorizationClient({
  clientId: process.env.IMJS_CLIENT_ID ?? "",
  clientSecret: process.env.IMJS_CLIENT_SECRET ?? "",
  scope: "itwin-platform",
  authority: "https://ims.bentley.com",
});

const realityCaptureService = new RealityCaptureService(authorizationClient);

Examples

Explore the examples for complete Reality Capture usage scenarios.

Support

Report bugs and request features through the GitHub issue tracker.

License

This project is licensed under the MIT License.

Contributing

See the contribution guide.