diff --git a/classes/F2dDownloader.html b/classes/F2dDownloader.html index 79e78e9..553e326 100644 --- a/classes/F2dDownloader.html +++ b/classes/F2dDownloader.html @@ -1 +1 @@ -F2dDownloader | forge-convert-utils
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class F2dDownloader

Hierarchy

  • F2dDownloader

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected auth

auth: IAuthOptions

Protected modelDerivativeClient

modelDerivativeClient: ModelDerivativeClient

Methods

Private _download

  • _download(urn: string, context: IDownloadContext): Promise<void>

download

  • download(urn: string, options?: IDownloadOptions): IDownloadTask

Generated using TypeDoc

\ No newline at end of file +F2dDownloader | forge-convert-utils
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class F2dDownloader

Hierarchy

  • F2dDownloader

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected auth

auth: IAuthOptions

Protected modelDerivativeClient

modelDerivativeClient: ModelDerivativeClient

Methods

Private _download

  • _download(urn: string, context: IDownloadContext): Promise<void>

download

  • download(urn: string, options?: IDownloadOptions): IDownloadTask

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/GltfWriter.html b/classes/GltfWriter.html index c92acb9..241920b 100644 --- a/classes/GltfWriter.html +++ b/classes/GltfWriter.html @@ -1,8 +1,8 @@ GltfWriter | forge-convert-utils
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GltfWriter

Utility class for serializing parsed 3D content to local file system as glTF (2.0).

-

Hierarchy

  • GltfWriter

Index

Constructors

Properties

Methods

Constructors

constructor

  • new GltfWriter(options?: IWriterOptions): GltfWriter

Hierarchy

  • GltfWriter

Index

Constructors

Properties

Methods

Constructors

constructor

  • new GltfWriter(options?: IWriterOptions): GltfWriter

Properties

Protected accessorHashes

accessorHashes: Map<string, number> = ...

Protected baseDir

baseDir: string

Protected bufferSize

bufferSize: number

Protected bufferStream

bufferStream: null | WriteStream

Protected bufferViewCache

bufferViewCache: Map<string, BufferView> = ...

Protected bufferViewHashes

bufferViewHashes: Map<string, number> = ...

Protected manifest

manifest: GlTf

Protected meshHashes

meshHashes: Map<string, number> = ...

Protected options

options: Required<IWriterOptions>

Protected pendingTasks

pendingTasks: Promise<void>[] = []

Protected stats

stats: IWriterStats = ...

Methods

Protected addAccessor

  • addAccessor(accessor: Accessor): number

Protected addBufferView

  • addBufferView(bufferView: BufferView): number

Protected addMesh

  • addMesh(mesh: Mesh): number

Protected computeAccessorHash

  • computeAccessorHash(accessor: Accessor): string

Protected computeBoundsVec3

  • computeBoundsVec3(array: Float32Array): { max: number[]; min: number[] }

  • Parameters

    • array: Float32Array

    Returns { max: number[]; min: number[] }

    • max: number[]
    • min: number[]

Protected computeBufferHash

  • computeBufferHash(buffer: Buffer): string

Protected computeBufferViewHash

  • computeBufferViewHash(bufferView: BufferView): string

Protected computeMaterialHash

  • computeMaterialHash(material: null | IPhysicalMaterial): string

Protected computeMeshHash

  • computeMeshHash(mesh: Mesh): string

Protected createAccessor

  • createAccessor(bufferViewID: number, componentType: number, count: number, type: string, min?: number[], max?: number[]): Accessor

  • Parameters

    • bufferViewID: number
    • componentType: number
    • count: number
    • type: string
    • Optional min: number[]
    • Optional max: number[]

    Returns Accessor

Protected createBufferView

  • createBufferView(data: Buffer): BufferView

Protected createLineGeometry

  • createLineGeometry(geometry: ILineGeometry, imf: IScene): Mesh

Protected createMaterial

  • createMaterial(mat: null | IPhysicalMaterial, imf: IScene): MaterialPbrMetallicRoughness

  • Parameters

    • mat: null | IPhysicalMaterial
    • imf: IScene

    Returns MaterialPbrMetallicRoughness

