AssetContainer | Babylon.js API documentation

Class AssetContainer

Container with a set of assets that can be added or removed from a scene.

Hierarchy (View Summary)

AbstractAssetContainer
- AssetContainer

Constructors

constructor

new AssetContainer(scene?: Nullable<Scene>): AssetContainer
Instantiates an AssetContainer.
Parameters
- Optionalscene: Nullable<Scene>
  The scene the AssetContainer belongs to.
Returns AssetContainer
Overrides AbstractAssetContainer.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4977

Properties

actionManagers

actionManagers: AbstractActionManager[]

ActionManagers available on the scene.

Deprecated

animationGroups

animationGroups: AnimationGroup[]

All of the animation groups added to this scene

See

https://doc.babylonjs.com/features/featuresDeepDive/animation/groupAnimations

animations

animations: Animation[]

Gets a list of Animations associated with the scene

cameras

cameras: Camera[]

All of the cameras added to this scene

See

https://doc.babylonjs.com/features/featuresDeepDive/cameras

effectLayers

effectLayers: EffectLayer[]

The list of effect layers added to the scene

geometries

geometries: Geometry[]

The list of geometries used in the scene.

layers

layers: Layer[]

The list of layers added to the scene

lensFlareSystems

lensFlareSystems: LensFlareSystem[]

The list of lens flare systems added to the scene

lights

lights: Light[]

All of the lights added to this scene

See

https://doc.babylonjs.com/features/featuresDeepDive/lights/lights_introduction

materials

materials: Material[]

All of the materials added to this scene In the context of a Scene, it is not supposed to be modified manually. Any addition or removal should be done using the addMaterial and removeMaterial Scene methods. Note also that the order of the Material within the array is not significant and might change.

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/materials_introduction

meshes

meshes: AbstractMesh[]

All of the (abstract) meshes added to this scene

morphTargetManagers

morphTargetManagers: MorphTargetManager[]

The list of morph target managers added to the scene

See

https://doc.babylonjs.com/features/featuresDeepDive/mesh/dynamicMeshMorph

multiMaterials

multiMaterials: MultiMaterial[]

All of the multi-materials added to this scene

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/multiMaterials

particleSystems

particleSystems: IParticleSystem[]

All of the particle systems added to this scene

See

https://doc.babylonjs.com/features/featuresDeepDive/particles/particle_system/particle_system_intro

postProcesses

postProcesses: PostProcess[]

The list of postprocesses added to the scene

proceduralTextures

proceduralTextures: ProceduralTexture[]

The list of procedural textures added to the scene

reflectionProbes

reflectionProbes: ReflectionProbe[]

The list of reflection probes added to the scene

rootNodes

rootNodes: Node[]

Gets the list of root nodes (ie. nodes with no parent)

scene

scene: Scene

The scene the AssetContainer belongs to.

skeletons

skeletons: Skeleton[]

The list of skeletons added to the scene

See

https://doc.babylonjs.com/features/featuresDeepDive/mesh/bonesSkeletons

sounds

sounds: Nullable<Sound[]>

The list of sounds

textures

textures: BaseTexture[]

Textures to keep.

transformNodes

transformNodes: TransformNode[]

All of the transform nodes added to this scene In the context of a Scene, it is not supposed to be modified manually. Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods. Note also that the order of the TransformNode within the array is not significant and might change.

See

https://doc.babylonjs.com/features/featuresDeepDive/mesh/transforms/parent_pivot/transform_node

Accessors

environmentTexture

get environmentTexture(): Nullable<BaseTexture>
Texture used in all pbr material as the reflection texture. As in the majority of the scene they are the same (exception for multi room and so on), this is easier to reference from here than from all the materials.

Returns Nullable<BaseTexture>
Inherited from AbstractAssetContainer.environmentTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4902
set environmentTexture(value: Nullable<BaseTexture>): void
Texture used in all pbr material as the reflection texture. As in the majority of the scene they are the same (exception for multi room and so on), this is easier to reference from here than from all the materials.
Parameters
- value: Nullable<BaseTexture>
Returns void
Inherited from AbstractAssetContainer.environmentTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4903

Methods

addAllAssetsToContainer

addAllAssetsToContainer(root: Node): void
Parameters
- root: Node
  root node
Returns void
Since
6.26.0 Given a root asset, this method will traverse its hierarchy and add it, its children and any materials/skeletons/animation groups to the container.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:5063

addAllToScene

addAllToScene(): void
Adds all the assets from the container to the scene.

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:5013

addToScene

addToScene(predicate?: Nullable<(entity: any) => boolean>): void
Adds assets from the container to the scene.
Parameters
- Optionalpredicate: Nullable<(entity: any) => boolean>
  defines a predicate used to select which entity will be added (can be null)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:5018

createRootMesh

createRootMesh(): Mesh
Adds all meshes in the asset container to a root mesh that can be used to position all the contained meshes. The root mesh is then added to the front of the meshes in the assetContainer.

Returns Mesh
the root mesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:5042

dispose

dispose(): void
Disposes all the assets in the container

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:5031

getCamerasByTags

getCamerasByTags(
tagsQuery: string,
filter?: (camera: Camera) => boolean,
): Camera[]
Get a list of cameras by tags
Parameters
- tagsQuery: string
  defines the tags query to use
- Optionalfilter: (camera: Camera) => boolean
  defines a predicate used to filter results
Returns Camera[]
an array of Camera
- Defined in .temp/typedoc/docdirectory/doc.d.ts:5085

getLightsByTags

getLightsByTags(tagsQuery: string, filter?: (light: Light) => boolean): Light[]
Get a list of lights by tags
Parameters
- tagsQuery: string
  defines the tags query to use
