API Reference

Class List

ContainerHandler

Loads files that contain multiple resources. For example glTF files can contain textures, models and animations.

For glTF files, the asset options object can be used to pass load time callbacks for handling the various resources at different stages of loading. The table below lists the resource types and the corresponding supported process functions.

|---------------------------------------------------------------------|
|  resource   |  preprocess |   process   |processAsync | postprocess |
|-------------+-------------+-------------+-------------+-------------|
| global      |      x      |             |             |      x      |
| node        |      x      |      x      |             |      x      |
| light       |      x      |      x      |             |      x      |
| camera      |      x      |      x      |             |      x      |
| animation   |      x      |             |             |      x      |
| material    |      x      |      x      |             |      x      |
| image       |      x      |             |      x      |      x      |
| texture     |      x      |             |      x      |      x      |
| buffer      |      x      |             |      x      |      x      |
| bufferView  |      x      |             |      x      |      x      |
|---------------------------------------------------------------------|

Additional options that can be passed for glTF files: [options.morphPreserveData] - When true, the morph target keeps its data passed using the options, allowing the clone operation.

For example, to receive a texture preprocess callback:

var containerAsset = new pc.Asset(filename, 'container', { url: url, filename: filename }, null, {
    texture: {
        preprocess(gltfTexture) { console.log("texture preprocess"); }
    },
});

Summary

Properties

handlerType

Type of the resource the handler handles.

Methods

load
open
patch

Details

Properties

stringhandlerType

Type of the resource the handler handles.

Methods

load(url, callback, [asset])

Parameters

urlstring, object

Either the URL of the resource to load or a structure containing the load and original URL.

url.loadstring

The URL to be used for loading the resource.

url.originalstring

The original URL to be used for identifying the resource format. This is necessary when loading, for example from blob.

callbackResourceHandlerCallback

The callback used when the resource is loaded or an error occurs.

assetAsset

Optional asset that is passed by ResourceLoader.

open(url, data, [asset])

Parameters

urlstring

The URL of the resource to open.

data*

The raw resource data passed by callback from ResourceHandler#load.

assetAsset

Optional asset that is passed by ResourceLoader.

Returns

*

The parsed resource data.

patch(asset, assets)

Parameters

assetAsset

The asset to patch.

assetsAssetRegistry

The asset registry.