Protected createMeshGeometry

  • createMeshGeometry(geometry: IMeshGeometry, imf: IScene, outputUvs: boolean): Mesh

Protected createNode

  • createNode(fragment: IObjectNode, imf: IScene, outputUvs: boolean): Node

Protected createPointGeometry

  • createPointGeometry(geometry: IPointGeometry, imf: IScene): Mesh

Protected createScene

  • createScene(imf: IScene): Scene

Protected createTexture

  • createTexture(uri: string, imf: IScene): Texture

Protected postprocess

  • postprocess(imf: IScene, gltfPath: string): Promise<void>

Protected reset

  • reset(outputDir: string): void

Protected serializeManifest

  • serializeManifest(manifest: GlTf, outputPath: string): void

write

  • write(imf: IScene, outputDir: string): Promise<void>

Properties

Protected accessorHashes

accessorHashes: Map<string, number> = ...

Protected baseDir

baseDir: string

Protected bufferSize

bufferSize: number

Protected bufferStream

bufferStream: null | WriteStream

Protected bufferViewCache

bufferViewCache: Map<string, BufferView> = ...

Protected bufferViewHashes

bufferViewHashes: Map<string, number> = ...

Protected manifest

manifest: GlTf

Protected meshHashes

meshHashes: Map<string, number> = ...

Protected options

options: Required<IWriterOptions>

Protected pendingTasks

pendingTasks: Promise<void>[] = []

Protected stats

stats: IWriterStats = ...

Methods

Protected addAccessor

  • addAccessor(accessor: Accessor): number

Protected addBufferView

  • addBufferView(bufferView: BufferView): number

Protected addMesh

  • addMesh(mesh: Mesh): number

Protected computeAccessorHash

  • computeAccessorHash(accessor: Accessor): string

Protected computeBoundsVec3

  • computeBoundsVec3(array: Float32Array): { max: number[]; min: number[] }

  • Parameters

    • array: Float32Array

    Returns { max: number[]; min: number[] }

    • max: number[]
    • min: number[]

Protected computeBufferHash

  • computeBufferHash(buffer: Buffer): string

Protected computeBufferViewHash

  • computeBufferViewHash(bufferView: BufferView): string

Protected computeMaterialHash

  • computeMaterialHash(material: null | IPhysicalMaterial): string

Protected computeMeshHash

  • computeMeshHash(mesh: Mesh): string

Protected createAccessor

  • createAccessor(bufferViewID: number, componentType: number, count: number, type: string, min?: number[], max?: number[]): Accessor

  • Parameters

    • bufferViewID: number
    • componentType: number
    • count: number
    • type: string
    • Optional min: number[]
    • Optional max: number[]

    Returns Accessor

Protected createBufferView

  • createBufferView(data: Buffer): BufferView

Protected createLineGeometry

  • createLineGeometry(geometry: ILineGeometry, imf: IScene): Mesh

Protected createMaterial

  • createMaterial(mat: null | IPhysicalMaterial, imf: IScene): MaterialPbrMetallicRoughness

  • Parameters

    • mat: null | IPhysicalMaterial
    • imf: IScene

    Returns MaterialPbrMetallicRoughness

Protected createMeshGeometry

  • createMeshGeometry(geometry: IMeshGeometry, imf: IScene, outputUvs: boolean): Mesh

Protected createNode

  • createNode(fragment: IObjectNode, imf: IScene, outputUvs: boolean): Node

Protected createPointGeometry

  • createPointGeometry(geometry: IPointGeometry, imf: IScene): Mesh

Protected createScene

  • createScene(imf: IScene): Scene

Protected createTexture

  • createTexture(uri: string, imf: IScene): Texture

Protected postprocess

  • postprocess(imf: IScene, gltfPath: string): Promise<void>

Protected reset

  • reset(outputDir: string): void

Protected serializeManifest

  • serializeManifest(manifest: GlTf, outputPath: string): void

