Scene | Babylon.js API documentation

Class Scene

Represents a scene to be rendered by the engine.

See

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

Implements

Defined in .temp/typedoc/docdirectory/doc.d.ts:1973
Defined in .temp/typedoc/docdirectory/doc.d.ts:11223
Defined in .temp/typedoc/docdirectory/doc.d.ts:16012
Defined in .temp/typedoc/docdirectory/doc.d.ts:16705
Defined in .temp/typedoc/docdirectory/doc.d.ts:17038
Defined in .temp/typedoc/docdirectory/doc.d.ts:17403
Defined in .temp/typedoc/docdirectory/doc.d.ts:17553
Defined in .temp/typedoc/docdirectory/doc.d.ts:17907
Defined in .temp/typedoc/docdirectory/doc.d.ts:18135
Defined in .temp/typedoc/docdirectory/doc.d.ts:18273
Defined in .temp/typedoc/docdirectory/doc.d.ts:18422
Defined in .temp/typedoc/docdirectory/doc.d.ts:19119
Defined in .temp/typedoc/docdirectory/doc.d.ts:20541
Defined in .temp/typedoc/docdirectory/doc.d.ts:23800
Defined in .temp/typedoc/docdirectory/doc.d.ts:26495
Defined in .temp/typedoc/docdirectory/doc.d.ts:47318
Defined in .temp/typedoc/docdirectory/doc.d.ts:47428
Defined in .temp/typedoc/docdirectory/doc.d.ts:93987
Defined in .temp/typedoc/docdirectory/doc.d.ts:95020
Defined in .temp/typedoc/docdirectory/doc.d.ts:96114
Defined in .temp/typedoc/docdirectory/doc.d.ts:96316
Defined in .temp/typedoc/docdirectory/doc.d.ts:96527
Defined in .temp/typedoc/docdirectory/doc.d.ts:97601
Defined in .temp/typedoc/docdirectory/doc.d.ts:100140
Defined in .temp/typedoc/docdirectory/doc.d.ts:122200
Defined in .temp/typedoc/docdirectory/doc.d.ts:124440
Defined in .temp/typedoc/docdirectory/doc.d.ts:125466
Defined in .temp/typedoc/docdirectory/doc.d.ts:137222
Defined in .temp/typedoc/docdirectory/doc.d.ts:139452

Index

Constructors

constructor

Properties

Accessors

activeBonesPerfCounter activeCamera activeCameras activeParticlesPerfCounter afterCameraRender afterRender animatables animationPropertiesOverride beforeCameraRender beforeRender blockfreeActiveMeshesAndRenderingGroups blockMaterialDirtyMechanism clearColor defaultMaterial environmentTexture fogEnabled fogMode forcePointsCloud forceWireframe frameGraph frustumPlanes imageProcessingConfiguration isDisposed isLoading lightsEnabled meshUnderPointer onDispose performancePriority pointerDownFastCheck pointerDownPredicate pointerMoveFastCheck pointerMovePredicate pointerUpFastCheck pointerUpPredicate pointerX pointerY prePass renderingManager shadowsEnabled skeletonsEnabled skipFrustumClipping skipPointerDownPicking skipPointerMovePicking skipPointerUpPicking texturesEnabled totalActiveIndicesPerfCounter totalVerticesPerfCounter uid unTranslatedPointer useRightHandedSystem DoubleClickDelay DragMovementThreshold ExclusiveDoubleClickMode LongPressDelay

Methods

_loadFileAsync addActionManager addAnimation addAnimationGroup addCamera addEffectLayer addExternalData addGeometry addLensFlareSystem addLight addMaterial addMesh addMorphTargetManager addMultiMaterial addParticleSystem addPendingData addReflectionProbe addSkeleton addTexture addTransformNode animate attachControl beginAnimation beginDirectAnimation beginDirectHierarchyAnimation beginHierarchyAnimation beginWeightedAnimation bindEyePosition cleanCachedTextureBuffer clearCachedVertexData createDefaultCamera createDefaultCameraOrLight createDefaultEnvironment createDefaultLight createDefaultSkybox createDefaultVRExperience createDefaultXRExperienceAsync createOrUpdateSelectionOctree createPickingRay createPickingRayInCameraSpace createPickingRayInCameraSpaceToRef createPickingRayToRef createSceneUniformBuffer deleteCompoundImpostor detachControl disableDepthRenderer disableFluidRenderer disableGeometryBufferRenderer disableIblCdfGenerator disablePhysicsEngine disablePrePassRenderer disableSubSurfaceForPrePass dispose enableDepthRenderer enableFluidRenderer enableGeometryBufferRenderer enableIblCdfGenerator enablePhysics enablePrePassRenderer enableSubSurfaceForPrePass executeOnceBeforeRender executeWhenReady finalizeSceneUbo freeActiveMeshes freeProcessedMaterials freeRenderingGroups freezeActiveMeshes freezeMaterials getActiveBones getActiveIndices getActiveMeshes getActiveParticles getAllAnimatablesByTarget getAnimatableByTarget getAnimationGroupByName getAnimationRatio getAutoClearDepthStencilSetup getBoneById getBoneByID getBoneByName getBoundingBoxRenderer getCachedEffect getCachedMaterial getCachedVisibility getCameraById getCameraByID getCameraByName getCameraByUniqueId getCameraByUniqueID getCamerasByTags getClassName getEngine getExternalData getFrameGraphByName getFrameId getGeometries getGeometryById getGeometryByID getGlowLayerByName getHighlightLayerByName getInternalStep getLastEntryById getLastEntryByID getLastMaterialById getLastMaterialByID getLastMeshById getLastMeshByID getLastSkeletonById getLastSkeletonByID getLastTransformNodeById getLensFlareSystemById getLensFlareSystemByID getLensFlareSystemByName getLightById getLightByID getLightByName getLightByUniqueId getLightByUniqueID getLightsByTags getMaterialById getMaterialByID getMaterialByName getMaterialByTags getMaterialByUniqueId getMaterialByUniqueID getMeshById getMeshByID getMeshByName getMeshByUniqueId getMeshByUniqueID getMeshesById getMeshesByID getMeshesByTags getMorphTargetById getMorphTargetByName getMorphTargetManagerById getNodeById getNodeByID getNodeByName getNodes getOrAddExternalDataWithFactory getOutlineRenderer getParticleSystemById getParticleSystemByID getPerfCollector getPhysicsEngine getPointerOverMesh getPointerOverSprite getPostProcessByName getProjectionMatrix getRenderId getSceneUniformBuffer getSkeletonById getSkeletonByName getSkeletonByUniqueId getSoundByName getStepId getTextureByName getTextureByUniqueId getTextureByUniqueID getTotalVertices getTransformMatrix getTransformNodeById getTransformNodeByID getTransformNodeByName getTransformNodeByUniqueId getTransformNodeByUniqueID getTransformNodesById getTransformNodesByID getTransformNodesByTags getUniqueId getViewMatrix getWaitingItemsCount getWorldExtends incrementRenderId isActiveMesh isCachedMaterialInvalid isPhysicsEnabled isPointerCaptured isReady markAllMaterialsAsDirty multiPick multiPickSprite multiPickSpriteWithRay multiPickWithRay pick pickSprite pickSpriteWithRay pickWithBoundingInfo pickWithRay pushGeometry registerAfterRender registerBeforeRender removeActionManager removeAnimation removeAnimationGroup removeCamera removeEffectLayer removeExternalData removeGeometry removeLensFlareSystem removeLight removeMaterial removeMesh removeMorphTargetManager removeMultiMaterial removeParticleSystem removePendingData removeReflectionProbe removeSkeleton removeTexture removeTransformNode render resetCachedMaterial resetDrawCache resetLastAnimationTimeFrame setActiveCameraById setActiveCameraByID setActiveCameraByName setDefaultCandidateProviders setPointerOverMesh setPointerOverSprite setRenderingAutoClearDepthStencil setRenderingOrder setSceneUniformBuffer setStepId setTransformMatrix simulatePointerDown simulatePointerMove simulatePointerUp sortActiveAnimatables sortLightsByPriority stopAllAnimations stopAnimation switchActiveCamera unfreezeActiveMeshes unfreezeMaterials unregisterAfterRender unregisterBeforeRender updateTransformMatrix whenReadyAsync CollisionCoordinatorFactory DefaultMaterialFactory

Constructors

constructor

new Scene(engine: AbstractEngine, options?: SceneOptions): Scene
Creates a new Scene
Parameters
- engine: AbstractEngine
  defines the engine to use to render this scene
- Optionaloptions: SceneOptions
  defines the scene options
Returns Scene
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3101

Properties

_afterRenderTargetPostProcessStage

_afterRenderTargetPostProcessStage: Stage<RenderTargetStageAction>

Defines the actions happening just after the post processing on a render target

actionManager

actionManager: AbstractActionManager

Gets or sets the action manager associated with the scene

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions

actionManagers

actionManagers: AbstractActionManager[]

ActionManagers available on the scene.

ambientColor

ambientColor: Color3

Defines the color used to simulate the ambient color (Default is (0, 0, 0))

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

animationsEnabled

animationsEnabled: boolean

Gets or sets a boolean indicating if animations are enabled

animationTimeScale

animationTimeScale: number

Gets or sets a general scale for animation speed

See

https://www.babylonjs-playground.com/#IBU2W7#3

audioEnabled

audioEnabled: boolean

Gets or sets if audio support is enabled

See

https://doc.babylonjs.com/features/featuresDeepDive/audio/playingSoundsMusic

audioListenerPositionProvider

audioListenerPositionProvider: Nullable<() => Vector3>

Gets or sets custom audio listener position provider

See

https://doc.babylonjs.com/features/featuresDeepDive/audio/playingSoundsMusic

audioListenerRotationProvider

audioListenerRotationProvider: Nullable<() => Vector3>

Gets or sets custom audio listener rotation provider

See

https://doc.babylonjs.com/features/featuresDeepDive/audio/playingSoundsMusic

audioPositioningRefreshRate

audioPositioningRefreshRate: number

Gets or sets a refresh rate when using 3D audio positioning

autoClear

autoClear: boolean

Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame

autoClearDepthAndStencil

autoClearDepthAndStencil: boolean

Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame

cameras

cameras: Camera[]

All of the cameras added to this scene

See

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

cameraToUseForPointers

cameraToUseForPointers: Nullable<Camera>

Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position

clipPlane

clipPlane: Nullable<Plane>

Gets or sets the active clipplane 1

clipPlane2

clipPlane2: Nullable<Plane>

Gets or sets the active clipplane 2

clipPlane3

clipPlane3: Nullable<Plane>

Gets or sets the active clipplane 3

clipPlane4

clipPlane4: Nullable<Plane>

Gets or sets the active clipplane 4

clipPlane5

clipPlane5: Nullable<Plane>

Gets or sets the active clipplane 5

clipPlane6

clipPlane6: Nullable<Plane>

Gets or sets the active clipplane 6

collisionsEnabled

collisionsEnabled: boolean

Gets or sets a boolean indicating if collisions are enabled on this scene

See

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

constantlyUpdateMeshUnderPointer

constantlyUpdateMeshUnderPointer: boolean

Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated Please note that it requires to run a ray cast through the scene on every frame

customLODSelector

customLODSelector: (
mesh: AbstractMesh,
camera: Camera,
) => Nullable<AbstractMesh>

Gets or sets a user defined funtion to select LOD from a mesh and a camera. By default this function is undefined and Babylon.js will select LOD based on distance to camera

`Optional`customRenderFunction

customRenderFunction?: (
updateCameras: boolean,
ignoreAnimations: boolean,
) => void

If this function is defined it will take precedence over the standard render() function.

customRenderTargets

customRenderTargets: RenderTargetTexture[]

The list of user defined render targets added to the scene

debugLayer

debugLayer: DebugLayer

Gets the debug layer (aka Inspector) associated with the scene

See

https://doc.babylonjs.com/toolsAndResources/inspector

defaultCursor

defaultCursor: string

Defines the HTML default cursor to use (empty by default)

deltaTime

deltaTime: number

Gets the current delta time used by animation engine

depthPeelingRenderer

depthPeelingRenderer: Nullable<DepthPeelingRenderer>

The depth peeling renderer

disableOfflineSupportExceptionRules

disableOfflineSupportExceptionRules: RegExp[]

Use this array to add regular expressions used to disable offline support for specific urls

dispatchAllSubMeshesOfActiveMeshes

dispatchAllSubMeshesOfActiveMeshes: boolean

Gets or sets a boolean indicating that all submeshes of active meshes must be rendered Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)

doNotHandleCursors

doNotHandleCursors: boolean

Defines whether cursors are handled by the scene.

dumpNextRenderTargets

dumpNextRenderTargets: boolean

Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com

effectLayers

effectLayers: EffectLayer[]

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

See

environmentBRDFTexture

environmentBRDFTexture: BaseTexture

This is use to store the default BRDF lookup for PBR materials in your scene. It should only be one of the following (if not the default embedded one):

For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds The material properties need to be setup according to the type of texture in use.

environmentIntensity

environmentIntensity: number

Intensity of the environment (i.e. all indirect lighting) in all pbr material. This dims or reinforces the indirect lighting overall (reflection and diffuse). 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. Note that this is more of a debugging parameter and is not physically accurate. If you want to modify the intensity of the IBL texture, you should update iblIntensity instead.

fluidRenderer

fluidRenderer: Nullable<FluidRenderer>

Gets or Sets the fluid renderer associated to the scene.

fogColor

fogColor: Color3

Gets or sets the fog color to use

See

https://doc.babylonjs.com/features/featuresDeepDive/environment/environment_introduction#fog (Default is Color3(0.2, 0.2, 0.3))

fogDensity

fogDensity: number

Gets or sets the fog density to use

See

https://doc.babylonjs.com/features/featuresDeepDive/environment/environment_introduction#fog (Default is 0.1)

fogEnd

fogEnd: number

Gets or sets the fog end distance to use

See

https://doc.babylonjs.com/features/featuresDeepDive/environment/environment_introduction#fog (Default is 1000)

fogStart

fogStart: number

Gets or sets the fog start distance to use

See

https://doc.babylonjs.com/features/featuresDeepDive/environment/environment_introduction#fog (Default is 0)

forceShowBoundingBoxes

forceShowBoundingBoxes: boolean

Gets or sets a boolean indicating if all bounding boxes must be rendered

frameGraphs

frameGraphs: FrameGraph[]

List of frame graphs associated with the scene

