Tools for converting Autodesk Forge file formats.
npm install forge-convert-utils!Publish to NPM
!node
!npm downloads
!platforms
Utilities for converting Autodesk Forge SVF file format into
glTF 2.0.
> Check out forge-convert-sqlite with an experimental
> serialization/deserialization of glTF to/from sqlite.
- install the package: npm install --global forge-convert-utils
- run the forge-convert command without parameters for usage info
- run the command with a path to a local SVF file
- run the command with a Model Derivative URN (and optionally viewable GUID)
- to access Forge you must also specify credentials (FORGE_CLIENT_ID and FORGE_CLIENT_SECRET)
or an authentication token (FORGE_ACCESS_TOKEN) as env. variables
- this will also download the property database in sqlite format
- optionally, use any combination of the following command line args:
- --output-folder to change output folder (by default '.')
- --deduplicate to try and remove duplicate geometries
- --skip-unused-uvs to skip texture UVs that are not used by any material
- --ignore-meshes to exclude mesh geometry from the output
- --ignore-lines to exclude line geometry from the output
- --ignore-points to exclude point geometry from the output
- --center move the model to origin
#### Unix/macOS
``
forge-convert
or
`
export FORGE_CLIENT_ID=
export FORGE_CLIENT_SECRET=
forge-convert
or
`
export FORGE_ACCESS_TOKEN=
forge-convert
#### Windows
`
forge-convert
or
`
set FORGE_CLIENT_ID=
set FORGE_CLIENT_SECRET=
forge-convert
or
`
set FORGE_ACCESS_TOKEN=
forge-convert
The library can be used at different levels of granularity.
The easiest way to convert an SVF file is to read the entire model into memory
using SvfReader#read
method, and save the model into glTF using GltfWriter#write:
`js
const path = require('path');
const { ModelDerivativeClient, ManifestHelper } = require('forge-server-utils');
const { SvfReader, GltfWriter } = require('forge-convert-utils');
const { FORGE_CLIENT_ID, FORGE_CLIENT_SECRET } = process.env;
async function run(urn, outputDir) {
const auth = { client_id: FORGE_CLIENT_ID, client_secret: FORGE_CLIENT_SECRET };
const modelDerivativeClient = new ModelDerivativeClient(auth);
const manifestHelper = new ManifestHelper(await modelDerivativeClient.getManifest(urn));
const derivatives = manifestHelper.search({ type: 'resource', role: 'graphics' });
const readerOptions = {
log: console.log
};
const writerOptions = {
deduplicate: true,
skipUnusedUvs: true,
center: true,
log: console.log,
filter: (dbid) => (dbid >= 100 && dbid <= 200) // only output objects with dbIDs between 100 and 200
};
const writer = new GltfWriter(writerOptions);
for (const derivative of derivatives.filter(d => d.mime === 'application/autodesk-svf')) {
const reader = await SvfReader.FromDerivativeService(urn, derivative.guid, auth);
const scene = await reader.read(readerOptions);
await writer.write(scene, path.join(outputDir, derivative.guid));
}
}
run('your model urn', 'path/to/output/folder');
`
If you don't want to read the entire model into memory (for example, when distributing
the parsing of an SVF over multiple servers), you can use methods like
SvfReader#enumerateFragments
or SvfReader#enumerateGeometries
to _asynchronously_ iterate over individual elements:
`js
const { ModelDerivativeClient, ManifestHelper } = require('forge-server-utils');
const { SvfReader } = require('forge-convert-utils');
const { FORGE_CLIENT_ID, FORGE_CLIENT_SECRET } = process.env;
async function run (urn) {
const auth = { client_id: FORGE_CLIENT_ID, client_secret: FORGE_CLIENT_SECRET };
const modelDerivativeClient = new ModelDerivativeClient(auth);
const manifestHelper = new ManifestHelper(await modelDerivativeClient.getManifest(urn));
const derivatives = manifestHelper.search({ type: 'resource', role: 'graphics' });
for (const derivative of derivatives.filter(d => d.mime === 'application/autodesk-svf')) {
const reader = await SvfReader.FromDerivativeService(urn, derivative.guid, auth);
for await (const fragment of reader.enumerateFragments()) {
console.log(fragment);
}
}
}
run('your model urn');
`
And finally, if you already have the individual SVF assets in memory, you can parse the binary data
directly using _synchronous_ iterators like parseMeshes:
`js`
const { parseMeshes } = require('forge-convert-utils/lib/svf/meshes');
for (const mesh of parseMeshes(buffer)) {
console.log(mesh);
}
> For additional examples, see the test subfolder.
You can customize the translation by sub-classing the reader and/or the writer class. For example:
- The _samples/custom-gltf-attribute.js_ script adds the dbID of each SVF node as a new attribute in its mesh
- The _samples/filter-by-area.js_ script only outputs geometries that are completely contained within a specified area
When converting models from Model Derivative service,
you can retrieve the model's properties and metadata in form of a sqlite database. The command line tool downloads
this database automatically as _properties.sqlite_ file directly in your output folder. If you're using this library
in your own Node.js code, you can find the database in the manifest by looking for an asset with type "resource",
and role "Autodesk.CloudPlatform.PropertyDatabase":
`js`
...
const pdbDerivatives = manifestHelper.search({ type: 'resource', role: 'Autodesk.CloudPlatform.PropertyDatabase' });
if (pdbDerivatives.length > 0) {
const databaseStream = modelDerivativeClient.getDerivativeChunked(urn, pdbDerivatives[0].urn, 1 << 20);
databaseStream.pipe(fs.createWriteStream('./properties.sdb'));
}
...
The structure of the sqlite database, and the way to extract model properties from it is explained in
https://github.com/wallabyway/propertyServer/blob/master/pipeline.md. Here's a simple diagram showing
the individual tables in the database, and the relationships between them:
And here's an example query listing all objects with "Material" property containing the "Concrete" word:
`sql`
SELECT _objects_id.id AS dbId, _objects_id.external_id AS externalId, _objects_attr.name AS propName, _objects_val.value AS propValue
FROM _objects_eav
INNER JOIN _objects_id ON _objects_eav.entity_id = _objects_id.id
INNER JOIN _objects_attr ON _objects_eav.attribute_id = _objects_attr.id
INNER JOIN _objects_val ON _objects_eav.value_id = _objects_val.id
WHERE propName = "Material" AND propValue LIKE "%Concrete%"
Following the Unix philosophy, we removed post-processing dependencies from this project,
and instead leave it to developers to "pipe" the output of this library to other tools
such as https://github.com/CesiumGS/gltf-pipeline or https://github.com/zeux/meshoptimizer.
See ./samples/local-svf-to-gltf.sh or
./samples/remote-svf-to-gltf.sh for examples.
- clone the repository
- install dependencies: yarn install
- build the library (transpile TypeScript):
- run samples in the _test_ subfolder, for example:
If you're using Visual Studio Code, you can use the following "task" and "launch" configurations:
In _.vscode/tasks.json_:
`json`
...
{
"label": "build",
"type": "npm",
"script": "build",
"problemMatcher": [
"$tsc"
],
"group": "build",
"presentation": {
"echo": true,
"reveal": "silent",
"focus": false,
"panel": "shared",
"showReuseMessage": false,
"clear": false
}
}
...
In _.vscode/launch.json_:
`json`
...
{
"type": "node",
"request": "launch",
"name": "Convert Model Derivative SVF to glTF",
"program": "${workspaceFolder}/test/remote-svf-to-gltf.js",
"args": ["
"env": {
"FORGE_CLIENT_ID": "
"FORGE_CLIENT_SECRET": "
},
"preLaunchTask": "build"
},
{
"type": "node",
"request": "launch",
"name": "Convert Local SVF to glTF",
"program": "${workspaceFolder}/test/local-svf-to-gltf.js",
"args": ["
"preLaunchTask": "build"
}
...
The project provides a collection of interfaces for an intermediate 3D format
that is meant to be used by all loaders and writers. When implementing a new loader, make sure that
its output implements the intermediate format's IScene` interface. Similarly, this interface should
also be expected as the input to all new writers.