write

  • write(imf: IScene, outputDir: string): Promise<void>

Hierarchy

  • SvfReader

Index

Constructors

Properties

Methods

Constructors

Protected constructor

  • new SvfReader(svf: Buffer, resolve: (uri: string) => Promise<Buffer>): SvfReader

  • Parameters

    • svf: Buffer
    • resolve: (uri: string) => Promise<Buffer>
        • (uri: string): Promise<Buffer>

        • Parameters

          • uri: string

          Returns Promise<Buffer>

    Returns SvfReader

Properties

Protected resolve

resolve: (uri: string) => Promise<Buffer>

Type declaration

    • (uri: string): Promise<Buffer>

    • Parameters

      • uri: string

      Returns Promise<Buffer>

Protected svf

svf: ISvfRoot

Methods

enumerateFragments

  • enumerateFragments(): AsyncIterable<IFragment>

Hierarchy

  • SvfReader

Index

Constructors

Properties

Methods

Constructors

Protected constructor

  • new SvfReader(svf: Buffer, resolve: (uri: string) => Promise<Buffer>): SvfReader

  • Parameters

    • svf: Buffer
    • resolve: (uri: string) => Promise<Buffer>
        • (uri: string): Promise<Buffer>

        • Parameters

          • uri: string

          Returns Promise<Buffer>

    Returns SvfReader

Properties

Protected resolve

resolve: (uri: string) => Promise<Buffer>

Type declaration

    • (uri: string): Promise<Buffer>

    • Parameters

      • uri: string

      Returns Promise<Buffer>

Protected svf

svf: ISvfRoot

Methods

enumerateFragments

  • enumerateFragments(): AsyncIterable<IFragment>

  • Retrieves, parses, and iterates over all SVF fragments.

    async
    generator

    Returns AsyncIterable<IFragment>

    Async iterator over parsed fragments.

    -

enumerateGeometries

  • enumerateGeometries(): AsyncIterable<IGeometryMetadata>

enumerateGeometries

  • enumerateGeometries(): AsyncIterable<IGeometryMetadata>

  • Retrieves, parses, and iterates over all SVF geometry metadata.

    async
    generator

    Returns AsyncIterable<IGeometryMetadata>

    Async iterator over parsed geometry metadata.

    -

enumerateMaterials

  • enumerateMaterials(): AsyncIterable<null | IMaterial>

enumerateMaterials

  • enumerateMaterials(): AsyncIterable<null | IMaterial>

  • Retrieves, parses, and iterates over all SVF materials.

    async
    generator

    Returns AsyncIterable<null | IMaterial>

    Async iterator over parsed materials (or null values for unsupported material types).

    -

enumerateMeshPack

  • enumerateMeshPack(packNumber: number): AsyncIterable<null | IMesh | ILines | IPoints>

enumerateMeshPack

  • enumerateMeshPack(packNumber: number): AsyncIterable<null | IMesh | ILines | IPoints>

  • Retrieves, parses, and iterates over all meshes, lines, or points in a specific SVF meshpack.

    async
    generator

    Parameters

    • packNumber: number

    Returns AsyncIterable<null | IMesh | ILines | IPoints>

    Async iterator over parsed meshes, lines, or points (or null values for unsupported mesh types).

    -

Protected findAsset

  • findAsset(query: { type?: AssetType; uri?: string }): undefined | ISvfManifestAsset

  • Parameters

    • query: { type?: AssetType; uri?: string }
      • Optional type?: AssetType
      • Optional uri?: string

    Returns undefined | ISvfManifestAsset

getAsset

  • getAsset(uri: string): Promise<Buffer>

Protected findAsset

  • findAsset(query: { type?: AssetType; uri?: string }): undefined | ISvfManifestAsset

  • Parameters

    • query: { type?: AssetType; uri?: string }
      • Optional type?: AssetType
      • Optional uri?: string

    Returns undefined | ISvfManifestAsset

getAsset

  • getAsset(uri: string): Promise<Buffer>

  • Retrieves raw binary data of a specific SVF asset.

    async

    Parameters

    • uri: string

      Asset URI.

    Returns Promise<Buffer>

    Asset content.

    -

