Class ContainerAssetTask

Define a task used by AssetsManager to load assets into a container

Hierarchy

AbstractAssetTask
- ContainerAssetTask

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ContainerAssetTask(name: string, meshesNames: any, rootUrl: string, sceneFilename: string | File, extension?: string): ContainerAssetTask

Overrides AbstractAssetTask.constructor
- Defined in .temp/docdirectory/doc.d.ts:76322
Creates a new ContainerAssetTask

Parameters
- name: string
  
  defines the name of the task
- meshesNames: any
  
  defines the list of mesh's names you want to load
- rootUrl: string
  
  defines the root url to use as a base to load your meshes and associated resources
- sceneFilename: string | File
  
  defines the filename or File of the scene to load from
- Optional extension: string
Returns ContainerAssetTask

Properties

Optional extension Search playground for extension

extension?: string

Defines the extension to use to load the scene (if not defined, ".babylon" will be used)

loadedAnimationGroups Search playground for loadedAnimationGroups

loadedAnimationGroups: AnimationGroup[]

Gets the list of loaded animation groups

loadedContainer Search playground for loadedContainer

loadedContainer: AssetContainer

Get the loaded asset container

loadedMeshes Search playground for loadedMeshes

loadedMeshes: AbstractMesh[]

Gets the list of loaded meshes

loadedParticleSystems Search playground for loadedParticleSystems

loadedParticleSystems: IParticleSystem[]

Gets the list of loaded particle systems

loadedSkeletons Search playground for loadedSkeletons

loadedSkeletons: Skeleton[]

Gets the list of loaded skeletons

loadedTransformNodes Search playground for loadedTransformNodes

loadedTransformNodes: TransformNode[]

Gets the list of loaded transforms

meshesNames Search playground for meshesNames

meshesNames: any

Defines the list of mesh's names you want to load

name Search playground for name

name: string

Defines the name of the task

onError Search playground for onError

onError: ((task: ContainerAssetTask, message?: string, exception?: any) => void)

Type declaration

- (task: ContainerAssetTask, message?: string, exception?: any): void
- Callback called when the task is successful
  
  Parameters
  - task: ContainerAssetTask
  - Optional message: string
  - Optional exception: any
  Returns void

onSuccess Search playground for onSuccess

onSuccess: ((task: ContainerAssetTask) => void)

Type declaration

- (task: ContainerAssetTask): void
- Callback called when the task is successful
  
  Parameters
  - task: ContainerAssetTask
  Returns void

rootUrl Search playground for rootUrl

rootUrl: string

Defines the root url to use as a base to load your meshes and associated resources

sceneFilename Search playground for sceneFilename

sceneFilename: string | File

Defines the filename or File of the scene to load from

Accessors

errorObject

get errorObject(): { exception?: any; message?: string }

Inherited from AbstractAssetTask.errorObject
- Defined in .temp/docdirectory/doc.d.ts:76187
Gets the current error object (if task is in error)

Returns { exception?: any; message?: string }
- Optional exception?: any
- Optional message?: string

isCompleted

get isCompleted(): boolean

Inherited from AbstractAssetTask.isCompleted
- Defined in .temp/docdirectory/doc.d.ts:76179
Get if the task is completed

Returns boolean

taskState

get taskState(): AssetTaskState

Inherited from AbstractAssetTask.taskState
- Defined in .temp/docdirectory/doc.d.ts:76183
Gets the current state of the task

Returns AssetTaskState

Methods

reset Search playground for reset

reset(): void

Inherited from AbstractAssetTask.reset
- Defined in .temp/docdirectory/doc.d.ts:76214
Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again. This can be used with failed tasks that have the reason for failure fixed.

Returns void

run Search playground for run

run(scene: Scene, onSuccess: (() => void), onError: ((message?: string, exception?: any) => void)): void

Inherited from AbstractAssetTask.run
- Defined in .temp/docdirectory/doc.d.ts:76202
Execute the current task

Parameters
- scene: Scene
  
  defines the scene where you want your assets to be loaded
- onSuccess: (() => void)
  
  is a callback called when the task is successfully executed
  - - (): void
    - Returns void
- onError: ((message?: string, exception?: any) => void)
  
  is a callback called if an error occurs
  - - (message?: string, exception?: any): void
    - Parameters
      - Optional message: string
      - Optional exception: any
      Returns void
Returns void

runTask Search playground for runTask

runTask(scene: Scene, onSuccess: (() => void), onError: ((message?: string, exception?: any) => void)): void

Overrides AbstractAssetTask.runTask
- Defined in .temp/docdirectory/doc.d.ts:76349
Execute the current task

Parameters
- scene: Scene
  
  defines the scene where you want your assets to be loaded
- onSuccess: (() => void)
  
  is a callback called when the task is successfully executed
  - - (): void
    - Returns void
- onError: ((message?: string, exception?: any) => void)
  
  is a callback called if an error occurs
  - - (message?: string, exception?: any): void
    - Parameters
      - Optional message: string
      - Optional exception: any
      Returns void
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

name: string

meshesNames: any

rootUrl: string

sceneFilename: string | File

Optional extension: string

Returns ContainerAssetTask

Properties

Optional extensionSearch playground for extension

loadedAnimationGroupsSearch playground for loadedAnimationGroups

loadedContainerSearch playground for loadedContainer

loadedMeshesSearch playground for loadedMeshes

loadedParticleSystemsSearch playground for loadedParticleSystems

loadedSkeletonsSearch playground for loadedSkeletons

loadedTransformNodesSearch playground for loadedTransformNodes

meshesNamesSearch playground for meshesNames

nameSearch playground for name

onErrorSearch playground for onError

Type declaration

Parameters

task: ContainerAssetTask

Optional message: string

Optional exception: any

Returns void

onSuccessSearch playground for onSuccess

Type declaration

Parameters

task: ContainerAssetTask

Returns void

rootUrlSearch playground for rootUrl

sceneFilenameSearch playground for sceneFilename

Accessors

errorObject

Returns { exception?: any; message?: string }

Optional exception?: any

Optional message?: string

isCompleted

Returns boolean

taskState

Returns AssetTaskState

Methods

resetSearch playground for reset

Returns void

runSearch playground for run

Parameters

scene: Scene

onSuccess: (() => void)

Returns void

onError: ((message?: string, exception?: any) => void)

Parameters

Optional message: string

Optional exception: any

Returns void

Returns void

runTaskSearch playground for runTask

Parameters

scene: Scene

onSuccess: (() => void)

Returns void

onError: ((message?: string, exception?: any) => void)

Parameters

Optional message: string

Optional exception: any

Returns void

Returns void

Optional extension Search playground for extension

loadedAnimationGroups Search playground for loadedAnimationGroups

loadedContainer Search playground for loadedContainer

loadedMeshes Search playground for loadedMeshes

loadedParticleSystems Search playground for loadedParticleSystems

loadedSkeletons Search playground for loadedSkeletons

loadedTransformNodes Search playground for loadedTransformNodes

meshesNames Search playground for meshesNames

name Search playground for name

onError Search playground for onError

onSuccess Search playground for onSuccess

rootUrl Search playground for rootUrl

sceneFilename Search playground for sceneFilename

reset Search playground for reset

run Search playground for run

runTask Search playground for runTask