- Optionalfilter: (light: Light) => boolean
  defines a predicate used to filter results
Returns Light[]
an array of Light
- Defined in .temp/typedoc/docdirectory/doc.d.ts:5092

getMaterialsByTags

getMaterialsByTags(
tagsQuery: string,
filter?: (material: Material) => boolean,
): Material[]
Get a list of materials by tags
Parameters
- tagsQuery: string
  defines the tags query to use
- Optionalfilter: (material: Material) => boolean
  defines a predicate used to filter results
Returns Material[]
an array of Material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:5099

getMeshesByTags

getMeshesByTags(
tagsQuery: string,
filter?: (mesh: AbstractMesh) => boolean,
): AbstractMesh[]
Get a list of meshes by tags
Parameters
- tagsQuery: string
  defines the tags query to use
- Optionalfilter: (mesh: AbstractMesh) => boolean
  defines a predicate used to filter results
Returns AbstractMesh[]
an array of Mesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:5078

getNodes

getNodes(): Node[]
Returns Node[]
all meshes, lights, cameras, transformNodes and bones
Inherited from AbstractAssetContainer.getNodes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4935

getTransformNodesByTags

getTransformNodesByTags(
tagsQuery: string,
filter?: (transform: TransformNode) => boolean,
): TransformNode[]
Get a list of transform nodes by tags
Parameters
- tagsQuery: string
  defines the tags query to use
- Optionalfilter: (transform: TransformNode) => boolean
  defines a predicate used to filter results
Returns TransformNode[]
an array of TransformNode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:5106

instantiateModelsToScene

instantiateModelsToScene(
    nameFunction?: (sourceName: string) => string,
    cloneMaterials?: boolean,
    options?: {
        doNotInstantiate?: boolean | (node: Node) => boolean;
        predicate?: (entity: any) => boolean;
    },
): InstantiatedEntries
Instantiate or clone all meshes and add the new ones to the scene. Skeletons and animation groups will all be cloned
Parameters
- OptionalnameFunction: (sourceName: string) => string
  defines an optional function used to get new names for clones
- OptionalcloneMaterials: boolean
  defines an optional boolean that defines if materials must be cloned as well (false by default)
- Optionaloptions: {
  doNotInstantiate?: boolean | (node: Node) => boolean;
  predicate?: (entity: any) => boolean;
  }
  defines an optional list of options to control how to instantiate / clone models
  - OptionaldoNotInstantiate?: boolean | (node: Node) => boolean
    defines if the model must be instantiated or just cloned
  - Optionalpredicate?: (entity: any) => boolean
    defines a predicate used to filter whih mesh to instantiate/clone
Returns InstantiatedEntries
a list of rootNodes, skeletons and animation groups that were duplicated
- Defined in .temp/typedoc/docdirectory/doc.d.ts:5006

mergeAnimationsTo

mergeAnimationsTo(
    scene: undefined | Nullable<Scene>,
    animatables: Animatable[],
    targetConverter?: Nullable<(target: any) => Nullable<Node>>,
): AnimationGroup[]
Merge animations (direct and animation groups) from this asset container into a scene
Parameters
- scene: undefined | Nullable<Scene>
  is the instance of BABYLON.Scene to append to (default: last created scene)
- animatables: Animatable[]
  set of animatables to retarget to a node from the scene
- OptionaltargetConverter: Nullable<(target: any) => Nullable<Node>>
  defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
Returns AnimationGroup[]
an array of the new AnimationGroup added to the scene (empty array if none)
- Defined in .temp/typedoc/docdirectory/doc.d.ts:5050

moveAllFromScene

moveAllFromScene(keepAssets?: KeepAssets): void
Removes all the assets contained in the scene and adds them to the container.
Parameters
- OptionalkeepAssets: KeepAssets
  Set of assets to keep in the scene. (default: empty)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:5037

populateRootNodes

populateRootNodes(): void
Returns void
Since
6.15.0 This method checks for any node that has no parent and is not in the rootNodes array, and adds the node there, if so.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:5057

removeAllFromScene

removeAllFromScene(): void
Removes all the assets in the container from the scene

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:5022

removeFromScene

removeFromScene(predicate?: Nullable<(entity: any) => boolean>): void
Removes assets in the container from the scene
Parameters
- Optionalpredicate: Nullable<(entity: any) => boolean>
  defines a predicate used to select which entity will be added (can be null)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:5027

Class AssetContainer

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AssetContainer

Properties

actionManagers

Deprecated

animationGroups

See

animations

cameras

See

effectLayers

geometries

layers

lensFlareSystems

lights

See

materials

See

meshes

morphTargetManagers

See

multiMaterials

See

particleSystems

See

postProcesses

proceduralTextures

reflectionProbes

rootNodes

scene

skeletons

See

sounds

textures

transformNodes

See

Accessors

environmentTexture

Returns Nullable<BaseTexture>

Parameters

Returns void

Methods

addAllAssetsToContainer

Parameters

Returns void

Since

addAllToScene

Returns void

addToScene

Parameters

Returns void

createRootMesh

Returns Mesh

dispose

Returns void

getCamerasByTags

Parameters

Returns Camera[]

getLightsByTags

Parameters

Returns Light[]

getMaterialsByTags

Parameters

Returns Material[]

getMeshesByTags

Parameters

Returns AbstractMesh[]

getNodes

Returns Node[]

getTransformNodesByTags

Parameters

`Optional`doNotInstantiate?: boolean | (node: Node) => boolean

`Optional`predicate?: (entity: any) => boolean