Class ModelLoader

ModelLoader

Behavior summary:

parsePLY: returns a THREE.Mesh created from PLY geometry. By default, PLY geometry is not normalized or re-centered; set autoComputeNormals to true to compute vertex normals. The returned mesh preserves the geometry's original coordinates.
parseGLTF / parseGLB: returns a THREE.Group containing cloned meshes from the GLTF scene. Materials can be overridden via materialOverrides. The loader does not normalize or re-center GLTF models — transforms defined in the file are preserved as-is.
parseNexus (NXS / NXZ): Nexus is a streaming, multi-resolution format. This loader returns a Promise that resolves once the Nexus onLoad event has fired (initial model data available). The loader DOES NOT mutate the Nexus object's transform (no auto-scaling or centering). The loader will populate geometry.boundingSphere and geometry.boundingBox from Nexus's reported boundingSphere on onLoad and onUpdate so scene-level bounding computations (Box3.setFromObject) work correctly.
General: Model transforms (position, rotation, scale) are not applied by the ModelLoader; those are applied by the caller (e.g., ThreePresenter.applyTransforms()) after loading. This keeps model loading and scene presentation responsibilities separate.

Index

Constructors

Methods

loadFromUrl loadFromBuffer detectFormat parsePLY parseGLTF parseNexus applyMaterialOverrides mergeMaterialProperties getConfig setDracoDecoderPath dispose

Properties

config renderer plyLoader gltfLoader dracoLoader

Constructors

constructor

new ModelLoader(config?: LoaderConfig, renderer?: WebGLRenderer): ModelLoader
Create a new model loader
Parameters
- config: LoaderConfig = {}
  Configuration options
- Optionalrenderer: WebGLRenderer
Returns ModelLoader
- Defined in managers/ModelLoader.ts:122

Methods

loadFromUrl

loadFromUrl(
    url: string,
    materialOverrides?: Material | MaterialProperties,
    onProgress?: ProgressCallback,
): Promise<LoadResult>
Load a model from a URL. Automatically detects format from file extension.
Parameters
- url: string
  URL to load from
- OptionalmaterialOverrides: Material | MaterialProperties
  Optional material property overrides
- OptionalonProgress: ProgressCallback
  Optional progress callback
Returns Promise<LoadResult>
Promise resolving to load result
- Defined in managers/ModelLoader.ts:147

loadFromBuffer

loadFromBuffer(
    buffer: ArrayBuffer,
    format: "ply" | "gltf" | "glb" | "nxs" | "nxz",
    materialOverrides?: Material | MaterialProperties,
    url?: string,
): Promise<LoadResult>
Load a model from an ArrayBuffer.
Parameters
- buffer: ArrayBuffer
  ArrayBuffer containing the model data
- format: "ply" | "gltf" | "glb" | "nxs" | "nxz"
  File format ('ply', 'gltf', 'glb', 'nxs', or 'nxz')
- OptionalmaterialOverrides: Material | MaterialProperties
  Optional material property overrides
- Optionalurl: string
  Optional URL for streaming formats like NXS
Returns Promise<LoadResult>
Promise resolving to load result
- Defined in managers/ModelLoader.ts:218

detectFormat

detectFormat(filename: string): "ply" | "gltf" | "glb" | "nxs" | "nxz"
Detect file format from filename or URL
Parameters
- filename: string
  Filename or URL
Returns "ply" | "gltf" | "glb" | "nxs" | "nxz"
Detected format
- Defined in managers/ModelLoader.ts:265

`Private`parsePLY

parsePLY(
    buffer: ArrayBuffer,
    materialOverrides?: Material | MaterialProperties,
    baseDir?: string,
): Promise<
    Mesh<
        BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        Material | Material[],
        Object3DEventMap,
    >,
>
Parse PLY format buffer
Parameters
- buffer: ArrayBuffer
  ArrayBuffer containing PLY data
- OptionalmaterialOverrides: Material | MaterialProperties
  Optional material overrides
- OptionalbaseDir: string
  Optional base directory for resolving relative texture paths
Returns Promise<
    Mesh<
        BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        Material | Material[],
        Object3DEventMap,
    >,