gamepadManager

gamepadManager: GamepadManager

Gets the gamepad manager associated with the scene

See

https://doc.babylonjs.com/features/featuresDeepDive/input/gamepads

geometries

geometries: Geometry[]

The list of geometries used in the scene.

geometryBufferRenderer

geometryBufferRenderer: Nullable<GeometryBufferRenderer>

Gets or Sets the current geometry buffer associated to the scene.

getActiveMeshCandidates

getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>

Lambda returning the list of potentially active meshes.

getActiveSubMeshCandidates

getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>

Lambda returning the list of potentially active sub meshes.

getCollidingSubMeshCandidates

getCollidingSubMeshCandidates: (
mesh: AbstractMesh,
collider: Collider,
) => ISmartArrayLike<SubMesh>

Lambda returning the list of potentially colliding sub meshes.

getDeterministicFrameTime

getDeterministicFrameTime: () => number

User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode

Type declaration

- (): number
- Returns number
  the frame time

getIntersectingSubMeshCandidates

getIntersectingSubMeshCandidates: (
mesh: AbstractMesh,
localRay: Ray,
) => ISmartArrayLike<SubMesh>

Lambda returning the list of potentially intersecting sub meshes.

gravity

gravity: Vector3

Defines the gravity applied to this scene (used only for collisions)

See

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

headphone

headphone: boolean

Gets or sets if audio will be output to headphones

See

https://doc.babylonjs.com/features/featuresDeepDive/audio/playingSoundsMusic

hoverCursor

hoverCursor: string

Defines the HTML cursor to use when hovering over interactive elements

iblCdfGenerator

iblCdfGenerator: Nullable<IblCdfGenerator>

Gets or Sets the current CDF generator associated to the scene. The CDF (cumulative distribution function) generator creates CDF maps for a given IBL texture that can then be used for more efficient importance sampling.

iblIntensity

iblIntensity: number

Overall intensity of the IBL texture. This value is multiplied with the reflectionTexture.level value to calculate the final IBL intensity.

importedMeshesFiles

importedMeshesFiles: string[]

Gets the list of meshes imported to the scene through SceneLoader

layers

layers: Layer[]

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

lensFlaresEnabled

lensFlaresEnabled: boolean

Gets or sets a boolean indicating if lens flares are enabled on this scene

lensFlareSystems

lensFlareSystems: LensFlareSystem[]

The list of lens flare system added to the scene

See

https://doc.babylonjs.com/features/featuresDeepDive/environment/lenseFlare

lights

lights: Light[]

All of the lights added to this scene

See

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

loadingPluginName

loadingPluginName: string

Gets the name of the plugin used to load this scene (null by default)

mainSoundTrack

mainSoundTrack: SoundTrack

The main sound track played by the scene. It contains your primary collection of sounds.

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

metadata

metadata: any

Gets or sets user defined metadata

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

needsPreviousWorldMatrices

needsPreviousWorldMatrices: boolean

Flag indicating if we need to store previous matrices when rendering

offlineProvider

offlineProvider: IOfflineProvider

Gets or sets the current offline provider to use to store scene data

See

https://doc.babylonjs.com/features/featuresDeepDive/scene/optimizeCached

onActiveCameraChanged

onActiveCameraChanged: Observable<Scene>

An event triggered when the activeCamera property is updated

onActiveCamerasChanged

onActiveCamerasChanged: Observable<Scene>

An event triggered when the activeCameras property is updated

onAfterActiveMeshesEvaluationObservable

onAfterActiveMeshesEvaluationObservable: Observable<Scene>

An event triggered when active meshes evaluation is done

onAfterAnimationsObservable

onAfterAnimationsObservable: Observable<Scene>

An event triggered after animations processing

onAfterCameraRenderObservable

onAfterCameraRenderObservable: Observable<Camera>

An event triggered after rendering a camera This is triggered for the full rig Camera only unlike onAfterRenderCameraObservable

onAfterDrawPhaseObservable

onAfterDrawPhaseObservable: Observable<Scene>

An event triggered after draw calls have been sent

onAfterParticlesRenderingObservable

onAfterParticlesRenderingObservable: Observable<Scene>

An event triggered when particles rendering is done Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)

onAfterPhysicsObservable

onAfterPhysicsObservable: Observable<Scene>

An event triggered when physic simulation has been done

onAfterRenderCameraObservable

onAfterRenderCameraObservable: Observable<Camera>

An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera) This is triggered for each "sub" camera in a Camera Rig unlike onAfterCameraRenderObservable

onAfterRenderingGroupObservable

onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>

This Observable will be triggered after rendering each renderingGroup of each rendered camera. The RenderingGroupInfo class contains all the information about the context in which the observable is called If you wish to register an Observer only for a given set of renderingGroup, use the mask with a combination of the renderingGroup index elevated to the power of two (1 for renderingGroup 0, 2 for renderingrOup1, 4 for 2 and 8 for 3)

onAfterRenderObservable

onAfterRenderObservable: Observable<Scene>

An event triggered after rendering the scene

onAfterRenderTargetsRenderObservable

onAfterRenderTargetsRenderObservable: Observable<Scene>

An event triggered when render targets were rendered. Can happen multiple times per frame.

onAfterSpritesRenderingObservable

onAfterSpritesRenderingObservable: Observable<Scene>

An event triggered when sprites rendering is done Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)

onAfterStepObservable

onAfterStepObservable: Observable<Scene>

An event triggered after calculating deterministic simulation step

onAnimationFileImportedObservable

onAnimationFileImportedObservable: Observable<Scene>

This Observable will when an animation file has been imported into the scene.

onBeforeActiveMeshesEvaluationObservable

onBeforeActiveMeshesEvaluationObservable: Observable<Scene>

An event triggered when active meshes evaluation is about to start

onBeforeAnimationsObservable

onBeforeAnimationsObservable: Observable<Scene>

An event triggered before animating the scene

onBeforeCameraRenderObservable

onBeforeCameraRenderObservable: Observable<Camera>

An event triggered before rendering a camera

onBeforeDrawPhaseObservable

onBeforeDrawPhaseObservable: Observable<Scene>

An event triggered before draw calls are ready to be sent

onBeforeParticlesRenderingObservable

onBeforeParticlesRenderingObservable: Observable<Scene>

An event triggered when particles rendering is about to start Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)

onBeforePhysicsObservable

onBeforePhysicsObservable: Observable<Scene>

An event triggered when physic simulation is about to be run

onBeforeRenderingGroupObservable

onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>

This Observable will be triggered before rendering each renderingGroup of each rendered camera. The RenderingGroupInfo class contains all the information about the context in which the observable is called If you wish to register an Observer only for a given set of renderingGroup, use the mask with a combination of the renderingGroup index elevated to the power of two (1 for renderingGroup 0, 2 for renderingrOup1, 4 for 2 and 8 for 3)

onBeforeRenderObservable

onBeforeRenderObservable: Observable<Scene>

An event triggered before rendering the scene (right after animations and physics)

onBeforeRenderTargetsRenderObservable

onBeforeRenderTargetsRenderObservable: Observable<Scene>

An event triggered when render targets are about to be rendered Can happen multiple times per frame.

onBeforeSpritesRenderingObservable

onBeforeSpritesRenderingObservable: Observable<Scene>

An event triggered when sprites rendering is about to start Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)

onBeforeStepObservable

onBeforeStepObservable: Observable<Scene>

An event triggered before calculating deterministic simulation step

onCameraRemovedObservable

onCameraRemovedObservable: Observable<Camera>

An event triggered when a camera is removed

onClearColorChangedObservable

onClearColorChangedObservable: Observable<Color4>

Observable triggered when the performance priority is changed

onDataLoadedObservable

onDataLoadedObservable: Observable<Scene>

An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed

onDisposeObservable

onDisposeObservable: Observable<Scene>

An event triggered when the scene is disposed.

onEnvironmentTextureChangedObservable

onEnvironmentTextureChangedObservable: Observable<Nullable<BaseTexture>>

An event triggered when the environmentTexture is changed.

onGeometryRemovedObservable

onGeometryRemovedObservable: Observable<Geometry>

An event triggered when a geometry is removed

onKeyboardObservable

onKeyboardObservable: Observable<KeyboardInfo>

Observable event triggered each time an keyboard event is received from the hosting window

onLightRemovedObservable

onLightRemovedObservable: Observable<Light>

An event triggered when a light is removed

onMaterialRemovedObservable

onMaterialRemovedObservable: Observable<Material>

An event triggered when a material is removed

onMeshImportedObservable

onMeshImportedObservable: Observable<AbstractMesh>

This Observable will when a mesh has been imported into the scene.

onMeshRemovedObservable

onMeshRemovedObservable: Observable<AbstractMesh>

An event triggered when a mesh is removed

onMeshUnderPointerUpdatedObservable

onMeshUnderPointerUpdatedObservable: Observable<
{ mesh: Nullable<AbstractMesh>; pointerId: number },
>

An event triggered when the state of mesh under pointer, for a specific pointerId, changes.

onMultiMaterialRemovedObservable

onMultiMaterialRemovedObservable: Observable<MultiMaterial>

An event triggered when a multi material is removed

onNewCameraAddedObservable

onNewCameraAddedObservable: Observable<Camera>

An event triggered when a camera is created

onNewGeometryAddedObservable

onNewGeometryAddedObservable: Observable<Geometry>

An event triggered when a geometry is created

onNewLightAddedObservable

onNewLightAddedObservable: Observable<Light>

An event triggered when a light is created

onNewMaterialAddedObservable

onNewMaterialAddedObservable: Observable<Material>

An event triggered when a material is created

onNewMeshAddedObservable

onNewMeshAddedObservable: Observable<AbstractMesh>

An event triggered when a mesh is created

onNewMultiMaterialAddedObservable

onNewMultiMaterialAddedObservable: Observable<MultiMaterial>

An event triggered when a multi material is created

onNewSkeletonAddedObservable

onNewSkeletonAddedObservable: Observable<Skeleton>

An event triggered when a skeleton is created

onNewTextureAddedObservable

onNewTextureAddedObservable: Observable<BaseTexture>

An event triggered when a texture is created

onNewTransformNodeAddedObservable

onNewTransformNodeAddedObservable: Observable<TransformNode>

An event triggered when a transform node is created

`Optional`onPointerDown

onPointerDown?: (
    evt: IPointerEvent,
    pickInfo: PickingInfo,
    type: PointerEventTypes,
) => void

Callback called when a pointer down is detected

`Optional`onPointerMove

onPointerMove?: (
    evt: IPointerEvent,
    pickInfo: PickingInfo,
    type: PointerEventTypes,
) => void

Callback called when a pointer move is detected

onPointerObservable

onPointerObservable: Observable<PointerInfo>

Observable event triggered each time an input event is received from the rendering canvas

`Optional`onPointerPick

onPointerPick?: (evt: IPointerEvent, pickInfo: PickingInfo) => void

Callback called when a pointer pick is detected

`Optional`onPointerUp

onPointerUp?: (
    evt: IPointerEvent,
    pickInfo: Nullable<PickingInfo>,
    type: PointerEventTypes,
) => void

Callback called when a pointer up is detected

onPreKeyboardObservable

onPreKeyboardObservable: Observable<KeyboardInfoPre>

This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl() You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true

onPrePointerObservable

onPrePointerObservable: Observable<PointerInfoPre>

This observable event is triggered when any ponter event is triggered. It is registered during Scene.attachControl() and it is called BEFORE the 3D engine process anything (mesh/sprite picking for instance). You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true

onReadyObservable

onReadyObservable: Observable<Scene>

An event triggered when the scene is ready

onScenePerformancePriorityChangedObservable

onScenePerformancePriorityChangedObservable: Observable<
ScenePerformancePriority,
>

Observable triggered when the performance priority is changed

onSkeletonRemovedObservable

onSkeletonRemovedObservable: Observable<Skeleton>

An event triggered when a skeleton is removed

onTextureRemovedObservable

onTextureRemovedObservable: Observable<BaseTexture>

An event triggered when a texture is removed

onTransformNodeRemovedObservable

onTransformNodeRemovedObservable: Observable<TransformNode>

An event triggered when a transform node is removed

particlesEnabled

particlesEnabled: boolean

Gets or sets a boolean indicating if particles are enabled on this scene

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

physicsEnabled

physicsEnabled: boolean

Gets or sets a boolean indicating if physic engines are enabled on this scene

pointerDownTrianglePredicate

