LCCRender::load

Loads LCC data and returns an LCCObject.

The Web SDK supports Three.js and CesiumJS engines. Pass the corresponding engine parameters to load an LCC model.

Version Requirement

SDK v0.2.0+

Engine Support

Three.js / CesiumJS

API

LCCRender::load(param: LoadOptions, successFunc: SuccessFunc, progressFunc: ProgressFunc, failureFunc: FailureFunc, preProcessFunc?: PreProcessFunc): LCCObject

Parameters

param (Three.js)

param (CesiumJS)

Callback Functions

dataPath Format

dataPath supports two formats:

Option 1: String path (recommended)

Pass a string directly specifying the LCC data path:

• Full .lcc file path, e.g., http://example.com/data/xxxx.lcc. SDK v0.4.1+ (recommended)
• Full .lcc2 file path, e.g., http://example.com/data/xxxx.lcc2. SDK v0.6.0+ (recommended)
• meta.lcc file path with token and other parameters for encrypted data scenarios, e.g., https://example.com/data/meta.lcc?token=xxx&other=xxx
• Directory path requiring a meta.lcc file in the directory, e.g., https://example.com/data (deprecated)

const lccObject = LCCRender.load({
    // ...other params
    dataPath: 'http://example.com/data/xxxx.lcc',
}, successFunc, progressFunc, failureFunc);

Option 2: Path descriptor collection (SDK v0.5.0+)

Use an object to customize all file paths with encryption support, applicable to LCC format.

File path descriptor format:

{
    "fileName": {
        "url": "xxxxxxxxxxxx",
        "header": { "field1": "xxx", "field2": "yyy" }  // Optional, added to HTTP request headers
    }
}

Example:

const dataPath = {
    meta: { url: 'http://example.com/xxx/meta.lcc' },
    index: { url: 'http://example.com/xxx/index.bin' },
    data: { url: 'http://example.com/xxx/data.bin' },
    environment: { url: 'http://example.com/xxx/environment.bin' },
    collision: { url: 'http://example.com/xxx/collision.lci' },
    shcoef: { url: 'http://example.com/xxx/shcoef.bin' },
};

const lccObject = LCCRender.load({
    // ...other params
    dataPath: dataPath,
}, successFunc, progressFunc, failureFunc);

Return Value

LCCObject — LCC model object with interfaces for raycasting, clipping, render control, and more.

Notes

• Three.js engine requires calling LCCRender.update() in the render loop.
• The param.useSH parameter is deprecated; use the LCCObject.useShcoef() method instead.
• The param.gpuAcceleration parameter is deprecated.
• dataPath supports .lcc format (SDK v0.4.1+) and .lcc2 format (SDK v0.6.0+).

Related APIs

• LCCRender::unload()
• LCCRender::update()
• LCCRender::dispose()