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

Properties

Protected accessorHashes

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

Protected activeSvfMaterials

activeSvfMaterials: 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

  • Parameters

    • geometry: IMeshGeometry
    • imf: IScene
    • outputUvs: boolean

    Returns Mesh

Protected createNode

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

  • Parameters

    • fragment: IObjectNode
    • imf: IScene
    • outputUvs: boolean

    Returns 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>

  • Outputs scene into glTF.

    async

    Parameters

    • imf: IScene

      Complete scene in intermediate, in-memory format.

    • outputDir: string

      Path to output folder.

    Returns Promise<void>

Generated using TypeDoc