pointerDownTrianglePredicate:
| undefined
| (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean

Gets or sets a predicate used to select candidate faces for a pointer down event

pointerMoveTrianglePredicate

pointerMoveTrianglePredicate:
| undefined
| (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean

Gets or sets a predicate used to select candidate faces for a pointer move event

pointerUpTrianglePredicate

pointerUpTrianglePredicate:
| undefined
| (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean

Gets or sets a predicate used to select candidate faces for a pointer up event

postProcesses

postProcesses: PostProcess[]

The list of postprocesses added to the scene

postProcessesEnabled

postProcessesEnabled: boolean

Gets or sets a boolean indicating if postprocesses are enabled on this scene

postProcessManager

postProcessManager: PostProcessManager

Gets the current postprocess manager

`Readonly`postProcessRenderPipelineManager

postProcessRenderPipelineManager: PostProcessRenderPipelineManager

Gets the postprocess render pipeline manager

See

prePassRenderer

prePassRenderer: Nullable<PrePassRenderer>

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

preventDefaultOnPointerDown

preventDefaultOnPointerDown: boolean

This is used to call preventDefault() on pointer down in order to block unwanted artifacts like system double clicks

preventDefaultOnPointerUp

preventDefaultOnPointerUp: boolean

This is used to call preventDefault() on pointer up in order to block unwanted artifacts like system double clicks

probesEnabled

probesEnabled: boolean

Gets or sets a boolean indicating if probes are enabled on this scene

proceduralTextures

proceduralTextures: ProceduralTexture[]

The list of procedural textures added to the scene

See

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

proceduralTexturesEnabled

proceduralTexturesEnabled: boolean

Gets or sets a boolean indicating if procedural textures are enabled on this scene

reflectionProbes

reflectionProbes: ReflectionProbe[]

The list of reflection probes added to the scene

See

https://doc.babylonjs.com/features/featuresDeepDive/environment/reflectionProbes

renderTargetsEnabled

renderTargetsEnabled: boolean

Gets or sets a boolean indicating if render targets are enabled on this scene

requireLightSorting

requireLightSorting: boolean

Gets or sets a boolean indicating if lights must be sorted by priority (off by default) This is useful if there are more lights that the maximum simulteanous authorized

reservedDataStore

reservedDataStore: any

For internal use only. Please do not use.

rootNodes

rootNodes: Node[]

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

selectionOctree

selectionOctree: Octree<AbstractMesh>

Gets the octree used to boost mesh selection (picking)

See

https://doc.babylonjs.com/features/featuresDeepDive/scene/optimizeOctrees

simplificationQueue

simplificationQueue: SimplificationQueue

Gets or sets the simplification queue attached to the scene

See

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

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 used in the scene.

soundTracks

soundTracks: Nullable<SoundTrack[]>

The list of sound tracks added to the scene

See

https://doc.babylonjs.com/features/featuresDeepDive/audio/playingSoundsMusic

`Optional`spriteManagers

spriteManagers?: ISpriteManager[]

All of the sprite managers added to this scene

See

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

spritesEnabled

spritesEnabled: boolean

Gets or sets a boolean indicating if sprites are enabled on this scene

subSurfaceConfiguration

subSurfaceConfiguration: Nullable<SubSurfaceConfiguration>

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

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

useConstantAnimationDeltaTime

useConstantAnimationDeltaTime: boolean

Gets or sets a boolean indicating if a constant deltatime has to be used This is mostly useful for testing purposes when you do not want the animations to scale with the framerate

useDelayedTextureLoading

useDelayedTextureLoading: boolean

Defines if texture loading must be delayed If true, textures will only be loaded when they need to be rendered

useOrderIndependentTransparency

useOrderIndependentTransparency: boolean

Flag to indicate if we want to use order independent transparency, despite the performance hit

`Static` `Readonly`FOGMODE_EXP

FOGMODE_EXP: number

The fog density is following an exponential function

`Static` `Readonly`FOGMODE_EXP2

FOGMODE_EXP2: number

The fog density is following an exponential function faster than FOGMODE_EXP

`Static` `Readonly`FOGMODE_LINEAR

FOGMODE_LINEAR: number

The fog density is following a linear function.

`Static` `Readonly`FOGMODE_NONE

FOGMODE_NONE: number

The fog is deactivated

`Static`MaxDeltaTime

MaxDeltaTime: number

Gets or sets the maximum deltatime when deterministic lock step is enabled

See

https://doc.babylonjs.com/features/featuresDeepDive/animation/advanced_animations#deterministic-lockstep

`Static`MinDeltaTime

MinDeltaTime: number

Gets or sets the minimum deltatime when deterministic lock step is enabled

See

https://doc.babylonjs.com/features/featuresDeepDive/animation/advanced_animations#deterministic-lockstep

Accessors

activeBonesPerfCounter

get activeBonesPerfCounter(): PerfCounter
Gets the performance counter for active bones

Returns PerfCounter
See
https://doc.babylonjs.com/features/featuresDeepDive/scene/optimize_your_scene#instrumentation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3204

activeCamera

get activeCamera(): Nullable<Camera>
Gets or sets the current active camera

Returns Nullable<Camera>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2748
set activeCamera(value: Nullable<Camera>): void
Parameters
- value: Nullable<Camera>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2749

activeCameras

get activeCameras(): Nullable<Camera[]>
All of the active cameras added to this scene.

Returns Nullable<Camera[]>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2743
set activeCameras(cameras: Nullable<Camera[]>): void
Parameters
- cameras: Nullable<Camera[]>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2744

activeParticlesPerfCounter

get activeParticlesPerfCounter(): PerfCounter
Gets the performance counter for active particles

Returns PerfCounter
See
https://doc.babylonjs.com/features/featuresDeepDive/scene/optimize_your_scene#instrumentation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3194

afterCameraRender

set afterCameraRender(callback: () => void): void
Sets a function to be executed after rendering a camera
Parameters
- callback: () => void
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2368

afterRender

set afterRender(callback: Nullable<() => void>): void
Sets a function to be executed after rendering this scene
Parameters
- callback: Nullable<() => void>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2333

animatables

get animatables(): Animatable[]
Gets all animatable attached to the scene

Returns Animatable[]
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3344

animationPropertiesOverride

get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>
Gets or sets the animation properties override

Returns Nullable<AnimationPropertiesOverride>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2258
set animationPropertiesOverride(
value: Nullable<AnimationPropertiesOverride>,
): void
Parameters
- value: Nullable<AnimationPropertiesOverride>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2259

beforeCameraRender

set beforeCameraRender(callback: () => void): void
Sets a function to be executed before rendering a camera
Parameters
- callback: () => void
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2360

beforeRender

set beforeRender(callback: Nullable<() => void>): void
Sets a function to be executed before rendering this scene
Parameters
- callback: Nullable<() => void>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2321

blockfreeActiveMeshesAndRenderingGroups

get blockfreeActiveMeshesAndRenderingGroups(): boolean
Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance when disposing several meshes in a row or a hierarchy of meshes. When used, it is the responsibility of the user to blockfreeActiveMeshesAndRenderingGroups back to false.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3890
set blockfreeActiveMeshesAndRenderingGroups(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3891

blockMaterialDirtyMechanism

get blockMaterialDirtyMechanism(): boolean
Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync)

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4209
set blockMaterialDirtyMechanism(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4210

clearColor

get clearColor(): Color4
Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))

Returns Color4
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2034
set clearColor(value: Color4): void
Parameters
- value: Color4
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2035

defaultMaterial

get defaultMaterial(): Material
The default material used on meshes when no material is affected

Returns Material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2754
set defaultMaterial(value: Material): void
The default material used on meshes when no material is affected
Parameters
- value: Material
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2756

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>
Implementation of IAssetContainer.environmentTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2211
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 set here than in all the materials.
Parameters
- value: Nullable<BaseTexture>
Returns void
Implementation of IAssetContainer.environmentTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2217

fogEnabled

get fogEnabled(): boolean
Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2682
set fogEnabled(value: boolean): void
Gets or sets a boolean indicating if fog is enabled on this scene
Parameters
- value: boolean
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/environment/environment_introduction#fog (Default is true)
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2681

fogMode

get fogMode(): number
Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2695
set fogMode(value: number): void
Gets or sets the fog mode to use
Parameters
- value: number
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/environment/environment_introduction#fog

mode value

FOGMODE_NONE 0

FOGMODE_EXP 1

FOGMODE_EXP2 2

FOGMODE_LINEAR 3
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2694

mode	value
FOGMODE_NONE	0
FOGMODE_EXP	1
FOGMODE_EXP2	2
FOGMODE_LINEAR	3

forcePointsCloud

get forcePointsCloud(): boolean
Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2101
set forcePointsCloud(value: boolean): void
Gets or sets a boolean indicating if all rendering must be done in point cloud
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2100

forceWireframe

get forceWireframe(): boolean
Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2089
set forceWireframe(value: boolean): void
Gets or sets a boolean indicating if all rendering must be done in wireframe
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2088

frameGraph

get frameGraph(): Nullable<FrameGraph>
Gets or sets the frame graph used to render the scene. If set, the scene will use the frame graph to render the scene instead of the default render loop.

Returns Nullable<FrameGraph>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2768
set frameGraph(value: Nullable<FrameGraph>): void
Parameters
- value: Nullable<FrameGraph>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2769

frustumPlanes

get frustumPlanes(): Plane[]
Gets the list of frustum planes (built from the active camera)

Returns Plane[]
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2928

imageProcessingConfiguration

get imageProcessingConfiguration(): ImageProcessingConfiguration
Default image processing configuration used either in the rendering Forward main pass or through the imageProcessingPostProcess if present. As in the majority of the scene they are the same (exception for multi camera), this is easier to reference from here than from all the materials and post process.

No setter as we it is a shared configuration, you can set the values instead.

Returns ImageProcessingConfiguration
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2073

isDisposed

get isDisposed(): boolean
Gets if the scene is already disposed

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4010

isLoading

get isLoading(): boolean
Returns a boolean indicating if the scene is still loading data

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3324

lightsEnabled

get lightsEnabled(): boolean
Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2739
set lightsEnabled(value: boolean): void
Gets or sets a boolean indicating if lights are enabled on this scene
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2738

meshUnderPointer

get meshUnderPointer(): Nullable<AbstractMesh>
Gets the mesh that is currently under the pointer

Returns Nullable<AbstractMesh>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3126

onDispose

set onDispose(callback: () => void): void
Sets a function to be executed when this scene is disposed.
Parameters
- callback: () => void
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2314

performancePriority

get performancePriority(): ScenePerformancePriority
Gets or sets a value indicating how to treat performance relatively to ease of use and backward compatibility

Returns ScenePerformancePriority
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2082
set performancePriority(value: ScenePerformancePriority): void
Parameters
- value: ScenePerformancePriority
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2083

pointerDownFastCheck

get pointerDownFastCheck(): boolean
Gets or sets a predicate used to select candidate meshes for a pointer down event

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2546
set pointerDownFastCheck(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2547

pointerDownPredicate

get pointerDownPredicate(): (Mesh: AbstractMesh) => boolean
Gets or sets a predicate used to select candidate meshes for a pointer down event

Returns (Mesh: AbstractMesh) => boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2531
set pointerDownPredicate(value: (Mesh: AbstractMesh) => boolean): void
Parameters
- value: (Mesh: AbstractMesh) => boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2532

pointerMoveFastCheck

get pointerMoveFastCheck(): boolean
Gets or sets a predicate used to select candidate meshes for a pointer move event

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2556
set pointerMoveFastCheck(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2557

pointerMovePredicate

get pointerMovePredicate(): (Mesh: AbstractMesh) => boolean
Gets or sets a predicate used to select candidate meshes for a pointer move event

Returns (Mesh: AbstractMesh) => boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2541
set pointerMovePredicate(value: (Mesh: AbstractMesh) => boolean): void
Parameters
- value: (Mesh: AbstractMesh) => boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2542

pointerUpFastCheck

get pointerUpFastCheck(): boolean
Gets or sets a predicate used to select candidate meshes for a pointer up event

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2551
set pointerUpFastCheck(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2552

pointerUpPredicate

get pointerUpPredicate(): (Mesh: AbstractMesh) => boolean
Gets or sets a predicate used to select candidate meshes for a pointer up event

Returns (Mesh: AbstractMesh) => boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2536
set pointerUpPredicate(value: (Mesh: AbstractMesh) => boolean): void
Parameters
- value: (Mesh: AbstractMesh) => boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2537

pointerX

get pointerX(): number
Gets or sets the current on-screen X position of the pointer

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3130
set pointerX(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3131

pointerY

get pointerY(): number
Gets or sets the current on-screen Y position of the pointer

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3135
set pointerY(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3136

prePass

get prePass(): boolean
Flag indicating that the frame buffer binding is handled by another component

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2723

renderingManager

get renderingManager(): RenderingManager
Gets the scene's rendering manager

Returns RenderingManager
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2912

shadowsEnabled

get shadowsEnabled(): boolean
Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2733
set shadowsEnabled(value: boolean): void
Gets or sets a boolean indicating if shadows are enabled on this scene
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2732

skeletonsEnabled

get skeletonsEnabled(): boolean
Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2791
set skeletonsEnabled(value: boolean): void
Gets or sets a boolean indicating if skeletons are enabled on this scene
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2790

skipFrustumClipping

get skipFrustumClipping(): boolean
Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2095
set skipFrustumClipping(value: boolean): void
Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2094

skipPointerDownPicking

get skipPointerDownPicking(): boolean
Gets or sets a boolean indicating if the user want to entirely skip the picking phase when a pointer down event occurs.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2566
set skipPointerDownPicking(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2567

skipPointerMovePicking

get skipPointerMovePicking(): boolean
Gets or sets a boolean indicating if the user want to entirely skip the picking phase when a pointer move event occurs.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2561
set skipPointerMovePicking(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2562

skipPointerUpPicking

get skipPointerUpPicking(): boolean
Gets or sets a boolean indicating if the user want to entirely skip the picking phase when a pointer up event occurs. Off by default.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2571
set skipPointerUpPicking(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2572

texturesEnabled

get texturesEnabled(): boolean
Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2762
set texturesEnabled(value: boolean): void
Gets or sets a boolean indicating if textures are enabled on this scene
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2761

totalActiveIndicesPerfCounter

get totalActiveIndicesPerfCounter(): PerfCounter
Gets the performance counter for active indices

Returns PerfCounter
See
https://doc.babylonjs.com/features/featuresDeepDive/scene/optimize_your_scene#instrumentation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3184

totalVerticesPerfCounter

get totalVerticesPerfCounter(): PerfCounter
Gets the performance counter for total vertices

Returns PerfCounter
See
https://doc.babylonjs.com/features/featuresDeepDive/scene/optimize_your_scene#instrumentation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3174

uid

get uid(): string
Return a unique id as a string which can serve as an identifier for the scene

Returns string
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3850

unTranslatedPointer

get unTranslatedPointer(): Vector2
Gets the pointer coordinates without any translation (ie. straight out of the pointer event)

Returns Vector2
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2605

useRightHandedSystem

get useRightHandedSystem(): boolean
Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2653
set useRightHandedSystem(value: boolean): void
Gets or sets a boolean indicating if the scene must use right-handed coordinates system
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2652

`Static`DoubleClickDelay

get DoubleClickDelay(): number
Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2619
set DoubleClickDelay(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2620

`Static`DragMovementThreshold

get DragMovementThreshold(): number
Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2609
set DragMovementThreshold(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2610

`Static`ExclusiveDoubleClickMode

get ExclusiveDoubleClickMode(): boolean
If you need to check double click without raising a single click at first click, enable this flag

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2622
set ExclusiveDoubleClickMode(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2623

`Static`LongPressDelay

get LongPressDelay(): number
Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2614
set LongPressDelay(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2615

Methods

_loadFileAsync

_loadFileAsync(
    fileOrUrl: string | File,
    onProgress?: (data: any) => void,
    useOfflineSupport?: boolean,
    useArrayBuffer?: false,
    onOpened?: (request: WebRequest) => void,
): Promise<string>
Parameters
- fileOrUrl: string | File
- OptionalonProgress: (data: any) => void
- OptionaluseOfflineSupport: boolean
- OptionaluseArrayBuffer: false
- OptionalonOpened: (request: WebRequest) => void
Returns Promise<string>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4221
_loadFileAsync(
    fileOrUrl: string | File,
    onProgress?: (data: any) => void,
    useOfflineSupport?: boolean,
    useArrayBuffer?: true,
    onOpened?: (request: WebRequest) => void,
): Promise<ArrayBuffer>
Parameters
- fileOrUrl: string | File
- OptionalonProgress: (data: any) => void
- OptionaluseOfflineSupport: boolean
- OptionaluseArrayBuffer: true
- OptionalonOpened: (request: WebRequest) => void
Returns Promise<ArrayBuffer>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4222

addActionManager

addActionManager(newActionManager: AbstractActionManager): void
Adds the given action manager to this scene
Parameters
- newActionManager: AbstractActionManager
  The action manager to add
Returns void
Deprecated
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3551

addAnimation

addAnimation(newAnimation: Animation): void
Adds the given animation to this scene
Parameters
- newAnimation: Animation
  The animation to add
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3520

addAnimationGroup

addAnimationGroup(newAnimationGroup: AnimationGroup): void
Adds the given animation group to this scene.
Parameters
- newAnimationGroup: AnimationGroup
  The animation group to add
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3525

addCamera

addCamera(newCamera: Camera): void
Adds the given camera to this scene
Parameters
- newCamera: Camera
  The camera to add
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3505

addEffectLayer

addEffectLayer(newEffectLayer: EffectLayer): void
Adds the given effect layer to this scene
Parameters
- newEffectLayer: EffectLayer
  defines the effect layer to add
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:96538

addExternalData

addExternalData<T extends object>(key: string, data: T): boolean
Add an externally attached data from its key. This method call will fail and return false, if such key already exists. If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
Type Parameters
- T extends object
Parameters
- key: string
  the unique key that identifies the data
- data: T
  the data object to associate to the key for this Engine instance
Returns boolean
true if no such key were already present and the data was added successfully, false otherwise
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3859

addGeometry

addGeometry(newGeometry: Geometry): void
Adds the given geometry to this scene
Parameters
- newGeometry: Geometry
  The geometry to add
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3545

addLensFlareSystem

addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void
Adds the given lens flare system to this scene
Parameters
- newLensFlareSystem: LensFlareSystem
  The lens flare system to add
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:95031

addLight

addLight(newLight: Light): void
Adds the given light to this scene
Parameters
- newLight: Light
  The light to add
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3496

addMaterial

addMaterial(newMaterial: Material): void
Adds the given material to this scene
Parameters
- newMaterial: Material
  The material to add
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3535

addMesh

addMesh(newMesh: AbstractMesh, recursive?: boolean): void
Add a mesh to the list of scene's meshes
Parameters
- newMesh: AbstractMesh
  defines the mesh to add
- Optionalrecursive: boolean
  if all child meshes should also be added to the scene
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3399

addMorphTargetManager

addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void
Adds the given morph target to this scene
Parameters
- newMorphTargetManager: MorphTargetManager
  The morph target to add
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3540

addMultiMaterial

addMultiMaterial(newMultiMaterial: MultiMaterial): void
Adds the given multi-material to this scene
Parameters
- newMultiMaterial: MultiMaterial
  The multi-material to add
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3530

addParticleSystem

addParticleSystem(newParticleSystem: IParticleSystem): void
Adds the given particle system to this scene
Parameters
- newParticleSystem: IParticleSystem
  The particle system to add
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3515

addPendingData

addPendingData(data: any): void
This function can help adding any object to the list of data awaited to be ready in order to check for a complete scene loading.
Parameters
- data: any
  defines the object to wait for
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3310

addReflectionProbe

addReflectionProbe(newReflectionProbe: ReflectionProbe): void
Adds the given reflection probe to this scene.
Parameters
- newReflectionProbe: ReflectionProbe
  The reflection probe to add
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:20557

addSkeleton

addSkeleton(newSkeleton: Skeleton): void
Adds the given skeleton to this scene
Parameters
- newSkeleton: Skeleton
  The skeleton to add
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3510

addTexture

addTexture(newTexture: BaseTexture): void
Adds the given texture to this scene.
Parameters
- newTexture: BaseTexture
  The texture to add
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3556

addTransformNode

addTransformNode(newTransformNode: TransformNode): void
Add a transform node to the list of scene's transform nodes
Parameters
- newTransformNode: TransformNode
  defines the transform node to add
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3411

animate

animate(): void
Execute all animations (for a frame)

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

attachControl

attachControl(
    attachUp?: boolean,
    attachDown?: boolean,
    attachMove?: boolean,
): void
Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
Parameters
- OptionalattachUp: boolean
  defines if you want to attach events to pointerup
- OptionalattachDown: boolean
  defines if you want to attach events to pointerdown
- OptionalattachMove: boolean
  defines if you want to attach events to pointermove
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3265

beginAnimation

beginAnimation(
    target: any,
    from: number,
    to: number,
    loop?: boolean,
    speedRatio?: number,
    onAnimationEnd?: () => void,
    animatable?: Animatable,
    stopCurrent?: boolean,
    targetMask?: (target: any) => boolean,
    onAnimationLoop?: () => void,
    isAdditive?: boolean,
): Animatable
Will start the animation sequence of a given target

Note that it is possible that the value(s) of speedRatio from and to will be changed if the animation is inverted
Parameters
- target: any
  defines the target
- from: number
  defines from which frame should animation start
- to: number
  defines until which frame should animation run.
- Optionalloop: boolean
  defines if the animation loops
- OptionalspeedRatio: number
  defines the speed in which to run the animation (1.0 by default)
- OptionalonAnimationEnd: () => void
  defines the function to be executed when the animation ends
- Optionalanimatable: Animatable
  defines an animatable object. If not provided a new one will be created from the given params
- OptionalstopCurrent: boolean
  defines if the current animations must be stopped first (true by default)
- OptionaltargetMask: (target: any) => boolean
  defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
- OptionalonAnimationLoop: () => void
  defines the callback to call when an animation loops
- OptionalisAdditive: boolean
  defines whether the animation should be evaluated additively (false by default)
Returns Animatable
the animatable object created for this animation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139490

beginDirectAnimation

beginDirectAnimation(
    target: any,
    animations: Animation[],
    from: number,
    to: number,
    loop?: boolean,
    speedRatio?: number,
    onAnimationEnd?: () => void,
    onAnimationLoop?: () => void,
    isAdditive?: boolean,
): Animatable
Begin a new animation on a given node

Note that it is possible that the value(s) of speedRatio from and to will be changed if the animation is inverted
Parameters
- target: any
  defines the target where the animation will take place
- animations: Animation[]
  defines the list of animations to start
- from: number
  defines the initial value
- to: number
  defines the final value
- Optionalloop: boolean
  defines if you want animation to loop (off by default)
- OptionalspeedRatio: number
  defines the speed ratio to apply to all animations
- OptionalonAnimationEnd: () => void
  defines the callback to call when an animation ends (will be called once per node)
- OptionalonAnimationLoop: () => void
  defines the callback to call when an animation loops
- OptionalisAdditive: boolean
  defines whether the animation should be evaluated additively (false by default)
Returns Animatable
the list of created animatables
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139523

beginDirectHierarchyAnimation

beginDirectHierarchyAnimation(
    target: Node,
    directDescendantsOnly: boolean,
    animations: Animation[],
    from: number,
    to: number,
    loop?: boolean,
    speedRatio?: number,
    onAnimationEnd?: () => void,
    onAnimationLoop?: () => void,
    isAdditive?: boolean,
): Animatable[]
Begin a new animation on a given node and its hierarchy
Parameters
- target: Node
  defines the root node where the animation will take place
- directDescendantsOnly: boolean
  if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
- animations: Animation[]
  defines the list of animations to start
- from: number
  defines the initial value
- to: number
  defines the final value
- Optionalloop: boolean
  defines if you want animation to loop (off by default)
- OptionalspeedRatio: number
  defines the speed ratio to apply to all animations
- OptionalonAnimationEnd: () => void
  defines the callback to call when an animation ends (will be called once per node)
- OptionalonAnimationLoop: () => void
  defines the callback to call when an animation loops
- OptionalisAdditive: boolean
  defines whether the animation should be evaluated additively (false by default)
Returns Animatable[]
the list of animatables created for all nodes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139538

beginHierarchyAnimation

beginHierarchyAnimation(
    target: any,
    directDescendantsOnly: boolean,
    from: number,
    to: number,
    loop?: boolean,
    speedRatio?: number,
    onAnimationEnd?: () => void,
    animatable?: Animatable,
    stopCurrent?: boolean,
    targetMask?: (target: any) => boolean,
    onAnimationLoop?: () => void,
    isAdditive?: boolean,
): Animatable[]
Will start the animation sequence of a given target and its hierarchy
Parameters
- target: any
  defines the target
- directDescendantsOnly: boolean
  if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
- from: number
  defines from which frame should animation start
- to: number
  defines until which frame should animation run.
- Optionalloop: boolean
  defines if the animation loops
- OptionalspeedRatio: number
  defines the speed in which to run the animation (1.0 by default)
- OptionalonAnimationEnd: () => void
  defines the function to be executed when the animation ends
- Optionalanimatable: Animatable
  defines an animatable object. If not provided a new one will be created from the given params
- OptionalstopCurrent: boolean
  defines if the current animations must be stopped first (true by default)
- OptionaltargetMask: (target: any) => boolean
  defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
- OptionalonAnimationLoop: () => void
  defines the callback to call when an animation loops
- OptionalisAdditive: boolean
  defines whether the animation should be evaluated additively (false by default)
Returns Animatable[]
the list of created animatables
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139507

beginWeightedAnimation

beginWeightedAnimation(
    target: any,
    from: number,
    to: number,
    weight: number,
    loop?: boolean,
    speedRatio?: number,
    onAnimationEnd?: () => void,
    animatable?: Animatable,
    targetMask?: (target: any) => boolean,
    onAnimationLoop?: () => void,
    isAdditive?: boolean,
): Animatable
Will start the animation sequence of a given target
Parameters
- target: any
  defines the target
- from: number
  defines from which frame should animation start
- to: number
  defines until which frame should animation run.
- weight: number
  defines the weight to apply to the animation (1.0 by default)
- Optionalloop: boolean
  defines if the animation loops
- OptionalspeedRatio: number
  defines the speed in which to run the animation (1.0 by default)
- OptionalonAnimationEnd: () => void
  defines the function to be executed when the animation ends
- Optionalanimatable: Animatable
  defines an animatable object. If not provided a new one will be created from the given params
- OptionaltargetMask: (target: any) => boolean
  defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
- OptionalonAnimationLoop: () => void
  defines the callback to call when an animation loops
- OptionalisAdditive: boolean
  defines whether the animation should be evaluated additively (false by default)
Returns Animatable
the animatable object created for this animation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139472

bindEyePosition

bindEyePosition(
    effect: Nullable<Effect>,
    variableName?: string,
    isVector3?: boolean,
): Vector4
Bind the current view position to an effect.
Parameters
- effect: Nullable<Effect>
  The effect to be bound
- OptionalvariableName: string
  name of the shader variable that will hold the eye position
- OptionalisVector3: boolean
  true to indicates that variableName is a Vector3 and not a Vector4
Returns Vector4
the computed eye position
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2631

cleanCachedTextureBuffer

cleanCachedTextureBuffer(): void
This function will remove the local cached buffer data from texture. It will save memory but will prevent the texture from being rebuilt

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

clearCachedVertexData

clearCachedVertexData(): void
Call this function to reduce memory footprint of the scene. Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)

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

createDefaultCamera

createDefaultCamera(
    createArcRotateCamera?: boolean,
    replace?: boolean,
    attachCameraControls?: boolean,
): void
Creates a default camera for the scene.
Parameters
- OptionalcreateArcRotateCamera: boolean
  has the default false which creates a free camera, when true creates an arc rotate camera
- Optionalreplace: boolean
  has default false, when true replaces the active camera in the scene
- OptionalattachCameraControls: boolean
  has default false, when true attaches camera controls to the canvas.
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/scene/fastBuildWorld#create-default-camera
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97615

createDefaultCameraOrLight

createDefaultCameraOrLight(
    createArcRotateCamera?: boolean,
    replace?: boolean,
    attachCameraControls?: boolean,
): void
Creates a default camera and a default light.
Parameters
- OptionalcreateArcRotateCamera: boolean
  has the default false which creates a free camera, when true creates an arc rotate camera
- Optionalreplace: boolean
  has the default false, when true replaces the active camera/light in the scene
- OptionalattachCameraControls: boolean
  has the default false, when true attaches camera controls to the canvas.
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/scene/fastBuildWorld#create-default-camera-or-light
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97623

createDefaultEnvironment

createDefaultEnvironment(
options?: Partial<IEnvironmentHelperOptions>,
): Nullable<EnvironmentHelper>
Creates a new environment
Parameters
- Optionaloptions: Partial<IEnvironmentHelperOptions>
  defines the options you can use to configure the environment
Returns Nullable<EnvironmentHelper>
the new EnvironmentHelper

See
https://doc.babylonjs.com/features/featuresDeepDive/scene/fastBuildWorld#create-default-environment
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97641

createDefaultLight

createDefaultLight(replace?: boolean): void
Creates a default light for the scene.
Parameters
- Optionalreplace: boolean
  has the default false, when true replaces the existing lights in the scene with a hemispheric light
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/scene/fastBuildWorld#create-default-light
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97607

createDefaultSkybox

createDefaultSkybox(
    environmentTexture?: BaseTexture,
    pbr?: boolean,
    scale?: number,
    blur?: number,
    setGlobalEnvTexture?: boolean,
): Nullable<Mesh>
Creates a new sky box
Parameters
- OptionalenvironmentTexture: BaseTexture
  defines the texture to use as environment texture
- Optionalpbr: boolean
  has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
- Optionalscale: number
  defines the overall scale of the skybox
- Optionalblur: number
  is only available when pbr is true, default is 0, no blur, maximum value is 1
- OptionalsetGlobalEnvTexture: boolean
  has default true indicating that scene.environmentTexture must match the current skybox texture
Returns Nullable<Mesh>
a new mesh holding the sky box

See
https://doc.babylonjs.com/features/featuresDeepDive/scene/fastBuildWorld#create-default-skybox
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97634

createDefaultVRExperience

createDefaultVRExperience(
webVROptions?: VRExperienceHelperOptions,
): VRExperienceHelper
Creates a new VREXperienceHelper
Parameters
- OptionalwebVROptions: VRExperienceHelperOptions
  defines the options used to create the new VREXperienceHelper
Returns VRExperienceHelper
a new VREXperienceHelper

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

Deprecated
Please use createDefaultXRExperienceAsync instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97649

createDefaultXRExperienceAsync

createDefaultXRExperienceAsync(
options?: WebXRDefaultExperienceOptions,
): Promise<WebXRDefaultExperience>
Creates a new WebXRDefaultExperience
Parameters
- Optionaloptions: WebXRDefaultExperienceOptions
  experience options
Returns Promise<WebXRDefaultExperience>
a promise for a new WebXRDefaultExperience

See
https://doc.babylonjs.com/features/featuresDeepDive/webXR/introToWebXR
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97656

createOrUpdateSelectionOctree

createOrUpdateSelectionOctree(
maxCapacity?: number,
maxDepth?: number,
): Octree<AbstractMesh>
Creates or updates the octree used to boost selection (picking)
Parameters
- OptionalmaxCapacity: number
  defines the maximum capacity per leaf
- OptionalmaxDepth: number
  defines the maximum depth of the octree
Returns Octree<AbstractMesh>
an octree of AbstractMesh

See
https://doc.babylonjs.com/features/featuresDeepDive/scene/optimizeOctrees
- Defined in .temp/typedoc/docdirectory/doc.d.ts:125484

createPickingRay

createPickingRay(
    x: number,
    y: number,
    world: Nullable<Matrix>,
    camera: Nullable<Camera>,
    cameraViewSpace?: boolean,
): Ray
Creates a ray that can be used to pick in the scene
Parameters
- x: number
  defines the x coordinate of the origin (on-screen)
- y: number
  defines the y coordinate of the origin (on-screen)
- world: Nullable<Matrix>
  defines the world matrix to use if you want to pick in object space (instead of world space)
- camera: Nullable<Camera>
  defines the camera to use for the picking
- OptionalcameraViewSpace: boolean
  defines if picking will be done in view space (false by default)
Returns Ray
a Ray
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4040

createPickingRayInCameraSpace

createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray
Creates a ray that can be used to pick in the scene
Parameters
- x: number
  defines the x coordinate of the origin (on-screen)
- y: number
  defines the y coordinate of the origin (on-screen)
- Optionalcamera: Camera
  defines the camera to use for the picking
Returns Ray
a Ray
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4060

createPickingRayInCameraSpaceToRef

createPickingRayInCameraSpaceToRef(
    x: number,
    y: number,
    result: Ray,
    camera?: Camera,
): Scene
Creates a ray that can be used to pick in the scene
Parameters
- x: number
  defines the x coordinate of the origin (on-screen)
- y: number
  defines the y coordinate of the origin (on-screen)
- result: Ray
  defines the ray where to store the picking ray
- Optionalcamera: Camera
  defines the camera to use for the picking
Returns Scene
the current scene
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4069

createPickingRayToRef

createPickingRayToRef(
    x: number,
    y: number,
    world: Nullable<Matrix>,
    result: Ray,
    camera: Nullable<Camera>,
    cameraViewSpace?: boolean,
    enableDistantPicking?: boolean,
): Scene
Creates a ray that can be used to pick in the scene
Parameters
- x: number
  defines the x coordinate of the origin (on-screen)
- y: number
  defines the y coordinate of the origin (on-screen)
- world: Nullable<Matrix>
  defines the world matrix to use if you want to pick in object space (instead of world space)
- result: Ray
  defines the ray where to store the picking ray
- camera: Nullable<Camera>
  defines the camera to use for the picking
- OptionalcameraViewSpace: boolean
  defines if picking will be done in view space (false by default)
- OptionalenableDistantPicking: boolean
  defines if picking should handle large values for mesh position/scaling (false by default)
Returns Scene
the current scene
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4052

createSceneUniformBuffer

createSceneUniformBuffer(name?: string): UniformBuffer
Creates a scene UBO
Parameters
- Optionalname: string
  name of the uniform buffer (optional, for debugging purpose only)
Returns UniformBuffer
a new ubo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3383

deleteCompoundImpostor

deleteCompoundImpostor(compound: any): void
Deletes a physics compound impostor
Parameters
- compound: any
  defines the compound to delete
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:26525

detachControl

detachControl(): void
Detaches all event handlers

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

disableDepthRenderer

disableDepthRenderer(camera?: Nullable<Camera>): void
Disables a depth renderer for a given camera
Parameters
- Optionalcamera: Nullable<Camera>
  The camera to disable the depth renderer on (default: scene's active camera)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:18154

disableFluidRenderer

disableFluidRenderer(): void
Disables the fluid renderer associated with the scene

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

disableGeometryBufferRenderer

disableGeometryBufferRenderer(): void
Disables the GeometryBufferRender associated with the scene

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

disableIblCdfGenerator

disableIblCdfGenerator(): void
Disables the GeometryBufferRender associated with the scene

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

disablePhysicsEngine

disablePhysicsEngine(): void
Disables and disposes the physics engine associated with the scene

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

disablePrePassRenderer

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

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

disableSubSurfaceForPrePass

disableSubSurfaceForPrePass(): void
Disables the subsurface effect for prepass

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

dispose

dispose(): void
Releases all held resources

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

enableDepthRenderer

enableDepthRenderer(
    camera?: Nullable<Camera>,
    storeNonLinearDepth?: boolean,
    force32bitsFloat?: boolean,
    samplingMode?: number,
    storeCameraSpaceZ?: boolean,
): DepthRenderer
Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
Parameters
- Optionalcamera: Nullable<Camera>
  The camera to create the depth renderer on (default: scene's active camera)
- OptionalstoreNonLinearDepth: boolean
  Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
- Optionalforce32bitsFloat: boolean
  Forces 32 bits float when supported (else 16 bits float is prioritized over 32 bits float if supported)
- OptionalsamplingMode: number
  The sampling mode to be used with the render target (Linear, Nearest...)
- OptionalstoreCameraSpaceZ: boolean
  Defines whether the depth stored is the Z coordinate in camera space. If true, storeNonLinearDepth has no effect. (Default: false)
Returns DepthRenderer
the created depth renderer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:18149

enableFluidRenderer

enableFluidRenderer(): Nullable<FluidRenderer>
Enables the fluid renderer and associates it with the scene

Returns Nullable<FluidRenderer>
the FluidRenderer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:19130

enableGeometryBufferRenderer

enableGeometryBufferRenderer(
    ratioOrDimensions?: number | { height: number; width: number },
    depthFormat?: number,
    textureTypesAndFormats?: {
        [key: number]: { textureFormat: number; textureType: number };
    },
): Nullable<GeometryBufferRenderer>
Enables a GeometryBufferRender and associates it with the scene
Parameters
- OptionalratioOrDimensions: number | { height: number; width: number }
  defines the scaling ratio to apply to the renderer (1 by default which means same resolution). You can also directly pass a width and height for the generated textures
- OptionaldepthFormat: number
  Format of the depth texture (default: Constants.TEXTUREFORMAT_DEPTH16)
- OptionaltextureTypesAndFormats: { [key: number]: { textureFormat: number; textureType: number } }
  The types and formats of textures to create as render targets. If not provided, all textures will be RGBA and float or half float, depending on the engine capabilities.
Returns Nullable<GeometryBufferRenderer>
the GeometryBufferRenderer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:17567

enableIblCdfGenerator

enableIblCdfGenerator(): Nullable<IblCdfGenerator>
Enables a IblCdfGenerator and associates it with the scene.

Returns Nullable<IblCdfGenerator>
the IblCdfGenerator
- Defined in .temp/typedoc/docdirectory/doc.d.ts:17417

enablePhysics

enablePhysics(
gravity?: Nullable<Vector3>,
plugin?: IPhysicsEnginePlugin | IPhysicsEnginePluginV2,
): boolean
Enables physics to the current scene
Parameters
- Optionalgravity: Nullable<Vector3>
  defines the scene's gravity for the physics engine. defaults to real earth gravity : (0, -9.81, 0)
- Optionalplugin: IPhysicsEnginePlugin | IPhysicsEnginePluginV2
  defines the physics engine to be used. defaults to CannonJS.
Returns boolean
a boolean indicating if the physics engine was initialized
- Defined in .temp/typedoc/docdirectory/doc.d.ts:26511

enablePrePassRenderer

enablePrePassRenderer(): Nullable<PrePassRenderer>
Enables the prepass and associates it with the scene

Returns Nullable<PrePassRenderer>
the PrePassRenderer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:16716

enableSubSurfaceForPrePass

enableSubSurfaceForPrePass(): Nullable<SubSurfaceConfiguration>
Enables the subsurface effect for prepass

Returns Nullable<SubSurfaceConfiguration>
the SubSurfaceConfiguration
- Defined in .temp/typedoc/docdirectory/doc.d.ts:16023

executeOnceBeforeRender

executeOnceBeforeRender(func: () => void, timeout?: number): void
The provided function will run before render once and will be disposed afterwards. A timeout delay can be provided so that the function will be executed in N ms. The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
Parameters
- func: () => void
  The function to be executed.
- Optionaltimeout: number
  optional delay in ms
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3305

executeWhenReady

executeWhenReady(func: () => void, checkRenderTargets?: boolean): void
Registers a function to be executed when the scene is ready
Parameters
- func: () => void
  the function to be executed
- OptionalcheckRenderTargets: boolean
  true to also check that the meshes rendered as part of a render target are ready (default: false)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3330

finalizeSceneUbo

finalizeSceneUbo(): UniformBuffer
Update the scene ubo before it can be used in rendering processing

Returns UniformBuffer
the scene UniformBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2636

freeActiveMeshes

freeActiveMeshes(): void
Clear the active meshes smart array preventing retention point in mesh dispose.

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

freeProcessedMaterials

freeProcessedMaterials(): void
Clear the processed materials smart array preventing retention point in material dispose.

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

freeRenderingGroups

freeRenderingGroups(): void
Clear the info related to rendering groups preventing retention points during dispose.

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

freezeActiveMeshes

freezeActiveMeshes(
    skipEvaluateActiveMeshes?: boolean,
    onSuccess?: () => void,
    onError?: (message: string) => void,
    freezeMeshes?: boolean,
    keepFrustumCulling?: boolean,
): Scene
Use this function to stop evaluating active meshes. The current list will be keep alive between frames
Parameters
- OptionalskipEvaluateActiveMeshes: boolean
  defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
- OptionalonSuccess: () => void
  optional success callback
- OptionalonError: (message: string) => void
  optional error callback
- OptionalfreezeMeshes: boolean
  defines if meshes should be frozen (true by default)
- OptionalkeepFrustumCulling: boolean
  defines if you want to keep running the frustum clipping (false by default)
Returns Scene
the current scene
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3932

freezeMaterials

freezeMaterials(): void
Freeze all materials A frozen material will not be updatable but should be faster to render Note: multimaterials will not be frozen, but their submaterials will

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

getActiveBones

getActiveBones(): number
Gets the total number of active bones rendered per frame

Returns number
the total number of active bones rendered per frame
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3199

getActiveIndices

getActiveIndices(): number
Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)

Returns number
the total number of active indices rendered per frame
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3179

getActiveMeshes

getActiveMeshes(): SmartArray<AbstractMesh>
Gets the array of active meshes

Returns SmartArray<AbstractMesh>
an array of AbstractMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3209

getActiveParticles

getActiveParticles(): number
Gets the total number of active particles rendered per frame

Returns number
the total number of active particles rendered per frame
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3189

getAllAnimatablesByTarget

getAllAnimatablesByTarget(target: any): Animatable[]
Gets all animatables associated with a given target
Parameters
- target: any
  defines the target to look animatables for
Returns Animatable[]
an array of Animatables
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139550

getAnimatableByTarget

getAnimatableByTarget(target: any): Nullable<Animatable>
Gets the animatable associated with a specific target
Parameters
- target: any
  defines the target of the animatable
Returns Nullable<Animatable>
the required animatable if found
- Defined in .temp/typedoc/docdirectory/doc.d.ts:139544

getAnimationGroupByName

getAnimationGroupByName(name: string): Nullable<AnimationGroup>
get an animation group using its name
Parameters
- name: string
  defines the material's name
Returns Nullable<AnimationGroup>
the animation group or null if none found.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3580

getAnimationRatio

getAnimationRatio(): number
Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)

Returns number
a number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3214

getAutoClearDepthStencilSetup

getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup
Gets the current auto clear configuration for one rendering group of the rendering manager.
Parameters
- index: number
  the rendering group index to get the information for
Returns IRenderingManagerAutoClearSetup
The auto clear setup for the requested rendering group
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4204

getBoneById

getBoneById(id: string): Nullable<Bone>
Gets a bone using its Id
Parameters
- id: string
  defines the bone's Id
Returns Nullable<Bone>
the bone or null if not found
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3653

getBoneByID

getBoneByID(id: string): Nullable<Bone>
Gets a bone using its Id
Parameters
- id: string
  defines the bone's Id
Returns Nullable<Bone>
the bone or null if not found

Deprecated
Please use getBoneById instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4297

getBoneByName

getBoneByName(name: string): Nullable<Bone>
Gets a bone using its id
Parameters
- name: string
  defines the bone's name
Returns Nullable<Bone>
the bone or null if not found
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3659

getBoundingBoxRenderer

getBoundingBoxRenderer(): BoundingBoxRenderer
Gets the bounding box renderer associated with the scene

Returns BoundingBoxRenderer
a BoundingBoxRenderer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:18435

getCachedEffect

getCachedEffect(): Nullable<Effect>
Gets the cached effect (ie. the latest rendered one)

Returns Nullable<Effect>
the cached effect
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3146

getCachedMaterial

getCachedMaterial(): Nullable<Material>
Gets the cached material (ie. the latest rendered one)

Returns Nullable<Material>
the cached material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3141

getCachedVisibility

getCachedVisibility(): Nullable<number>
Gets the cached visibility state (ie. the latest rendered one)

Returns Nullable<number>
the cached visibility state
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3151

getCameraById

getCameraById(id: string): Nullable<Camera>
Gets a camera using its Id
Parameters
- id: string
  defines the Id to look for
Returns Nullable<Camera>
the camera or null if not found
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3635

getCameraByID

getCameraByID(id: string): Nullable<Camera>
Gets a camera using its Id
Parameters
- id: string
  defines the Id to look for
Returns Nullable<Camera>
the camera or null if not found

Deprecated
Please use getCameraById instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4283

getCameraByName

getCameraByName(name: string): Nullable<Camera>
Gets a camera using its name
Parameters
- name: string
  defines the camera's name
Returns Nullable<Camera>
the camera or null if none found.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3647

getCameraByUniqueId

getCameraByUniqueId(uniqueId: number): Nullable<Camera>
Gets a camera using its unique Id
Parameters
- uniqueId: number
  defines the unique Id to look for
Returns Nullable<Camera>
the camera or null if not found
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3641

getCameraByUniqueID

getCameraByUniqueID(uniqueId: number): Nullable<Camera>
Gets a camera using its unique Id
Parameters
- uniqueId: number
  defines the unique Id to look for
Returns Nullable<Camera>
the camera or null if not found

Deprecated
Please use getCameraByUniqueId instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4290

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:4157

getClassName

getClassName(): string
Gets a string identifying the name of the class

Returns string
"Scene" string
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3106

getEngine

getEngine(): AbstractEngine
Gets the engine associated with the scene

Returns AbstractEngine
an Engine
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3164

getExternalData

getExternalData<T>(key: string): Nullable<T>
Get an externally attached data from its key
Type Parameters
- T
Parameters
- key: string
  the unique key that identifies the data
Returns Nullable<T>
the associated data, if present (can be null), or undefined if not present
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3865

getFrameGraphByName

getFrameGraphByName(name: string): Nullable<FrameGraph>
Gets a frame graph using its name
Parameters
- name: string
  defines the frame graph's name
Returns Nullable<FrameGraph>
the frame graph or null if none found.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3696

getFrameId

getFrameId(): number
Gets an unique Id for the current frame

Returns number
a number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3224

getGeometries

getGeometries(): Geometry[]
Gets the list of geometries attached to the scene

Returns Geometry[]
an array of Geometry
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3714

getGeometryById

getGeometryById(id: string): Nullable<Geometry>
Gets a geometry using its Id
Parameters
- id: string
  defines the geometry's Id
Returns Nullable<Geometry>
the geometry or null if none found.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3689

getGeometryByID

getGeometryByID(id: string): Nullable<Geometry>
Gets a geometry using its Id
Parameters
- id: string
  defines the geometry's Id
Returns Nullable<Geometry>
the geometry or null if none found.

Deprecated
Please use getGeometryById instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4325

getGlowLayerByName

getGlowLayerByName(name: string): Nullable<GlowLayer>
Return the first glow layer of the scene with a given name.
Parameters
- name: string
  The name of the glow layer to look for.
Returns Nullable<GlowLayer>
The glow layer if found otherwise null.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:96322

getHighlightLayerByName

getHighlightLayerByName(name: string): Nullable<HighlightLayer>
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.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:96120

getInternalStep

getInternalStep(): number
Gets the internal step used by deterministic lock step

Returns number
the internal step

See
https://doc.babylonjs.com/features/featuresDeepDive/animation/advanced_animations#deterministic-lockstep
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2674

getLastEntryById

getLastEntryById(id: string): Nullable<Node>
Gets a the last added node (Mesh, Camera, Light) using a given Id
Parameters
- id: string
  defines the Id to search for
Returns Nullable<Node>
the found node or null if not found at all
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3768

getLastEntryByID

getLastEntryByID(id: string): Nullable<Node>
Gets a the last added node (Mesh, Camera, Light) using a given Id
Parameters
- id: string
  defines the Id to search for
Returns Nullable<Node>
the found node or null if not found at all

Deprecated
Please use getLastEntryById instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4388

getLastMaterialById

getLastMaterialById(
id: string,
allowMultiMaterials?: boolean,
): Nullable<Material>
Gets a last added material using a given id
Parameters
- id: string
  defines the material's id
- OptionalallowMultiMaterials: boolean
  determines whether multimaterials should be considered
Returns Nullable<Material>
the last material with the given id or null if none found.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3617

getLastMaterialByID

getLastMaterialByID(id: string): Nullable<Material>
Gets a the last added material using a given id
Parameters
- id: string
  defines the material's Id
Returns Nullable<Material>
the last material with the given id or null if none found.

Deprecated
Please use getLastMaterialById instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4269

getLastMeshById

getLastMeshById(id: string): Nullable<AbstractMesh>
Gets a the last added mesh using a given Id
Parameters
- id: string
  defines the Id to search for
Returns Nullable<AbstractMesh>
the found mesh or null if not found at all.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3756

getLastMeshByID

getLastMeshByID(id: string): Nullable<AbstractMesh>
Gets a the last added mesh using a given Id
Parameters
- id: string
  defines the Id to search for
Returns Nullable<AbstractMesh>
the found mesh or null if not found at all.

Deprecated
Please use getLastMeshById instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4346

getLastSkeletonById

getLastSkeletonById(id: string): Nullable<Skeleton>
Gets a skeleton using a given Id (if many are found, this function will pick the last one)
Parameters
- id: string
  defines the Id to search for
Returns Nullable<Skeleton>
the found skeleton or null if not found at all.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3798

getLastSkeletonByID

getLastSkeletonByID(id: string): Nullable<Skeleton>
Gets a skeleton using a given Id (if many are found, this function will pick the last one)
Parameters
- id: string
  defines the Id to search for
Returns Nullable<Skeleton>
the found skeleton or null if not found at all.

Deprecated
Please use getLastSkeletonById instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4395

getLastTransformNodeById

getLastTransformNodeById(id: string): Nullable<TransformNode>
Gets a the last transform node using a given Id
Parameters
- id: string
  defines the Id to search for
Returns Nullable<TransformNode>
the found mesh or null if not found at all.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3762

getLensFlareSystemById

getLensFlareSystemById(id: string): Nullable<LensFlareSystem>
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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:95050

getLensFlareSystemByID

getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>
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

Deprecated
Please use getLensFlareSystemById instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:95044

getLensFlareSystemByName

getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>
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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:95037

getLightById

getLightById(id: string): Nullable<Light>
Gets a light node using its Id
Parameters
- id: string
  defines the light's Id
Returns Nullable<Light>
the light or null if none found.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3671

getLightByID

getLightByID(id: string): Nullable<Light>
Gets a light node using its Id
Parameters
- id: string
  defines the light's Id
Returns Nullable<Light>
the light or null if none found.

Deprecated
Please use getLightById instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4304

getLightByName

getLightByName(name: string): Nullable<Light>
Gets a light node using its name
Parameters
- name: string
  defines the light's name
Returns Nullable<Light>
the light or null if none found.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3665

getLightByUniqueId

getLightByUniqueId(uniqueId: number): Nullable<Light>
Gets a light node using its scene-generated unique Id
Parameters
- uniqueId: number
  defines the light's unique Id
Returns Nullable<Light>
the light or null if none found.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3677

getLightByUniqueID

getLightByUniqueID(uniqueId: number): Nullable<Light>
Gets a light node using its scene-generated unique Id
Parameters
- uniqueId: number
  defines the light's unique Id
Returns Nullable<Light>
the light or null if none found.

Deprecated
Please use getLightByUniqueId instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4311

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:4164

getMaterialById

getMaterialById(id: string, allowMultiMaterials?: boolean): Nullable<Material>
get a material using its id
Parameters
- id: string
  defines the material's Id
- OptionalallowMultiMaterials: boolean
  determines whether multimaterials should be considered
Returns Nullable<Material>
the material or null if none found.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3603

getMaterialByID

getMaterialByID(id: string): Nullable<Material>
Get a material using its id
Parameters
- id: string
  defines the material's Id
Returns Nullable<Material>
the material or null if none found.

Deprecated
Please use getMaterialById instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4262

getMaterialByName

getMaterialByName(
name: string,
allowMultiMaterials?: boolean,
): Nullable<Material>
Gets a material using its name
Parameters
- name: string
  defines the material's name
- OptionalallowMultiMaterials: boolean
  determines whether multimaterials should be considered
Returns Nullable<Material>
the material or null if none found.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3610

getMaterialByTags

getMaterialByTags(
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:4171

getMaterialByUniqueId

getMaterialByUniqueId(
uniqueId: number,
allowMultiMaterials?: boolean,
): Nullable<Material>
Get a material using its unique id
Parameters
- uniqueId: number
  defines the material's unique id
- OptionalallowMultiMaterials: boolean
  determines whether multimaterials should be considered
Returns Nullable<Material>
the material or null if none found.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3596

getMaterialByUniqueID

getMaterialByUniqueID(
uniqueId: number,
allowMultiMaterials?: boolean,
): Nullable<Material>
Get a material using its unique id
Parameters
- uniqueId: number
  defines the material's unique id
- OptionalallowMultiMaterials: boolean
  determines whether multimaterials should be considered
Returns Nullable<Material>
the material or null if none found.

Deprecated
Please use getMaterialByUniqueId instead.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3589

getMeshById

getMeshById(id: string): Nullable<AbstractMesh>
Gets the first added mesh found of a given Id
Parameters
- id: string
  defines the Id to search for
Returns Nullable<AbstractMesh>
the mesh found or null if not found at all
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3720

getMeshByID

getMeshByID(id: string): Nullable<AbstractMesh>
Gets the first added mesh found of a given Id
Parameters
- id: string
  defines the Id to search for
Returns Nullable<AbstractMesh>
the mesh found or null if not found at all

Deprecated
Please use getMeshById instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4332

getMeshByName

getMeshByName(name: string): Nullable<AbstractMesh>
Gets a mesh using a given name
Parameters
- name: string
  defines the name to search for
Returns Nullable<AbstractMesh>
the found mesh or null if not found at all.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3786

getMeshByUniqueId

getMeshByUniqueId(uniqueId: number): Nullable<AbstractMesh>
Gets a mesh with its auto-generated unique Id
Parameters
- uniqueId: number
  defines the unique Id to search for
Returns Nullable<AbstractMesh>
the found mesh or null if not found at all.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3750

getMeshByUniqueID

getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>
Gets a mesh with its auto-generated unique Id
Parameters
- uniqueId: number
  defines the unique Id to search for
Returns Nullable<AbstractMesh>
the found mesh or null if not found at all.

Deprecated
Please use getMeshByUniqueId instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4339

getMeshesById

getMeshesById(id: string): AbstractMesh[]
Gets a list of meshes using their Id
Parameters
- id: string
  defines the Id to search for
Returns AbstractMesh[]
a list of meshes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3726

getMeshesByID

getMeshesByID(id: string): AbstractMesh[]
Gets a list of meshes using their Id
Parameters
- id: string
  defines the Id to search for
Returns AbstractMesh[]
a list of meshes

Deprecated
Please use getMeshesById instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4353

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:4150

getMorphTargetById

getMorphTargetById(id: string): Nullable<MorphTarget>
Gets a morph target using a given id (if many are found, this function will pick the first one)
Parameters
- id: string
  defines the id to search for
Returns Nullable<MorphTarget>
the found morph target or null if not found at all.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3828

getMorphTargetByName

getMorphTargetByName(name: string): Nullable<MorphTarget>
Gets a morph target using a given name (if many are found, this function will pick the first one)
Parameters
- name: string
  defines the name to search for
Returns Nullable<MorphTarget>
the found morph target or null if not found at all.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3834

getMorphTargetManagerById

getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>
Gets a morph target manager using a given id (if many are found, this function will pick the last one)
Parameters
- id: number
  defines the id to search for
Returns Nullable<MorphTargetManager>
the found morph target manager or null if not found at all.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3822

getNodeById

getNodeById(id: string): Nullable<Node>
Gets a node (Mesh, Camera, Light) using a given Id
Parameters
- id: string
  defines the Id to search for
Returns Nullable<Node>
the found node or null if not found at all
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3774

getNodeByID

getNodeByID(id: string): Nullable<Node>
Gets a node (Mesh, Camera, Light) using a given Id
Parameters
- id: string
  defines the Id to search for
Returns Nullable<Node>
the found node or null if not found at all

Deprecated
Please use getNodeById instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4381

getNodeByName

getNodeByName(name: string): Nullable<Node>
Gets a node (Mesh, Camera, Light) using a given name
Parameters
- name: string
  defines the name to search for
Returns Nullable<Node>
the found node or null if not found at all.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3780

getNodes

getNodes(): Node[]
Returns Node[]
all meshes, lights, cameras, transformNodes and bones
Implementation of IAssetContainer.getNodes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2249

getOrAddExternalDataWithFactory

getOrAddExternalDataWithFactory<T extends object>(
key: string,
factory: (k: string) => T,
): T
Get an externally attached data from its key, create it using a factory if it's not already present
Type Parameters
- T extends object
Parameters
- key: string
  the unique key that identifies the data
- factory: (k: string) => T
  the factory that will be called to create the instance if and only if it doesn't exists
Returns T
the associated data, can be null if the factory returned null.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3872

getOutlineRenderer

getOutlineRenderer(): OutlineRenderer
Gets the outline renderer associated with the scene

Returns OutlineRenderer
a OutlineRenderer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:17045

getParticleSystemById

getParticleSystemById(id: string): Nullable<IParticleSystem>
Gets a particle system by Id
Parameters
- id: string
  defines the particle system Id
Returns Nullable<IParticleSystem>
the corresponding system or null if none found
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3683

getParticleSystemByID

getParticleSystemByID(id: string): Nullable<IParticleSystem>
Gets a particle system by Id
Parameters
- id: string
  defines the particle system Id
Returns Nullable<IParticleSystem>
the corresponding system or null if none found

Deprecated
Please use getParticleSystemById instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4318

getPerfCollector

getPerfCollector(): PerformanceViewerCollector
This method gets the performance collector belonging to the scene, which is generally shared with the inspector.

Returns PerformanceViewerCollector
the perf collector belonging to the scene.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4248

getPhysicsEngine

getPhysicsEngine(): Nullable<IPhysicsEngine>
Gets the current physics engine

Returns Nullable<IPhysicsEngine>
a IPhysicsEngine or null if none attached
- Defined in .temp/typedoc/docdirectory/doc.d.ts:26504

getPointerOverMesh

getPointerOverMesh(): Nullable<AbstractMesh>
Gets the mesh under the pointer

Returns Nullable<AbstractMesh>
a Mesh or null if no mesh is under the pointer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4131

getPointerOverSprite

getPointerOverSprite(): Nullable<Sprite>
Gets the sprite under the pointer

Returns Nullable<Sprite>
a Sprite or null if no sprite is under the pointer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:11290

getPostProcessByName

getPostProcessByName(name: string): Nullable<PostProcess>
Gets a post process using a given name (if many are found, this function will pick the first one)
Parameters
- name: string
  defines the name to search for
Returns Nullable<PostProcess>
the found post process or null if not found at all.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3840

getProjectionMatrix

getProjectionMatrix(): Matrix
Gets the current projection matrix

Returns Matrix
a Matrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3359

getRenderId

getRenderId(): number
Gets an unique Id for the current render phase

Returns number
a number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3219

getSceneUniformBuffer

getSceneUniformBuffer(): UniformBuffer
Gets the uniform buffer used to store scene data

Returns UniformBuffer
a UniformBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3377

getSkeletonById

getSkeletonById(id: string): Nullable<Skeleton>
Gets a skeleton using a given id (if many are found, this function will pick the first one)
Parameters
- id: string
  defines the id to search for
Returns Nullable<Skeleton>
the found skeleton or null if not found at all.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3810

getSkeletonByName

getSkeletonByName(name: string): Nullable<Skeleton>
Gets a skeleton using a given name
Parameters
- name: string
  defines the name to search for
Returns Nullable<Skeleton>
the found skeleton or null if not found at all.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3816

getSkeletonByUniqueId

getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>
Gets a skeleton using a given auto generated unique id
Parameters
- uniqueId: number
  defines the unique id to search for
Returns Nullable<Skeleton>
the found skeleton or null if not found at all.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3804

getSoundByName

getSoundByName(name: string): Nullable<Sound>
Gets a sound using a given name
Parameters
- name: string
  defines the name to search for
Returns Nullable<Sound>
the found sound or null if not found at all.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:137243

getStepId

getStepId(): number
Gets the step Id used by deterministic lock step

Returns number
the step Id

See
https://doc.babylonjs.com/features/featuresDeepDive/animation/advanced_animations#deterministic-lockstep
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2668

getTextureByName

getTextureByName(name: string): Nullable<BaseTexture>
Gets a texture using its name
Parameters
- name: string
  defines the texture's name
Returns Nullable<BaseTexture>
the texture or null if none found.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3629

getTextureByUniqueId

getTextureByUniqueId(uniqueId: number): Nullable<BaseTexture>
Get a texture using its unique id
Parameters
- uniqueId: number
  defines the texture's unique id
Returns Nullable<BaseTexture>
the texture or null if none found.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3623

getTextureByUniqueID

getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>
Get a texture using its unique id
Parameters
- uniqueId: number
  defines the texture's unique id
Returns Nullable<BaseTexture>
the texture or null if none found.

Deprecated
Please use getTextureByUniqueId instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4276

getTotalVertices

getTotalVertices(): number
Gets the total number of vertices rendered per frame

Returns number
the total number of vertices rendered per frame
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3169

getTransformMatrix

getTransformMatrix(): Matrix
Gets the current transform matrix

Returns Matrix
a Matrix made of View * Projection
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3364

getTransformNodeById

getTransformNodeById(id: string): Nullable<TransformNode>
Gets the first added transform node found of a given Id
Parameters
- id: string
  defines the Id to search for
Returns Nullable<TransformNode>
the found transform node or null if not found at all.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3732

getTransformNodeByID

getTransformNodeByID(id: string): Nullable<TransformNode>
Gets the first added transform node found of a given Id
Parameters
- id: string
  defines the Id to search for
Returns Nullable<TransformNode>
the found transform node or null if not found at all.

Deprecated
Please use getTransformNodeById instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4360

getTransformNodeByName

getTransformNodeByName(name: string): Nullable<TransformNode>
Gets a transform node using a given name
Parameters
- name: string
  defines the name to search for
Returns Nullable<TransformNode>
the found transform node or null if not found at all.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3792

getTransformNodeByUniqueId

getTransformNodeByUniqueId(uniqueId: number): Nullable<TransformNode>
Gets a transform node with its auto-generated unique Id
Parameters
- uniqueId: number
  defines the unique Id to search for
Returns Nullable<TransformNode>
the found transform node or null if not found at all.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3738

getTransformNodeByUniqueID

getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>
Gets a transform node with its auto-generated unique Id
Parameters
- uniqueId: number
  defines the unique Id to search for
Returns Nullable<TransformNode>
the found transform node or null if not found at all.

Deprecated
Please use getTransformNodeByUniqueId instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4367

getTransformNodesById

getTransformNodesById(id: string): TransformNode[]
Gets a list of transform nodes using their Id
Parameters
- id: string
  defines the Id to search for
Returns TransformNode[]
a list of transform nodes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3744

getTransformNodesByID

getTransformNodesByID(id: string): TransformNode[]
Gets a list of transform nodes using their Id
Parameters
- id: string
  defines the Id to search for
Returns TransformNode[]
a list of transform nodes

Deprecated
Please use getTransformNodesById instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4374

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:4178

getUniqueId

getUniqueId(): number
Gets an unique (relatively to the current scene) Id

Returns number
an unique number for the scene
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3393

getViewMatrix

getViewMatrix(): Matrix
Gets the current view matrix

Returns Matrix
a Matrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3354

getWaitingItemsCount

getWaitingItemsCount(): number
Returns the number of items waiting to be loaded

Returns number
the number of items waiting to be loaded
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3320

getWorldExtends

getWorldExtends(
filterPredicate?: (mesh: AbstractMesh) => boolean,
): { max: Vector3; min: Vector3 }
Get the world extend vectors with an optional filter
Parameters
- OptionalfilterPredicate: (mesh: AbstractMesh) => boolean
  the predicate - which meshes should be included when calculating the world size
Returns { max: Vector3; min: Vector3 }
min and max vectors
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4027

incrementRenderId

incrementRenderId(): void
Call this function if you want to manually increment the render Id

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

isActiveMesh

isActiveMesh(mesh: AbstractMesh): boolean
Gets a boolean indicating if the given mesh is active
Parameters
- mesh: AbstractMesh
  defines the mesh to look for
Returns boolean
true if the mesh is in the active list
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3846

isCachedMaterialInvalid

isCachedMaterialInvalid(
    material: Material,
    effect: Effect,
    visibility?: number,
): boolean
Gets a boolean indicating if the current material / effect / visibility must be bind again
Parameters
- material: Material
  defines the current material
- effect: Effect
  defines the current effect
- Optionalvisibility: number
  defines the current visibility state
Returns boolean
true if one parameter is not cached
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3159

isPhysicsEnabled

isPhysicsEnabled(): boolean
Gets a boolean indicating if there is an active physics engine

Returns boolean
a boolean indicating if there is an active physics engine
- Defined in .temp/typedoc/docdirectory/doc.d.ts:26520

isPointerCaptured

isPointerCaptured(pointerId?: number): boolean
Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
Parameters
- OptionalpointerId: number
  defines the pointer id to use in a multi-touch scenario (0 by default)
Returns boolean
true if the pointer was captured
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3258

isReady

isReady(checkRenderTargets?: boolean): boolean
This function will check if the scene can be rendered (textures are loaded, shaders are compiled) Delay loaded resources are not taking in account
Parameters
- OptionalcheckRenderTargets: boolean
  true to also check that the meshes rendered as part of a render target are ready (default: true)
Returns boolean
true if all required resources are ready
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3274

markAllMaterialsAsDirty

markAllMaterialsAsDirty(
flag: number,
predicate?: (mat: Material) => boolean,
): void
Will flag all materials as dirty to trigger new shader compilation
Parameters
- flag: number
  defines the flag used to specify which material part must be marked as dirty
- Optionalpredicate: (mat: Material) => boolean
  If not null, it will be used to specify if a material has to be marked as dirty
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4216

multiPick

multiPick(
    x: number,
    y: number,
    predicate?: MeshPredicate,
    camera?: Camera,
    trianglePredicate?: TrianglePickingPredicate,
): Nullable<PickingInfo[]>
Launch a ray to try to pick a mesh in the scene. A mesh triangle can be picked both from its front and back sides, irrespective of orientation.
Parameters
- x: number
  X position on screen
- y: number
  Y position on screen
- Optionalpredicate: MeshPredicate
  Predicate function used to determine eligible meshes and instances. Can be set to null. In this case, a mesh must be enabled, visible and with isPickable set to true. thinInstanceIndex is -1 when the mesh is non-instanced
- Optionalcamera: Camera
  camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
- OptionaltrianglePredicate: TrianglePickingPredicate
  defines an optional predicate used to select faces when a mesh intersection is detected
Returns Nullable<PickingInfo[]>
an array of PickingInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4111

multiPickSprite

multiPickSprite(
    x: number,
    y: number,
    predicate?: (sprite: Sprite) => boolean,
    camera?: Camera,
): Nullable<PickingInfo[]>
Launch a ray to try to pick sprites in the scene
Parameters
- x: number
  position on screen
- y: number
  position on screen
- Optionalpredicate: (sprite: Sprite) => boolean
  Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
- Optionalcamera: Camera
  camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
Returns Nullable<PickingInfo[]>
a PickingInfo array
- Defined in .temp/typedoc/docdirectory/doc.d.ts:11273

multiPickSpriteWithRay

multiPickSpriteWithRay(
    ray: Ray,
    predicate?: (sprite: Sprite) => boolean,
    camera?: Camera,
): Nullable<PickingInfo[]>
Use the given ray to pick sprites in the scene
Parameters
- ray: Ray
  The ray (in world space) to use to pick meshes
- Optionalpredicate: (sprite: Sprite) => boolean
  Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
- Optionalcamera: Camera
  camera to use. Can be set to null. In this case, the scene.activeCamera will be used
Returns Nullable<PickingInfo[]>
a PickingInfo array
- Defined in .temp/typedoc/docdirectory/doc.d.ts:11280

multiPickWithRay

multiPickWithRay(
    ray: Ray,
    predicate?: MeshPredicate,
    trianglePredicate?: TrianglePickingPredicate,
): Nullable<PickingInfo[]>
Launch a ray to try to pick a mesh in the scene
Parameters
- ray: Ray
  Ray to use
- Optionalpredicate: MeshPredicate
  Predicate function used to determine eligible meshes and instances. Can be set to null. In this case, a mesh must be enabled, visible and with isPickable set to true. thinInstanceIndex is -1 when the mesh is non-instanced
- OptionaltrianglePredicate: TrianglePickingPredicate
  defines an optional predicate used to select faces when a mesh intersection is detected
Returns Nullable<PickingInfo[]>
an array of PickingInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4119

pick

pick(
    x: number,
    y: number,
    predicate?: MeshPredicate,
    fastCheck?: boolean,
    camera?: Nullable<Camera>,
    trianglePredicate?: TrianglePickingPredicate,
): PickingInfo
Launch a ray to try to pick a mesh in the scene
Parameters
- x: number
  position on screen
- y: number
  position on screen
- Optionalpredicate: MeshPredicate
  Predicate function used to determine eligible meshes. Can be set to null. In this case, a mesh must be enabled, visible and with isPickable set to true. thinInstanceIndex is -1 when the mesh is non-instanced
- OptionalfastCheck: boolean
  defines if the first intersection will be used (and not the closest)
- Optionalcamera: Nullable<Camera>
  to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
- OptionaltrianglePredicate: TrianglePickingPredicate
  defines an optional predicate used to select faces when a mesh intersection is detected
Returns PickingInfo
a PickingInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4081

pickSprite

pickSprite(
    x: number,
    y: number,
    predicate?: (sprite: Sprite) => boolean,
    fastCheck?: boolean,
    camera?: Camera,
): Nullable<PickingInfo>
Launch a ray to try to pick a sprite in the scene
Parameters
- x: number
  position on screen
- y: number
  position on screen
- Optionalpredicate: (sprite: Sprite) => boolean
  Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
- OptionalfastCheck: boolean
  defines if the first intersection will be used (and not the closest)
- Optionalcamera: Camera
  camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
Returns Nullable<PickingInfo>
a PickingInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:11255

pickSpriteWithRay

pickSpriteWithRay(
    ray: Ray,
    predicate?: (sprite: Sprite) => boolean,
    fastCheck?: boolean,
    camera?: Camera,
): Nullable<PickingInfo>
Use the given ray to pick a sprite in the scene
Parameters
- ray: Ray
  The ray (in world space) to use to pick meshes
- Optionalpredicate: (sprite: Sprite) => boolean
  Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
- OptionalfastCheck: boolean
  defines if the first intersection will be used (and not the closest)
- Optionalcamera: Camera
  camera to use. Can be set to null. In this case, the scene.activeCamera will be used
Returns Nullable<PickingInfo>
a PickingInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:11263

pickWithBoundingInfo

pickWithBoundingInfo(
    x: number,
    y: number,
    predicate?: MeshPredicate,
    fastCheck?: boolean,
    camera?: Nullable<Camera>,
): Nullable<PickingInfo>
Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
Parameters
- x: number
  position on screen
- y: number
  position on screen
- Optionalpredicate: MeshPredicate
  Predicate function used to determine eligible meshes. Can be set to null. In this case, a mesh must be enabled, visible and with isPickable set to true. thinInstanceIndex is -1 when the mesh is non-instanced
- OptionalfastCheck: boolean
  defines if the first intersection will be used (and not the closest)
- Optionalcamera: Nullable<Camera>
  to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
Returns Nullable<PickingInfo>
a PickingInfo (Please note that some info will not be set like distance, bv, bu and everything that cannot be capture by only using bounding infos)
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4090

pickWithRay

pickWithRay(
    ray: Ray,
    predicate?: MeshPredicate,
    fastCheck?: boolean,
    trianglePredicate?: TrianglePickingPredicate,
): Nullable<PickingInfo>
Use the given ray to pick a mesh in the scene. A mesh triangle can be picked both from its front and back sides, irrespective of orientation.
Parameters
- ray: Ray
  The ray to use to pick meshes
- Optionalpredicate: MeshPredicate
  Predicate function used to determine eligible meshes. Can be set to null. In this case, a mesh must have isPickable set to true. thinInstanceIndex is -1 when the mesh is non-instanced
- OptionalfastCheck: boolean
  defines if the first intersection will be used (and not the closest)
- OptionaltrianglePredicate: TrianglePickingPredicate
  defines an optional predicate used to select faces when a mesh intersection is detected
Returns Nullable<PickingInfo>
a PickingInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4100

pushGeometry

pushGeometry(geometry: Geometry, force?: boolean): boolean
Add a new geometry to this scene
Parameters
- geometry: Geometry
  defines the geometry to be added to the scene.
- Optionalforce: boolean
  defines if the geometry must be pushed even if a geometry with this id already exists
Returns boolean
a boolean defining if the geometry was added or not
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3703

registerAfterRender

registerAfterRender(func: () => void): void
Registers a function to be called after every frame render
Parameters
- func: () => void
  defines the function to register
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3291

registerBeforeRender

registerBeforeRender(func: () => void): void
Registers a function to be called before every frame render
Parameters
- func: () => void
  defines the function to register
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3281

removeActionManager

removeActionManager(toRemove: AbstractActionManager): number
Removes the given action manager from this scene.
Parameters
- toRemove: AbstractActionManager
  The action manager to remove
Returns number
The index of the removed action manager

Deprecated
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3485

removeAnimation

removeAnimation(toRemove: Animation): number
Remove a animation for the list of scene's animations
Parameters
- toRemove: Animation
  defines the animation to remove
Returns number
the index where the animation was in the animation list
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3453

removeAnimationGroup

removeAnimationGroup(toRemove: AnimationGroup): number
Removes the given animation group from this scene.
Parameters
- toRemove: AnimationGroup
  The animation group to remove
Returns number
The index of the removed animation group
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3466

removeCamera

removeCamera(toRemove: Camera): number
Remove a camera for the list of scene's cameras
Parameters
- toRemove: Camera
  defines the camera to remove
Returns number
the index where the camera was in the camera list
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3441

removeEffectLayer

removeEffectLayer(toRemove: EffectLayer): number
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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:96533

removeExternalData

removeExternalData(key: string): boolean
Remove an externally attached data from the Engine instance
Parameters
- key: string
  the unique key that identifies the data
Returns boolean
true if the data was successfully removed, false if it doesn't exist
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3878

removeGeometry

removeGeometry(geometry: Geometry): boolean
Removes an existing geometry
Parameters
- geometry: Geometry
  defines the geometry to be removed from the scene
Returns boolean
a boolean defining if the geometry was removed or not
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3709

removeLensFlareSystem

removeLensFlareSystem(toRemove: LensFlareSystem): number
Removes the given lens flare system from this scene.
Parameters
- toRemove: LensFlareSystem
  The lens flare system to remove
Returns number
The index of the removed lens flare system
- Defined in .temp/typedoc/docdirectory/doc.d.ts:95026

removeLight

removeLight(toRemove: Light): number
Remove a light for the list of scene's lights
Parameters
- toRemove: Light
  defines the light to remove
Returns number
the index where the light was in the light list
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3435

removeMaterial

removeMaterial(toRemove: Material): number
Removes the given material from this scene.
Parameters
- toRemove: Material
  The material to remove
Returns number
The index of the removed material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3478

removeMesh

removeMesh(toRemove: AbstractMesh, recursive?: boolean): number
Remove a mesh for the list of scene's meshes
Parameters
- toRemove: AbstractMesh
  defines the mesh to remove
- Optionalrecursive: boolean
  if all child meshes should also be removed from the scene
Returns number
the index where the mesh was in the mesh list
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3406

removeMorphTargetManager

removeMorphTargetManager(toRemove: MorphTargetManager): number
Remove a morph target for the list of scene's morph targets
Parameters
- toRemove: MorphTargetManager
  defines the morph target to remove
Returns number
the index where the morph target was in the morph target list
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3429

removeMultiMaterial

removeMultiMaterial(toRemove: MultiMaterial): number
Removes the given multi-material from this scene.
Parameters
- toRemove: MultiMaterial
  The multi-material to remove
Returns number
The index of the removed multi-material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3472

removeParticleSystem

removeParticleSystem(toRemove: IParticleSystem): number
Remove a particle system for the list of scene's particle systems
Parameters
- toRemove: IParticleSystem
  defines the particle system to remove
Returns number
the index where the particle system was in the particle system list
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3447

removePendingData

removePendingData(data: any): void
Remove a pending data from the loading list which has previously been added with addPendingData.
Parameters
- data: any
  defines the object to remove from the pending list
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3315

removeReflectionProbe

removeReflectionProbe(toRemove: ReflectionProbe): number
Removes the given reflection probe from this scene.
Parameters
- toRemove: ReflectionProbe
  The reflection probe to remove
Returns number
The index of the removed reflection probe
- Defined in .temp/typedoc/docdirectory/doc.d.ts:20552

removeSkeleton

removeSkeleton(toRemove: Skeleton): number
Remove a skeleton for the list of scene's skeletons
Parameters
- toRemove: Skeleton
  defines the skeleton to remove
Returns number
the index where the skeleton was in the skeleton list
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3423

removeTexture

removeTexture(toRemove: BaseTexture): number
Removes the given texture from this scene.
Parameters
- toRemove: BaseTexture
  The texture to remove
Returns number
The index of the removed texture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3491

removeTransformNode

removeTransformNode(toRemove: TransformNode): number
Remove a transform node for the list of scene's transform nodes
Parameters
- toRemove: TransformNode
  defines the transform node to remove
Returns number
the index where the transform node was in the transform node list
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3417

render

render(updateCameras?: boolean, ignoreAnimations?: boolean): void
Render the scene
Parameters
- OptionalupdateCameras: boolean
  defines a boolean indicating if cameras must update according to their inputs (true by default)
- OptionalignoreAnimations: boolean
  defines a boolean indicating if animations should not be executed (false by default)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3990

resetCachedMaterial

resetCachedMaterial(): void
Resets all cached information relative to material (including effect and visibility)

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

resetDrawCache

resetDrawCache(passId?: number): void
Resets the draw wrappers cache of all meshes
Parameters
- OptionalpassId: number
  If provided, releases only the draw wrapper corresponding to this render pass id
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3979

resetLastAnimationTimeFrame

resetLastAnimationTimeFrame(): void
Resets the last animation time frame. Useful to override when animations start running when loading a scene for the first time.

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

setActiveCameraById

setActiveCameraById(id: string): Nullable<Camera>
sets the active camera of the scene using its Id
Parameters
- id: string
  defines the camera's Id
Returns Nullable<Camera>
the new active camera or null if none found.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3568

setActiveCameraByID

setActiveCameraByID(id: string): Nullable<Camera>
Sets the active camera of the scene using its Id
Parameters
- id: string
  defines the camera's Id
Returns Nullable<Camera>
the new active camera or null if none found.

Deprecated
Please use setActiveCameraById instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4255

setActiveCameraByName

setActiveCameraByName(name: string): Nullable<Camera>
sets the active camera of the scene using its name
Parameters
- name: string
  defines the camera's name
Returns Nullable<Camera>
the new active camera or null if none found.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3574

setDefaultCandidateProviders

setDefaultCandidateProviders(): void
Sets the default candidate providers for the scene. This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates and getCollidingSubMeshCandidates to their default function

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

setPointerOverMesh

setPointerOverMesh(
    mesh: Nullable<AbstractMesh>,
    pointerId?: number,
    pickResult?: Nullable<PickingInfo>,
): void
Force the value of meshUnderPointer
Parameters
- mesh: Nullable<AbstractMesh>
  defines the mesh to use
- OptionalpointerId: number
  optional pointer id when using more than one pointer
- OptionalpickResult: Nullable<PickingInfo>
  optional pickingInfo data used to find mesh
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4126

setPointerOverSprite

setPointerOverSprite(sprite: Nullable<Sprite>): void
Force the sprite under the pointer
Parameters
- sprite: Nullable<Sprite>
  defines the sprite to use
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:11285

setRenderingAutoClearDepthStencil

setRenderingAutoClearDepthStencil(
    renderingGroupId: number,
    autoClearDepthStencil: boolean,
    depth?: boolean,
    stencil?: boolean,
): void
Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
Parameters
- renderingGroupId: number
  The rendering group id corresponding to its index
- autoClearDepthStencil: boolean
  Automatically clears depth and stencil between groups if true.
- Optionaldepth: boolean
  Automatically clears depth between groups if true and autoClear is true.
- Optionalstencil: boolean
  Automatically clears stencil between groups if true and autoClear is true.
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4197

setRenderingOrder

setRenderingOrder(
    renderingGroupId: number,
    opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>,
    alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>,
    transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>,
): void
Overrides the default sort function applied in the rendering group to prepare the meshes. This allowed control for front to back rendering or reversly depending of the special needs.
Parameters
- renderingGroupId: number
  The rendering group id corresponding to its index
- OptionalopaqueSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>
  The opaque queue comparison function use to sort.
- OptionalalphaTestSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>
  The alpha test queue comparison function use to sort.
- OptionaltransparentSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>
  The transparent queue comparison function use to sort.
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4188

setSceneUniformBuffer

setSceneUniformBuffer(ubo: UniformBuffer): void
Sets the scene ubo
Parameters
- ubo: UniformBuffer
  the ubo to set for the scene
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3388

setStepId

setStepId(newStepId: number): void
Sets the step Id used by deterministic lock step
Parameters
- newStepId: number
  defines the step Id
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/animation/advanced_animations#deterministic-lockstep
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2662

setTransformMatrix

setTransformMatrix(
    viewL: Matrix,
    projectionL: Matrix,
    viewR?: Matrix,
    projectionR?: Matrix,
): void
Sets the current transform matrix
Parameters
- viewL: Matrix
  defines the View matrix to use
- projectionL: Matrix
  defines the Projection matrix to use
- OptionalviewR: Matrix
  defines the right View matrix to use (if provided)
- OptionalprojectionR: Matrix
  defines the right Projection matrix to use (if provided)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3372

simulatePointerDown

simulatePointerDown(
pickResult: PickingInfo,
pointerEventInit?: PointerEventInit,
): Scene
Use this method to simulate a pointer down on a mesh The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
Parameters
- pickResult: PickingInfo
  pickingInfo of the object wished to simulate pointer event on
- OptionalpointerEventInit: PointerEventInit
  pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
Returns Scene
the current scene
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3243

simulatePointerMove

simulatePointerMove(
pickResult: PickingInfo,
pointerEventInit?: PointerEventInit,
): Scene
Use this method to simulate a pointer move on a mesh The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
Parameters
- pickResult: PickingInfo
  pickingInfo of the object wished to simulate pointer event on
- OptionalpointerEventInit: PointerEventInit
  pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
Returns Scene
the current scene
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3235

simulatePointerUp

simulatePointerUp(
    pickResult: PickingInfo,
    pointerEventInit?: PointerEventInit,
    doubleTap?: boolean,
): Scene
Use this method to simulate a pointer up on a mesh The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
Parameters
- pickResult: PickingInfo
  pickingInfo of the object wished to simulate pointer event on
- OptionalpointerEventInit: PointerEventInit
  pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
- OptionaldoubleTap: boolean
  indicates that the pointer up event should be considered as part of a double click (false by default)
Returns Scene
the current scene
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3252

sortActiveAnimatables

sortActiveAnimatables(): void
Sort active animatables based on their playOrder property

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

sortLightsByPriority

sortLightsByPriority(): void
Sorts the list list based on light priorities

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

stopAllAnimations

stopAllAnimations(): void
Stops and removes all animations that have been applied to the scene

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

stopAnimation

stopAnimation(
    target: any,
    animationName?: string,
    targetMask?: (target: any) => boolean,
): void
Will stop the animation of the given target
Parameters
- target: any
  the target
- OptionalanimationName: string
  the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
- OptionaltargetMask: (target: any) => boolean
  a function that determines if the animation should be stopped based on its target (all animations will be stopped if both this and animationName are empty)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3460

switchActiveCamera

switchActiveCamera(newCamera: Camera, attachControl?: boolean): void
Switch active camera
Parameters
- newCamera: Camera
  defines the new active camera
- OptionalattachControl: boolean
  defines if attachControl must be called for the new active camera (default: true)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3562

unfreezeActiveMeshes

unfreezeActiveMeshes(): Scene
Use this function to restart evaluating active meshes on every frame

Returns Scene
the current scene
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3937

unfreezeMaterials

unfreezeMaterials(): void
Unfreeze all materials A frozen material will not be updatable but should be faster to render

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

unregisterAfterRender

unregisterAfterRender(func: () => void): void
Unregisters a function called after every frame render
Parameters
- func: () => void
  defines the function to unregister
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3296

unregisterBeforeRender

unregisterBeforeRender(func: () => void): void
Unregisters a function called before every frame render
Parameters
- func: () => void
  defines the function to unregister
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3286

updateTransformMatrix

updateTransformMatrix(force?: boolean): void
Update the transform matrix to update from the current active camera
Parameters
- Optionalforce: boolean
  defines a boolean used to force the update even if cache is up to date
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3947

whenReadyAsync

whenReadyAsync(checkRenderTargets?: boolean): Promise<void>
Returns a promise that resolves when the scene is ready
Parameters
- OptionalcheckRenderTargets: boolean
  true to also check that the meshes rendered as part of a render target are ready (default: false)
Returns Promise<void>
A promise that resolves when the scene is ready
- Defined in .temp/typedoc/docdirectory/doc.d.ts:3336

`Static`CollisionCoordinatorFactory

CollisionCoordinatorFactory(): ICollisionCoordinator
Factory used to create the a collision coordinator.

Returns ICollisionCoordinator
The collision coordinator
- Defined in .temp/typedoc/docdirectory/doc.d.ts:2003

`Static`DefaultMaterialFactory

DefaultMaterialFactory(scene: Scene): Material
Factory used to create the default material.
Parameters
- scene: Scene
  The scene to create the material for
Returns Material
The default material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:1997

Class Scene

See

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Scene

Properties

_afterRenderTargetPostProcessStage

actionManager

See

actionManagers

ambientColor

animationGroups

See

animations

animationsEnabled

animationTimeScale

See

audioEnabled

See

audioListenerPositionProvider

See

audioListenerRotationProvider

See

audioPositioningRefreshRate

autoClear

autoClearDepthAndStencil

cameras

See

cameraToUseForPointers

clipPlane

clipPlane2

clipPlane3

clipPlane4

clipPlane5

clipPlane6

collisionsEnabled

See

constantlyUpdateMeshUnderPointer

customLODSelector

OptionalcustomRenderFunction

customRenderTargets

debugLayer

See

defaultCursor

deltaTime

depthPeelingRenderer

disableOfflineSupportExceptionRules

dispatchAllSubMeshesOfActiveMeshes

doNotHandleCursors

dumpNextRenderTargets

effectLayers

See

environmentBRDFTexture

environmentIntensity

fluidRenderer

fogColor

See

fogDensity

See

fogEnd

See

fogStart

See

forceShowBoundingBoxes

frameGraphs

gamepadManager

See

geometries

geometryBufferRenderer

getActiveMeshCandidates

getActiveSubMeshCandidates

getCollidingSubMeshCandidates

getDeterministicFrameTime

`Optional`customRenderFunction