Class AssetReference

AssetReferences can be used to easily load glTF or GLB assets

You can use AssetReference.getOrCreate to get an AssetReference for a URL to be easily loaded.
When using the same URL multiple times the same AssetReference will be returned, this avoids loading or creating the same asset multiple times.

myAssetReference.preload() to load the asset binary without creating an instance yet.
myAssetReference.loadAssetAsync() to load the asset and create an instance.
myAssetReference.instantiate() to load the asset and create a new instance.
myAssetReference.unload() to dispose allocated memory and destroy the asset instance.

Index

Accessors

asset hasUrl rawAsset uri url

Methods

beginListenDownload endListenDownload instantiate instantiateSynced isLoaded loadAssetAsync preload unload getOrCreate

Accessors

asset

get asset(): any
The loaded asset

Returns any
set asset(val): void
Parameters
- val: any
Returns void

hasUrl

get hasUrl(): boolean
Returns boolean
true if the uri is a valid URL (http, https, blob)

rawAsset

get rawAsset(): any
This is the loaded asset root object. If the asset is a glb/gltf file this will be the three#Scene object.

Returns any

uri

get uri(): string
The url of the loaded asset (or the asset to be loaded)

Returns string
Deprecated
use url

url

get url(): string
The url of the loaded asset (or the asset to be loaded)

Returns string

Methods

beginListenDownload

beginListenDownload(evt): void
Parameters
- evt: ProgressCallback
Returns void

endListenDownload

endListenDownload(evt): void
Parameters
- evt: ProgressCallback
Returns void

instantiate

instantiate(parent?): Promise<any>
loads and returns a new instance of asset
Parameters
- Optional parent: any
Returns Promise<any>

instantiateSynced

instantiateSynced(parent?, saveOnServer?): Promise<any>
loads and returns a new instance of asset - this call is networked so an instance will be created on all connected users
Parameters
- Optional parent: any
- saveOnServer: boolean = true
Returns Promise<any>

isLoaded

isLoaded(): boolean | ArrayBuffer
Returns boolean | ArrayBuffer
true if the asset has been loaded (via preload) or if it exists already (assigned to asset)

loadAssetAsync

loadAssetAsync(prog?): Promise<any>
Loads the asset and creates one instance (assigned to asset)
Parameters
- Optional prog: ProgressCallback
Returns Promise<any>
the loaded asset

preload

preload(): Promise<ArrayBuffer>
loads the asset binary without creating an instance

Returns Promise<ArrayBuffer>

unload

unload(): void
frees previously allocated memory and destroys the current asset instance (if any)

Returns void

`Static` getOrCreate

getOrCreate(sourceId, url, context?): AssetReference
Get an AssetReference for a URL to be easily loaded.
AssetReferences are cached so calling this method multiple times with the same arguments will always return the same AssetReference.
Parameters
- sourceId: string | IComponent
- url: string
- Optional context: Context
Returns AssetReference

Generated using TypeDoc