getManifest

  • getManifest(): Promise<ISvfManifest>

getManifest

  • getManifest(): Promise<ISvfManifest>

  • Retrieves parsed SVF manifest.

    async

    Returns Promise<ISvfManifest>

    SVF manifest.

    -

getMeshPackCount

  • getMeshPackCount(): number

getMeshPackCount

  • getMeshPackCount(): number

getMetadata

  • getMetadata(): Promise<ISvfMetadata>

getMetadata

  • getMetadata(): Promise<ISvfMetadata>

  • Retrieves parsed SVF metadata.

    async

    Returns Promise<ISvfMetadata>

    SVF metadata.

    -

getPropertyDb

  • getPropertyDb(): Promise<PropDbReader>

getPropertyDb

  • getPropertyDb(): Promise<PropDbReader>

  • Retrieves and parses the property database.

    async

    Returns Promise<PropDbReader>

    Property database reader.

    -

listImages

  • listImages(): string[]

listImages

  • listImages(): string[]

  • Finds URIs of all image assets referenced in the SVF. These can then be retrieved using getAsset.

    Returns string[]

    Image asset URIs.

    -

read

  • read(options?: IReaderOptions): Promise<IScene>

read

  • read(options?: IReaderOptions): Promise<IScene>

  • Reads the entire scene 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 readFragments, enumerateGeometries, etc.

    async

    Parameters

    • Optional options: IReaderOptions

    Returns Promise<IScene>

    Intermediate, in-memory representation of the loaded scene.

    -

readFragments

  • readFragments(): Promise<IFragment[]>

readFragments

  • readFragments(): Promise<IFragment[]>

  • Retrieves, parses, and collects all SVF fragments.

    async

    Returns Promise<IFragment[]>

    List of parsed fragments.

    -

readGeometries

  • readGeometries(): Promise<IGeometryMetadata[]>

readGeometries

  • readGeometries(): Promise<IGeometryMetadata[]>

  • Retrieves, parses, and collects all SVF geometry metadata.

    async

    Returns Promise<IGeometryMetadata[]>

    List of parsed geometry metadata.

    -

readMaterials

  • readMaterials(): Promise<(null | IMaterial)[]>

readMaterials

  • readMaterials(): Promise<(null | IMaterial)[]>

  • Retrieves, parses, and collects all SVF materials.

    async

    Returns Promise<(null | IMaterial)[]>

    List of parsed materials (or null values for unsupported material types).

    -

readMeshPack

  • readMeshPack(packNumber: number): Promise<(null | IMesh | ILines | IPoints)[]>

readMeshPack

  • readMeshPack(packNumber: number): Promise<(null | IMesh | ILines | IPoints)[]>

  • Retrieves, parses, and collects all meshes, lines, or points in a specific SVF meshpack.

    async

    Parameters

    • packNumber: number

      Index of mesh pack file.

    Returns Promise<(null | IMesh | ILines | IPoints)[]>

    List of parsed meshes, lines, or points (or null values for unsupported mesh types).

    -

Static FromDerivativeService

  • FromDerivativeService(urn: string, guid: string, auth: IAuthOptions, host?: string, region?: Region): Promise<SvfReader>

Static FromDerivativeService

  • FromDerivativeService(urn: string, guid: string, auth: IAuthOptions, host?: string, region?: Region): Promise<SvfReader>

  • Instantiates new reader for an SVF in Forge Model Derivative service.

    async

    Parameters

    • urn: string

      Forge model URN.

      @@ -83,7 +83,7 @@
    • Optional region: Region

      Optional region to be used by all Forge calls.

    Returns Promise<SvfReader>

    Reader for the provided SVF.

    -

Static FromFileSystem

  • FromFileSystem(filepath: string): Promise<SvfReader>

Static FromFileSystem

  • FromFileSystem(filepath: string): Promise<SvfReader>

  • Instantiates new reader for an SVF on local file system.

    async

    Parameters

    • filepath: string

      Path to the *.svf file.