>
Promise resolving to Three.js Mesh
- Defined in managers/ModelLoader.ts:290

`Private`parseGLTF

parseGLTF(
buffer: ArrayBuffer,
materialOverrides?: Material | MaterialProperties,
): Promise<Group<Object3DEventMap>>
Parse GLTF/GLB format buffer
Parameters
- buffer: ArrayBuffer
  ArrayBuffer containing GLTF/GLB data
- OptionalmaterialOverrides: Material | MaterialProperties
  Optional material overrides
Returns Promise<Group<Object3DEventMap>>
Promise resolving to Three.js Group
- Defined in managers/ModelLoader.ts:432

`Private`parseNexus

parseNexus(
url: string,
materialOverrides?: Material | MaterialProperties,
): Promise<Object3D<Object3DEventMap>>
Parse Nexus (NXS/NXZ) format from URL Nexus is a multiresolution format that streams data incrementally
Parameters
- url: string
  URL to the .nxs or .nxz file
- OptionalmaterialOverrides: Material | MaterialProperties
Returns Promise<Object3D<Object3DEventMap>>
Promise resolving to Nexus3D
- Defined in managers/ModelLoader.ts:497

`Private`applyMaterialOverrides

applyMaterialOverrides(material: Material, overrides: MaterialProperties): void
Apply material property overrides to an existing material
Parameters
- material: Material
  Three.js material to modify
- overrides: MaterialProperties
  Properties to override
Returns void
- Defined in managers/ModelLoader.ts:659

`Private`mergeMaterialProperties

mergeMaterialProperties(
defaults: MaterialProperties,
overrides?: MaterialProperties,
): Required<MaterialProperties>
Merge material properties, with overrides taking precedence
Parameters
- defaults: MaterialProperties
  Default properties
- Optionaloverrides: MaterialProperties
  Override properties
Returns Required<MaterialProperties>
Merged properties
- Defined in managers/ModelLoader.ts:689

getConfig

getConfig(): Readonly<Required<LoaderConfig>>
Get the current configuration

Returns Readonly<Required<LoaderConfig>>
- Defined in managers/ModelLoader.ts:704

setDracoDecoderPath

setDracoDecoderPath(path: string): void
Update the Draco decoder path
Parameters
- path: string
  New path to Draco decoder
Returns void
- Defined in managers/ModelLoader.ts:712

dispose

dispose(): void
Clean up resources

Returns void
- Defined in managers/ModelLoader.ts:722

Properties

`Private`config

config: Required<LoaderConfig>

`Private`renderer

renderer: WebGLRenderer | null = null

`Private`plyLoader

plyLoader: any = null

`Private`gltfLoader

gltfLoader: any = null

`Private`dracoLoader

dracoLoader: any = null

Class ModelLoader

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns ModelLoader

Methods

loadFromUrl

Parameters

Returns Promise<LoadResult>

loadFromBuffer

Parameters

Returns Promise<LoadResult>

detectFormat

Parameters

Returns "ply" | "gltf" | "glb" | "nxs" | "nxz"

PrivateparsePLY

Parameters

Returns Promise< Mesh< BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material | Material[], Object3DEventMap, >,>

PrivateparseGLTF

Parameters

Returns Promise<Group<Object3DEventMap>>

PrivateparseNexus

Parameters

Returns Promise<Object3D<Object3DEventMap>>

PrivateapplyMaterialOverrides

Parameters

Returns void

PrivatemergeMaterialProperties

Parameters

Returns Required<MaterialProperties>

getConfig

Returns Readonly<Required<LoaderConfig>>

setDracoDecoderPath

Parameters

Returns void

dispose

Returns void

Properties

Privateconfig

Privaterenderer

PrivateplyLoader

PrivategltfLoader

PrivatedracoLoader

Settings

On This Page

`Private`parsePLY

Returns Promise<
Mesh<
BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
Material | Material[],
Object3DEventMap,
>,
>

`Private`parseGLTF

`Private`parseNexus

`Private`applyMaterialOverrides

`Private`mergeMaterialProperties

`Private`config

`Private`renderer

`Private`plyLoader

`Private`gltfLoader

`Private`dracoLoader