Azure 3D Data Preparation node.js SDK

Purpose

The node.js SDK works as a "wrapper" on top of the Azure 3D Data Preparation REST API. When creating a node.js application, the node.js SDK can be used to make it easier when working with the service. Instead of raw web requests, the SDK provides async static methods.

The SDK is intended to be used as a starting point when creating applications.

Installation

1. run npm install in the folder that contains the package.json file
2. require/import ApiSettings, Processing, UseCases modules in your js/ts project.

Assets

Assets are container for a 3D model file, along with its associated files. It contains a few utility functions to help with using the Azure 3D Data Preparation service. For example, zipping the 3D model file with its associated files into a zip file to be sent to the service.

UseCases

Use cases are processes that are run on an asset (3D model) in the Azure 3D Data Preparation service. The UseCase class is a generic description of a use case; the actual available use cases that can be run in the service are fetched from the service itself. Use the UseCases.getAvailableUseCases method to get a list of available use cases. The available use cases can very per subscription and/or API endpoint.

UseCaseParameters are custom override settings available for some use cases. These vary per use case. To learn which override parameters are available for a use case, fetch the schema for that particular use case. (If you call the above method with 'true' as arugment, you will get the schemas).

Progress

When a process has been started in the Azure 3D Data Preparation service, you have to manually poll (unless you call a method that provides polling for you). Only when a processing is polled can it ever finish (from an SDK standpoint).