Retrieves, parses, and iterates over all SVF fragments.
Async iterator over parsed fragments.
Retrieves, parses, and iterates over all SVF geometry metadata.
Async iterator over parsed geometry metadata.
Retrieves, parses, and iterates over all SVF materials.
Async iterator over parsed materials (or null values for unsupported material types).
Retrieves raw binary data of a specific SVF asset.
Asset URI.
Asset content.
Gets the number of available mesh packs.
Retrieves parsed SVF metadata.
SVF metadata.
Retrieves and parses the property database.
Property database reader.
Finds URIs of all image assets referenced in the SVF. These can then be retrieved using getAsset.
Image asset URIs.
Reads the entire SVF and all its referenced assets into memory. In cases where a more granular control is needed (for example, when trying to control memory consumption), consider parsing the different SVF elements individually, using methods like {@link listFragments}, enumerateGeometries, etc.
Retrieves, parses, and collects all SVF fragments.
List of parsed fragments.
Retrieves, parses, and collects all SVF geometry metadata.
List of parsed geometry metadata.
Retrieves, parses, and collects all SVF materials.
List of parsed materials (or null values for unsupported material types).
Instantiates new reader for an SVF in Forge Model Derivative service.
Forge model URN.
Forge viewable GUID. The viewable(s) can be found in the manifest with type: 'resource', role: 'graphics', and mime: 'application/autodesk-svf'.
Credentials or access token for accessing the Model Derivative service.
Reader for the provided SVF.
Instantiates new reader for an SVF on local file system.
Path to the *.svf file.
Reader for the provided SVF.
Generated using TypeDoc
Utility class for parsing & reading SVF content from Model Derivative service or from local file system.
The class can only be instantiated using one of the two async static methods: Reader.FromFileSystem, or Reader.FromDerivativeService. After that, you can parse the entire SVF into memory using {@link parse}, or parse individual SVF objects using methods like {@link listFragments} or enumerateGeometries.
const auth = { client_id: 'forge client id', client_secret: 'forge client secreet' }; const reader = await Reader.FromDerivativeService('model urn', 'viewable guid', auth); const svf = await reader.read(); // Read entire SVF into memory console.log(svf);
const reader = await Reader.FromFileSystem('path/to/svf'); // Enumerate fragments (without building a list of all of them) for await (const fragment of reader.enumerateFragments()) { console.log(fragment); }