Class GLTFWriter

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

Constructors

constructor

new GLTFWriter(options?: IWriterOptions): GLTFWriter
Initializes the writer.
Parameters
- Optionaloptions: IWriterOptions = {}
  Additional writer options.
Returns GLTFWriter
- Defined in src/gltf/writer.ts:67

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
Parameters
- accessor: Accessor
Returns number
- Defined in src/gltf/writer.ts:617

`Protected`addBufferView

addBufferView(bufferView: BufferView): number
Parameters
- bufferView: BufferView
Returns number
- Defined in src/gltf/writer.ts:549

`Protected`addMesh

addMesh(mesh: Mesh): number
Parameters
- mesh: Mesh
Returns number
- Defined in src/gltf/writer.ts:367

`Protected`computeAccessorHash

computeAccessorHash(accessor: Accessor): string
Parameters
- accessor: Accessor
Returns string
- Defined in src/gltf/writer.ts:734

`Protected`computeBoundsVec3

computeBoundsVec3(array: Float32Array): { max: number[]; min: number[] }
Parameters
- array: Float32Array
Returns { max: number[]; min: number[] }
- Defined in src/gltf/writer.ts:753

`Protected`computeBufferHash

computeBufferHash(buffer: Buffer): string
Parameters
- buffer: Buffer
Returns string
- Defined in src/gltf/writer.ts:738

`Protected`computeBufferViewHash

computeBufferViewHash(bufferView: BufferView): string
Parameters
- bufferView: BufferView
Returns string
- Defined in src/gltf/writer.ts:730

`Protected`computeMaterialHash

computeMaterialHash(material: null | IPhysicalMaterial): string
Parameters
- material: null | IPhysicalMaterial
Returns string
- Defined in src/gltf/writer.ts:744

`Protected`computeMeshHash

computeMeshHash(mesh: Mesh): string
Parameters
- mesh: Mesh
Returns string
- Defined in src/gltf/writer.ts:724

`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
- Optionalmin: number[]
- Optionalmax: number[]
Returns Accessor
- Defined in src/gltf/writer.ts:633

`Protected`createBufferView

createBufferView(data: Buffer): BufferView
Parameters
- data: Buffer
Returns BufferView
- Defined in src/gltf/writer.ts:565

`Protected`createLineGeometry

createLineGeometry(geometry: ILineGeometry, imf: IScene): Mesh
Parameters
- geometry: ILineGeometry
- imf: IScene
Returns Mesh
- Defined in src/gltf/writer.ts:458

`Protected`createMaterial

createMaterial(
mat: null | IPhysicalMaterial,
imf: IScene,
): MaterialPbrMetallicRoughness
Parameters
- mat: null | IPhysicalMaterial
- imf: IScene
Returns MaterialPbrMetallicRoughness
- Defined in src/gltf/writer.ts:651

`Protected`createMeshGeometry

createMeshGeometry(
    geometry: IMeshGeometry,
    imf: IScene,
    outputUvs: boolean,
): Mesh
Parameters
- geometry: IMeshGeometry
- imf: IScene
- outputUvs: boolean
Returns Mesh
- Defined in src/gltf/writer.ts:383

`Protected`createNode

createNode(fragment: IObjectNode, imf: IScene, outputUvs: boolean): Node
Parameters
- fragment: IObjectNode
- imf: IScene
- outputUvs: boolean
Returns Node
- Defined in src/gltf/writer.ts:310

`Protected`createPointGeometry

createPointGeometry(geometry: IPointGeometry, imf: IScene): Mesh
Parameters
- geometry: IPointGeometry
- imf: IScene
Returns Mesh
- Defined in src/gltf/writer.ts:508

`Protected`createScene

createScene(imf: IScene): Scene
Parameters
- imf: IScene
Returns Scene
- Defined in src/gltf/writer.ts:169

`Protected`createTexture

createTexture(uri: string, imf: IScene): Texture
Parameters
- uri: string
- imf: IScene
Returns Texture
- Defined in src/gltf/writer.ts:689

`Protected`postprocess

postprocess(imf: IScene, gltfPath: string): Promise<void>
Parameters
- imf: IScene
- gltfPath: string
Returns Promise<void>
- Defined in src/gltf/writer.ts:163

`Protected`reset

reset(outputDir: string): void
Parameters
- outputDir: string
Returns void
- Defined in src/gltf/writer.ts:125

`Protected`serializeManifest

serializeManifest(manifest: GlTf, outputPath: string): void
Parameters
- manifest: GlTf
- outputPath: string
Returns void
- Defined in src/gltf/writer.ts:165

write

write(imf: IScene, outputDir: string): Promise<void>
Outputs scene into glTF.
Parameters
- imf: IScene
  Complete scene in intermediate, in-memory format.
- outputDir: string
  Path to output folder.
Returns Promise<void>
Async
- Defined in src/gltf/writer.ts:94

Class GLTFWriter

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GLTFWriter

Properties

ProtectedaccessorHashes

ProtectedactiveSvfMaterials

ProtectedbaseDir

ProtectedbufferSize

ProtectedbufferStream

ProtectedbufferViewCache

ProtectedbufferViewHashes

Protectedmanifest

ProtectedmeshHashes

Protectedoptions

ProtectedpendingTasks

Protectedstats

Methods

ProtectedaddAccessor

Parameters

Returns number

ProtectedaddBufferView

Parameters

Returns number

ProtectedaddMesh

Parameters

Returns number

ProtectedcomputeAccessorHash

Parameters

Returns string

ProtectedcomputeBoundsVec3

Parameters

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

ProtectedcomputeBufferHash

Parameters

Returns string

ProtectedcomputeBufferViewHash

Parameters

Returns string

ProtectedcomputeMaterialHash

Parameters

Returns string

ProtectedcomputeMeshHash

Parameters

Returns string

ProtectedcreateAccessor

Parameters

Returns Accessor

ProtectedcreateBufferView

Parameters

Returns BufferView

ProtectedcreateLineGeometry

Parameters

Returns Mesh

ProtectedcreateMaterial

Parameters

Returns MaterialPbrMetallicRoughness

ProtectedcreateMeshGeometry

Parameters

Returns Mesh

ProtectedcreateNode

Parameters

Returns Node

ProtectedcreatePointGeometry

Parameters

Returns Mesh

ProtectedcreateScene

Parameters

Returns Scene

ProtectedcreateTexture

Parameters

Returns Texture

Protectedpostprocess

Parameters

Returns Promise<void>

`Protected`accessorHashes

`Protected`activeSvfMaterials

`Protected`baseDir

`Protected`bufferSize

`Protected`bufferStream

`Protected`bufferViewCache

`Protected`bufferViewHashes

`Protected`manifest

`Protected`meshHashes

`Protected`options

`Protected`pendingTasks

`Protected`stats

`Protected`addAccessor

`Protected`addBufferView

`Protected`addMesh

`Protected`computeAccessorHash

`Protected`computeBoundsVec3

`Protected`computeBufferHash

`Protected`computeBufferViewHash

`Protected`computeMaterialHash

`Protected`computeMeshHash

`Protected`createAccessor

`Protected`createBufferView

`Protected`createLineGeometry

`Protected`createMaterial

`Protected`createMeshGeometry

`Protected`createNode

`Protected`createPointGeometry

`Protected`createScene

`Protected`createTexture

`Protected`postprocess

`Protected`reset

`Protected`serializeManifest