Options
All
  • Public
  • Public/Protected
  • All
Menu

Base class of the scene acting as a container for the different elements composing a scene. This class is dynamically extended by the different components of the scene increasing flexibility and reducing coupling

Hierarchy

Index

Constructors

Properties

actionManagers: AbstractActionManager[]

ActionManagers available on the scene.

deprecated
animationGroups: AnimationGroup[]

All of the animation groups added to this scene

see

https://doc.babylonjs.com/divingDeeper/animation/groupAnimations

animations: Animation[]

Gets a list of Animations associated with the scene

cameras: Camera[]

All of the cameras added to this scene

see

https://doc.babylonjs.com/babylon101/cameras

effectLayers: EffectLayer[]

The list of effect layers (highlights/glow) added to the scene

see

https://doc.babylonjs.com/how_to/highlight_layer

see

https://doc.babylonjs.com/how_to/glow_layer

geometries: Geometry[]

The list of geometries used in the scene.

layers: Layer[]

The list of layers (background and foreground) of the scene

lensFlareSystems: LensFlareSystem[]

The list of lens flare system added to the scene

see

https://doc.babylonjs.com/how_to/how_to_use_lens_flares

lights: Light[]

All of the lights added to this scene

see

https://doc.babylonjs.com/babylon101/lights

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/babylon101/materials

meshes: AbstractMesh[]

All of the (abstract) meshes added to this scene

morphTargetManagers: MorphTargetManager[]

The list of morph target managers added to the scene

see

https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh

multiMaterials: MultiMaterial[]

All of the multi-materials added to this scene

see

https://doc.babylonjs.com/how_to/multi_materials

particleSystems: IParticleSystem[]

All of the particle systems added to this scene

see

https://doc.babylonjs.com/babylon101/particles

postProcesses: PostProcess[]

The list of postprocesses added to the scene

prePassRenderer: Nullable<PrePassRenderer>

Gets or Sets the current prepass renderer associated to the scene.

proceduralTextures: ProceduralTexture[]

The list of procedural textures added to the scene

see

https://doc.babylonjs.com/how_to/how_to_use_procedural_textures

reflectionProbes: ReflectionProbe[]

The list of reflection probes added to the scene

see

https://doc.babylonjs.com/how_to/how_to_use_reflection_probes

rootNodes: Node[]

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

skeletons: Skeleton[]

The list of skeletons added to the scene

see

https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons

sounds: Nullable<Sound[]>

The list of sounds used in the scene.

subSurfaceConfiguration: Nullable<SubSurfaceConfiguration>

Gets or Sets the current prepass renderer associated to the scene.

textures: BaseTexture[]

Textures to keep.

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/how_to/transformnode

Accessors

  • 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>

  • 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

    Returns void

Methods

  • Adds the given effect layer to this scene

    Parameters

    • newEffectLayer: EffectLayer

      defines the effect layer to add

    Returns void

  • Adds the given lens flare system to this scene

    Parameters

    Returns void

  • Adds the given reflection probe to this scene.

    Parameters

    Returns void

  • disablePrePassRenderer(): void
  • Disables the prepass associated with the scene

    Returns void

  • disableSubSurfaceForPrePass(): void
  • Disables the subsurface effect for prepass

    Returns void

  • Enables the prepass and associates it with the scene

    Returns Nullable<PrePassRenderer>

    the PrePassRenderer

  • Enables the subsurface effect for prepass

    Returns Nullable<SubSurfaceConfiguration>

    the SubSurfaceConfiguration

  • Return a the first highlight layer of the scene with a given name.

    Parameters

    • name: string

      The name of the highlight layer to look for.

    Returns Nullable<GlowLayer>

    The highlight layer if found otherwise null.

  • Return a the first highlight layer of the scene with a given name.

    Parameters

    • name: string

      The name of the highlight layer to look for.

    Returns Nullable<HighlightLayer>

    The highlight layer if found otherwise null.

  • Gets a lens flare system using its Id

    deprecated

    Please use getLensFlareSystemById instead

    Parameters

    • id: string

      defines the Id to look for

    Returns Nullable<LensFlareSystem>

    the lens flare system or null if not found

  • Gets a lens flare system using its Id

    Parameters

    • id: string

      defines the Id to look for

    Returns Nullable<LensFlareSystem>

    the lens flare system or null if not found

  • Gets a lens flare system using its name

    Parameters

    • name: string

      defines the name to look for

    Returns Nullable<LensFlareSystem>

    the lens flare system or null if not found

  • Returns Node[]

    all meshes, lights, cameras, transformNodes and bones

  • Removes the given effect layer from this scene.

    Parameters

    • toRemove: EffectLayer

      defines the effect layer to remove

    Returns number

    the index of the removed effect layer

  • Removes the given lens flare system from this scene.

    Parameters

    Returns number

    The index of the removed lens flare system

  • Removes the given reflection probe from this scene.

    Parameters

    Returns number

    The index of the removed reflection probe

  • Adds n individual parser in the list of available ones

    Parameters

    Returns void

  • Adds a parser in the list of available ones

    Parameters

    • name: string

      Defines the name of the parser

    • parser: BabylonFileParser

      Defines the parser to add

    Returns void

  • Gets an individual parser from the list of available ones

    Parameters

    • name: string

      Defines the name of the parser

    Returns Nullable<IndividualBabylonFileParser>

    the requested parser or null

  • Gets a general parser from the list of available ones

    Parameters

    • name: string

      Defines the name of the parser

    Returns Nullable<BabylonFileParser>

    the requested parser or null

  • Parser json data and populate both a scene and its associated container object

    Parameters

    • jsonData: any

      Defines the data to parse

    • scene: Scene

      Defines the scene to parse the data for

    • container: AssetContainer

      Defines the container attached to the parsing sequence

    • rootUrl: string

      Defines the root url of the data

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Property
  • Method
  • Inherited constructor
  • Static method

Settings

Theme