Class: PScene

Defined in: packages/core/sdk/src/core/PScene.ts:5

Extends

• Scene

Constructors

Constructor

new PScene(engine, options?): PScene

Defined in: packages/core/sdk/src/core/PScene.ts:7

Parameters

engine

AbstractEngine

options?

SceneOptions

Returns

PScene

Overrides

Scene.constructor

Properties

_activeAnimatables

_activeAnimatables: Animatable[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:1049

Internal

Inherited from

Scene._activeAnimatables

---

_activeBones

_activeBones: PerfCounter

Defined in: node_modules/@babylonjs/core/scene.d.ts:1000

Internal

Inherited from

Scene._activeBones

---

_activeCamera

_activeCamera: Camera

Defined in: node_modules/@babylonjs/core/scene.d.ts:881

Internal

Inherited from

Scene._activeCamera

---

_activeIndices

_activeIndices: PerfCounter

Defined in: node_modules/@babylonjs/core/scene.d.ts:996

Internal

Inherited from

Scene._activeIndices

---

_activeMeshesFrozen

_activeMeshesFrozen: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:2046

Internal

Inherited from

Scene._activeMeshesFrozen

---

_activeMeshesFrozenButKeepClipping

_activeMeshesFrozenButKeepClipping: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:2048

Internal

Inherited from

Scene._activeMeshesFrozenButKeepClipping

---

_activeParticles

_activeParticles: PerfCounter

Defined in: node_modules/@babylonjs/core/scene.d.ts:998

Internal

Inherited from

Scene._activeParticles

---

_activeParticleSystems

_activeParticleSystems: SmartArray<IParticleSystem>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1040

Internal

Inherited from

Scene._activeParticleSystems

---

_afterCameraDrawStage

_afterCameraDrawStage: Stage<CameraStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1192

Internal

Defines the actions happening just after the active camera has been drawn.

Inherited from

Scene._afterCameraDrawStage

---

_afterCameraPostProcessStage

_afterCameraPostProcessStage: Stage<CameraStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1197

Internal

Defines the actions happening just after the post processing

Inherited from

Scene._afterCameraPostProcessStage

---

_afterRenderingGroupDrawStage

_afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1187

Internal

Defines the actions happening just after a rendering group has been drawn.

Inherited from

Scene._afterRenderingGroupDrawStage

---

_afterRenderingMeshStage

_afterRenderingMeshStage: Stage<RenderingMeshStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1182

Internal

Defines the actions happening just after a mesh has been drawn.

Inherited from

Scene._afterRenderingMeshStage

---

_afterRenderStage

_afterRenderStage: Stage<SimpleStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1211

Internal

Defines the actions happening just after rendering all cameras and computing intersections.

Inherited from

Scene._afterRenderStage

---

_afterRenderTargetDrawStage

_afterRenderTargetDrawStage: Stage<RenderTargetStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1202

Internal

Defines the actions happening just after a render target has been drawn.

Inherited from

Scene._afterRenderTargetDrawStage

---

_afterRenderTargetPostProcessStage

_afterRenderTargetPostProcessStage: Stage<RenderTargetStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1206

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

Inherited from

Scene._afterRenderTargetPostProcessStage

---

_allowPostProcessClearColor

_allowPostProcessClearColor: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:2080

Internal

Inherited from

Scene._allowPostProcessClearColor

---

_animationTime

_animationTime: number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1005

Internal

Inherited from

Scene._animationTime

---

_animationTimeLast

_animationTimeLast: number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1003

Internal

Inherited from

Scene._animationTimeLast

---

_beforeCameraDrawStage

_beforeCameraDrawStage: Stage<CameraStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1162

Internal

Defines the actions happening just before the active camera is drawing.

Inherited from

Scene._beforeCameraDrawStage

---

_beforeCameraUpdateStage

_beforeCameraUpdateStage: Stage<SimpleStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1112

Internal

Defines the actions happening before camera updates.

Inherited from

Scene._beforeCameraUpdateStage

---

_beforeClearStage

_beforeClearStage: Stage<SimpleStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1117

Internal

Defines the actions happening before clear the canvas.

Inherited from

Scene._beforeClearStage

---

_beforeEvaluateActiveMeshStage

_beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1142

Internal

Defines the actions happening before evaluate active mesh checks.

Inherited from

Scene._beforeEvaluateActiveMeshStage

---

_beforeRenderingGroupDrawStage

_beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1172

Internal

Defines the actions happening just before a rendering group is drawing.

Inherited from

Scene._beforeRenderingGroupDrawStage

---

_beforeRenderingMeshStage

_beforeRenderingMeshStage: Stage<RenderingMeshStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1177

Internal

Defines the actions happening just before a mesh is drawing.

Inherited from

Scene._beforeRenderingMeshStage

---

_beforeRenderTargetClearStage

_beforeRenderTargetClearStage: Stage<RenderTargetStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1122

Internal

Defines the actions happening before clear the canvas.

Inherited from

Scene._beforeRenderTargetClearStage

---

_beforeRenderTargetDrawStage

_beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1167

Internal

Defines the actions happening just before a render target is drawing.

Inherited from

Scene._beforeRenderTargetDrawStage

---

_blockEntityCollection

_blockEntityCollection: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:151

Internal

Inherited from

Scene._blockEntityCollection

---

_boundingBoxRenderer

_boundingBoxRenderer: BoundingBoxRenderer

Defined in: node_modules/@babylonjs/core/Rendering/boundingBoxRenderer.d.ts:14

Internal

(Backing field)

Inherited from

Scene._boundingBoxRenderer

---

_cachedEffect

_cachedEffect: Effect

Defined in: node_modules/@babylonjs/core/scene.d.ts:1014

Internal

Inherited from

Scene._cachedEffect

---

_cachedMaterial

_cachedMaterial: Material

Defined in: node_modules/@babylonjs/core/scene.d.ts:1012

Internal

Inherited from

Scene._cachedMaterial

---

_cachedRayForTransform

_cachedRayForTransform: Ray

Defined in: node_modules/@babylonjs/core/scene.d.ts:141

Internal

Inherited from

Scene._cachedRayForTransform

---

_cachedVisibility

_cachedVisibility: number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1016

Internal

Inherited from

Scene._cachedVisibility

---

_cameraDrawRenderTargetStage

_cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1157

Internal

Defines the actions happening during the per camera render target step.

Inherited from

Scene._cameraDrawRenderTargetStage

---

_components

_components: ISceneComponent[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:1079

Internal

Backing store of defined scene components.

Inherited from

Scene._components

---

_debugLayer

_debugLayer: DebugLayer

Defined in: node_modules/@babylonjs/core/Debug/debugLayer.d.ts:155

Internal

Backing field

Inherited from

Scene._debugLayer

---

_depthPeelingRenderer

_depthPeelingRenderer: DepthPeelingRenderer

Defined in: node_modules/@babylonjs/core/Rendering/depthPeelingSceneComponent.d.ts:12

Internal

(Backing field)

Inherited from

Scene._depthPeelingRenderer

---

_depthRenderer

_depthRenderer: object

Defined in: node_modules/@babylonjs/core/Rendering/depthRendererSceneComponent.d.ts:9

Internal

(Backing field)

Index Signature

[id: string]: DepthRenderer

Inherited from

Scene._depthRenderer

---

_edgeRenderLineShader

_edgeRenderLineShader: ShaderMaterial

Defined in: node_modules/@babylonjs/core/Rendering/edgesRenderer.d.ts:15

Internal

Inherited from

Scene._edgeRenderLineShader

---

_environmentTexture

protected _environmentTexture: BaseTexture

Defined in: node_modules/@babylonjs/core/scene.d.ts:340

Internal

Inherited from

Scene._environmentTexture

---

_evaluateSubMeshStage

_evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1147

Internal

Defines the actions happening during the evaluate sub mesh checks.

Inherited from

Scene._evaluateSubMeshStage

---

_fluidRenderer

_fluidRenderer: FluidRenderer

Defined in: node_modules/@babylonjs/core/Rendering/fluidRenderer/fluidRenderer.d.ts:12

Internal

(Backing field)

Inherited from

Scene._fluidRenderer

---

_forcedViewPosition

_forcedViewPosition: Vector3

Defined in: node_modules/@babylonjs/core/scene.d.ts:1057

Internal

Inherited from

Scene._forcedViewPosition

---

_forceShowBoundingBoxes

_forceShowBoundingBoxes: boolean

Defined in: node_modules/@babylonjs/core/Rendering/boundingBoxRenderer.d.ts:16

Internal

(Backing field)

Inherited from

Scene._forceShowBoundingBoxes

---

_frustumPlanes

_frustumPlanes: Plane[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:1059

Internal

Inherited from

Scene._frustumPlanes

---

_gamepadManager

_gamepadManager: GamepadManager

Defined in: node_modules/@babylonjs/core/Gamepads/gamepadSceneComponent.d.ts:8

Internal

Inherited from

Scene._gamepadManager

---

_gatherActiveCameraRenderTargetsStage

_gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1132

Internal

Defines the actions happening for one camera in the frame.

Inherited from

Scene._gatherActiveCameraRenderTargetsStage

---

_gatherRenderTargetsStage

_gatherRenderTargetsStage: Stage<RenderTargetsStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1127

Internal

Defines the actions when collecting render targets for the frame.

Inherited from

Scene._gatherRenderTargetsStage

---

_geometryBufferRenderer

_geometryBufferRenderer: GeometryBufferRenderer

Defined in: node_modules/@babylonjs/core/Rendering/geometryBufferRendererSceneComponent.d.ts:8

Internal

(Backing field)

Inherited from

Scene._geometryBufferRenderer

---

_iblCdfGenerator

_iblCdfGenerator: IblCdfGenerator

Defined in: node_modules/@babylonjs/core/Rendering/iblCdfGeneratorSceneComponent.d.ts:8

Internal

(Backing field)

Inherited from

Scene._iblCdfGenerator

---

_imageProcessingConfiguration

protected _imageProcessingConfiguration: ImageProcessingConfiguration

Defined in: node_modules/@babylonjs/core/scene.d.ts:198

Internal

Inherited from

Scene._imageProcessingConfiguration

---

_inputManager

_inputManager: InputManager

Defined in: node_modules/@babylonjs/core/scene.d.ts:145

Internal

Inherited from

Scene._inputManager

---

_isReadyForMeshStage

_isReadyForMeshStage: Stage<MeshStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1137

Internal

Defines the actions happening during the per mesh ready checks.

Inherited from

Scene._isReadyForMeshStage

---

_isScene

readonly _isScene: true = true

Defined in: node_modules/@babylonjs/core/scene.d.ts:149

Internal

Inherited from

Scene._isScene

---

_ltcTextures?

optional _ltcTextures: ILTCTextures

Defined in: node_modules/@babylonjs/core/Lights/areaLight.d.ts:11

Internal

Inherited from

Scene._ltcTextures

---

_mainSoundTrack

_mainSoundTrack: SoundTrack

Defined in: node_modules/@babylonjs/core/Audio/audioSceneComponent.d.ts:15

Internal

Backing field

Inherited from

Scene._mainSoundTrack

---

_meshUVSpaceRendererMaskShader

_meshUVSpaceRendererMaskShader: ShaderMaterial

Defined in: node_modules/@babylonjs/core/Meshes/meshUVSpaceRenderer.d.ts:15

Internal

Inherited from

Scene._meshUVSpaceRendererMaskShader

---

_meshUVSpaceRendererShader

_meshUVSpaceRendererShader: ShaderMaterial

Defined in: node_modules/@babylonjs/core/Meshes/meshUVSpaceRenderer.d.ts:13

Internal

Inherited from

Scene._meshUVSpaceRendererShader

---

_mirroredCameraPosition

_mirroredCameraPosition: Vector3

Defined in: node_modules/@babylonjs/core/scene.d.ts:773

Internal

Inherited from

Scene._mirroredCameraPosition

---

_multiviewSceneUbo

_multiviewSceneUbo: UniformBuffer

Defined in: node_modules/@babylonjs/core/Engines/Extensions/engine.multiview.d.ts:59

Internal

Inherited from

Scene._multiviewSceneUbo

---

_outlineRenderer

_outlineRenderer: OutlineRenderer

Defined in: node_modules/@babylonjs/core/Rendering/outlineRenderer.d.ts:9

Internal

Inherited from

Scene._outlineRenderer

---

_pendingData

_pendingData: any[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:1028

Internal

Inherited from

Scene._pendingData

---

_perfCollector

protected _perfCollector: PerformanceViewerCollector

Defined in: node_modules/@babylonjs/core/scene.d.ts:2370

Internal perfCollector instance used for sharing between inspector and playground. Marked as protected to allow sharing between prototype extensions, but disallow access at toplevel.

Inherited from

Scene._perfCollector

---

_physicsEngine

_physicsEngine: IPhysicsEngine

Defined in: node_modules/@babylonjs/core/Physics/joinedPhysicsEngineComponent.d.ts:15

Internal

(Backing field)

Inherited from

Scene._physicsEngine

---

_physicsTimeAccumulator

_physicsTimeAccumulator: number

Defined in: node_modules/@babylonjs/core/Physics/joinedPhysicsEngineComponent.d.ts:17

Internal

Inherited from

Scene._physicsTimeAccumulator

---

_pickedDownSprite

_pickedDownSprite: Sprite

Defined in: node_modules/@babylonjs/core/Sprites/spriteSceneComponent.d.ts:15

Internal

Inherited from

Scene._pickedDownSprite

---

_pickWithRayInverseMatrix

_pickWithRayInverseMatrix: Matrix

Defined in: node_modules/@babylonjs/core/scene.d.ts:143

Internal

Inherited from

Scene._pickWithRayInverseMatrix

---

_pointerDownStage

_pointerDownStage: Stage<PointerUpDownStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1221

Internal

Defines the actions happening when a pointer down event happens.

Inherited from

Scene._pointerDownStage

---

_pointerMoveStage

_pointerMoveStage: Stage<PointerMoveStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1216

Internal

Defines the actions happening when a pointer move event happens.

Inherited from

Scene._pointerMoveStage

---

_pointerOverSprite

_pointerOverSprite: Sprite

Defined in: node_modules/@babylonjs/core/Sprites/spriteSceneComponent.d.ts:13

Internal

Inherited from

Scene._pointerOverSprite

---

_pointerUpStage

_pointerUpStage: Stage<PointerUpDownStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1226

Internal

Defines the actions happening when a pointer up event happens.

Inherited from

Scene._pointerUpStage

---

_postProcessRenderPipelineManager

_postProcessRenderPipelineManager: PostProcessRenderPipelineManager

Defined in: node_modules/@babylonjs/core/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent.d.ts:7

Internal

(Backing field)

Inherited from

Scene._postProcessRenderPipelineManager

---

_preActiveMeshStage

_preActiveMeshStage: Stage<PreActiveMeshStageAction>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1152

Internal

Defines the actions happening during the active mesh stage.

Inherited from

Scene._preActiveMeshStage

---

_prePassRenderer

_prePassRenderer: PrePassRenderer

Defined in: node_modules/@babylonjs/core/Rendering/prePassRendererSceneComponent.d.ts:9

Internal

(Backing field)

Inherited from

Scene._prePassRenderer

---

_projectionMatrix

_projectionMatrix: Matrix

Defined in: node_modules/@babylonjs/core/scene.d.ts:1055

Internal

Inherited from

Scene._projectionMatrix

---

_registeredActions

_registeredActions: number

Defined in: node_modules/@babylonjs/core/scene.d.ts:2198

Internal

Inherited from

Scene._registeredActions

---

_registeredForLateAnimationBindings

_registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>

Defined in: node_modules/@babylonjs/core/scene.d.ts:661

Internal

Inherited from

Scene._registeredForLateAnimationBindings

---

_selectionOctree

_selectionOctree: Octree<AbstractMesh>

Defined in: node_modules/@babylonjs/core/Culling/Octrees/octreeSceneComponent.d.ts:14

Internal

Backing Filed

Inherited from

Scene._selectionOctree

---

_serializableComponents

_serializableComponents: ISceneSerializableComponent[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:1084

Internal

Backing store of defined scene components.

Inherited from

Scene._serializableComponents

---

_simplificationQueue

_simplificationQueue: SimplificationQueue

Defined in: node_modules/@babylonjs/core/Meshes/meshSimplificationSceneComponent.d.ts:8

Internal

(Backing field)

Inherited from

Scene._simplificationQueue

---

_subSurfaceConfiguration

_subSurfaceConfiguration: SubSurfaceConfiguration

Defined in: node_modules/@babylonjs/core/Rendering/subSurfaceSceneComponent.d.ts:8

Internal

(Backing field)

Inherited from

Scene._subSurfaceConfiguration

---

_tempPickingRay

_tempPickingRay: Ray

Defined in: node_modules/@babylonjs/core/scene.d.ts:139

Internal

Inherited from

Scene._tempPickingRay

---

_tempSpritePickingRay

_tempSpritePickingRay: Ray

Defined in: node_modules/@babylonjs/core/Sprites/spriteSceneComponent.d.ts:17

Internal

Inherited from

Scene._tempSpritePickingRay

---

_toBeDisposed

_toBeDisposed: IDisposable[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:1025

Internal

Inherited from

Scene._toBeDisposed

---

_transformMatrixR

_transformMatrixR: Matrix

Defined in: node_modules/@babylonjs/core/Engines/Extensions/engine.multiview.d.ts:57

Internal

Inherited from

Scene._transformMatrixR

---

_useCurrentFrameBuffer

_useCurrentFrameBuffer: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:2076

Internal

Inherited from

Scene._useCurrentFrameBuffer

---

_useOrderIndependentTransparency

_useOrderIndependentTransparency: boolean

Defined in: node_modules/@babylonjs/core/Rendering/depthPeelingSceneComponent.d.ts:18

Internal

Inherited from

Scene._useOrderIndependentTransparency

---

_viewMatrix

_viewMatrix: Matrix

Defined in: node_modules/@babylonjs/core/scene.d.ts:1053

Internal

Inherited from

Scene._viewMatrix

---

actionManager

actionManager: AbstractActionManager

Defined in: node_modules/@babylonjs/core/scene.d.ts:987

Gets or sets the action manager associated with the scene

See

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

Inherited from

Scene.actionManager

---

actionManagers

actionManagers: AbstractActionManager[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:334

ActionManagers available on the scene.

Deprecated

Inherited from

Scene.actionManagers

---

ambientColor

ambientColor: Color3

Defined in: node_modules/@babylonjs/core/scene.d.ts:173

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

Inherited from

Scene.ambientColor

---

animationGroups

animationGroups: AnimationGroup[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:299

All of the animation groups added to this scene

See

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

Inherited from

Scene.animationGroups

---

animations

animations: Animation[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:294

Gets a list of Animations associated with the scene

Inherited from

Scene.animations

---

animationsEnabled

animationsEnabled: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:388

Gets or sets a boolean indicating if animations are enabled

Inherited from

Scene.animationsEnabled

---

animationTimeScale

animationTimeScale: number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1010

Gets or sets a general scale for animation speed

See

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

Inherited from

Scene.animationTimeScale

---

audioEnabled

audioEnabled: boolean

Defined in: node_modules/@babylonjs/core/Audio/audioSceneComponent.d.ts:36

Gets or sets if audio support is enabled

See

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

Inherited from

Scene.audioEnabled

---

audioListenerPositionProvider()

audioListenerPositionProvider: () => Vector3

Defined in: node_modules/@babylonjs/core/Audio/audioSceneComponent.d.ts:46

Gets or sets custom audio listener position provider

Returns

Vector3

See

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

Inherited from

Scene.audioListenerPositionProvider

---

audioListenerRotationProvider()

audioListenerRotationProvider: () => Vector3

Defined in: node_modules/@babylonjs/core/Audio/audioSceneComponent.d.ts:51

Gets or sets custom audio listener rotation provider

Returns

Vector3

See

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

Inherited from

Scene.audioListenerRotationProvider

---

audioPositioningRefreshRate

audioPositioningRefreshRate: number

Defined in: node_modules/@babylonjs/core/Audio/audioSceneComponent.d.ts:55

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

Inherited from

Scene.audioPositioningRefreshRate

---

autoClear

autoClear: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:155

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

Inherited from

Scene.autoClear

---

autoClearDepthAndStencil

autoClearDepthAndStencil: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:159

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

Inherited from

Scene.autoClearDepthAndStencil

---

cameras

cameras: Camera[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:267

All of the cameras added to this scene

See

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

Inherited from

Scene.cameras

---

cameraToUseForPointers

cameraToUseForPointers: Camera

Defined in: node_modules/@babylonjs/core/scene.d.ts:147

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

Inherited from

Scene.cameraToUseForPointers

---

clipPlane

clipPlane: Plane

Defined in: node_modules/@babylonjs/core/scene.d.ts:239

Gets or sets the active clipplane 1

Inherited from

Scene.clipPlane

---

clipPlane2

clipPlane2: Plane

Defined in: node_modules/@babylonjs/core/scene.d.ts:243

Gets or sets the active clipplane 2

Inherited from

Scene.clipPlane2

---

clipPlane3

clipPlane3: Plane

Defined in: node_modules/@babylonjs/core/scene.d.ts:247

Gets or sets the active clipplane 3

Inherited from

Scene.clipPlane3

---

clipPlane4

clipPlane4: Plane

Defined in: node_modules/@babylonjs/core/scene.d.ts:251

Gets or sets the active clipplane 4

Inherited from

Scene.clipPlane4

---

clipPlane5

clipPlane5: Plane

Defined in: node_modules/@babylonjs/core/scene.d.ts:255

Gets or sets the active clipplane 5

Inherited from

Scene.clipPlane5

---

clipPlane6

clipPlane6: Plane

Defined in: node_modules/@babylonjs/core/scene.d.ts:259

Gets or sets the active clipplane 6

Inherited from

Scene.clipPlane6

---

collisionsEnabled

collisionsEnabled: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:935

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

See

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

Inherited from

Scene.collisionsEnabled

---

constantlyUpdateMeshUnderPointer

constantlyUpdateMeshUnderPointer: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:404

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

Inherited from

Scene.constantlyUpdateMeshUnderPointer

---

customLODSelector()

customLODSelector: (mesh, camera) => AbstractMesh

Defined in: node_modules/@babylonjs/core/scene.d.ts:659

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

Parameters

mesh

AbstractMesh

camera

Camera

Returns

AbstractMesh

Inherited from

Scene.customLODSelector

---

customRenderFunction()?

optional customRenderFunction: (updateCameras, ignoreAnimations) => void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2110

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

Parameters

updateCameras

boolean

ignoreAnimations

boolean

Returns

void

Inherited from

Scene.customRenderFunction

---

customRenderTargets

customRenderTargets: RenderTargetTexture[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:964

The list of user defined render targets added to the scene

Inherited from

Scene.customRenderTargets

---

debugLayer

debugLayer: DebugLayer

Defined in: node_modules/@babylonjs/core/Debug/debugLayer.d.ts:160

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

See

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

Inherited from

Scene.debugLayer

---

defaultCursor

defaultCursor: string

Defined in: node_modules/@babylonjs/core/scene.d.ts:412

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

Inherited from

Scene.defaultCursor

---

deltaTime

deltaTime: number

Defined in: node_modules/@babylonjs/core/scene.d.ts:290

Gets the current delta time used by animation engine

Inherited from

Scene.deltaTime

---

depthPeelingRenderer

depthPeelingRenderer: DepthPeelingRenderer

Defined in: node_modules/@babylonjs/core/Rendering/depthPeelingSceneComponent.d.ts:10

The depth peeling renderer

Inherited from

Scene.depthPeelingRenderer

---

disableOfflineSupportExceptionRules

disableOfflineSupportExceptionRules: RegExp[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:442

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

Inherited from

Scene.disableOfflineSupportExceptionRules

---

dispatchAllSubMeshesOfActiveMeshes

dispatchAllSubMeshesOfActiveMeshes: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:1034

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)

Inherited from

Scene.dispatchAllSubMeshesOfActiveMeshes

---

doNotHandleCursors

doNotHandleCursors: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:416

Defines whether cursors are handled by the scene.

Inherited from

Scene.doNotHandleCursors

---

dumpNextRenderTargets

dumpNextRenderTargets: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:960

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

Inherited from

Scene.dumpNextRenderTargets

---

effectLayers

effectLayers: EffectLayer[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:362

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

See

• https://doc.babylonjs.com/features/featuresDeepDive/mesh/highlightLayer
• https://doc.babylonjs.com/features/featuresDeepDive/mesh/glowLayer

Inherited from

Scene.effectLayers

---

environmentBRDFTexture

environmentBRDFTexture: BaseTexture

Defined in: node_modules/@babylonjs/core/scene.d.ts:182

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.

Inherited from

Scene.environmentBRDFTexture

---

environmentIntensity

environmentIntensity: number

Defined in: node_modules/@babylonjs/core/scene.d.ts:191

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.

Inherited from

Scene.environmentIntensity

---

fluidRenderer

fluidRenderer: FluidRenderer

Defined in: node_modules/@babylonjs/core/Rendering/fluidRenderer/fluidRenderer.d.ts:16

Gets or Sets the fluid renderer associated to the scene.

Inherited from

Scene.fluidRenderer

---

fogColor

fogColor: Color3

Defined in: node_modules/@babylonjs/core/scene.d.ts:836

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

Inherited from

Scene.fogColor

---

fogDensity

fogDensity: number

Defined in: node_modules/@babylonjs/core/scene.d.ts:842

Gets or sets the fog density to use

See

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

Inherited from

Scene.fogDensity

---

fogEnd

fogEnd: number

Defined in: node_modules/@babylonjs/core/scene.d.ts:854

Gets or sets the fog end distance to use

See

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

Inherited from

Scene.fogEnd

---

fogStart

fogStart: number

Defined in: node_modules/@babylonjs/core/scene.d.ts:848

Gets or sets the fog start distance to use

See

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

Inherited from

Scene.fogStart

---

forceShowBoundingBoxes

forceShowBoundingBoxes: boolean

Defined in: node_modules/@babylonjs/core/Rendering/boundingBoxRenderer.d.ts:20

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

Inherited from

Scene.forceShowBoundingBoxes

---

frameGraphs

frameGraphs: FrameGraph[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:908

List of frame graphs associated with the scene

Inherited from

Scene.frameGraphs

---

gamepadManager

gamepadManager: GamepadManager

Defined in: node_modules/@babylonjs/core/Gamepads/gamepadSceneComponent.d.ts:13

Gets the gamepad manager associated with the scene

See

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

Inherited from

Scene.gamepadManager

---

geometries

geometries: Geometry[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:321

The list of geometries used in the scene.

Inherited from

Scene.geometries

---

geometryBufferRenderer

geometryBufferRenderer: GeometryBufferRenderer

Defined in: node_modules/@babylonjs/core/Rendering/geometryBufferRendererSceneComponent.d.ts:12

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

Inherited from

Scene.geometryBufferRenderer

---

getActiveMeshCandidates()

getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>

Defined in: node_modules/@babylonjs/core/scene.d.ts:2032

Lambda returning the list of potentially active meshes.

Returns

ISmartArrayLike<AbstractMesh>

Inherited from

Scene.getActiveMeshCandidates

---

getActiveSubMeshCandidates()

getActiveSubMeshCandidates: (mesh) => ISmartArrayLike<SubMesh>

Defined in: node_modules/@babylonjs/core/scene.d.ts:2036

Lambda returning the list of potentially active sub meshes.

Parameters

mesh

AbstractMesh

Returns

ISmartArrayLike<SubMesh>

Inherited from

Scene.getActiveSubMeshCandidates

---

getCollidingSubMeshCandidates()

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

Defined in: node_modules/@babylonjs/core/scene.d.ts:2044

Lambda returning the list of potentially colliding sub meshes.

Parameters

mesh

AbstractMesh

collider

Collider

Returns

ISmartArrayLike<SubMesh>

Inherited from

Scene.getCollidingSubMeshCandidates

---

getDeterministicFrameTime()

getDeterministicFrameTime: () => number

Defined in: node_modules/@babylonjs/core/scene.d.ts:2095

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

Returns

number

the frame time

Inherited from

Scene.getDeterministicFrameTime

---

getIntersectingSubMeshCandidates()

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

Defined in: node_modules/@babylonjs/core/scene.d.ts:2040

Lambda returning the list of potentially intersecting sub meshes.

Parameters

mesh

AbstractMesh

localRay

Ray

Returns

ISmartArrayLike<SubMesh>

Inherited from

Scene.getIntersectingSubMeshCandidates

---

gravity

gravity: Vector3

Defined in: node_modules/@babylonjs/core/scene.d.ts:943

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

See

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

Inherited from

Scene.gravity

---

headphone

headphone: boolean

Defined in: node_modules/@babylonjs/core/Audio/audioSceneComponent.d.ts:41

Gets or sets if audio will be output to headphones

See

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

Inherited from

Scene.headphone

---

hoverCursor

hoverCursor: string

Defined in: node_modules/@babylonjs/core/scene.d.ts:408

Defines the HTML cursor to use when hovering over interactive elements

Inherited from

Scene.hoverCursor

---

iblCdfGenerator

iblCdfGenerator: IblCdfGenerator

Defined in: node_modules/@babylonjs/core/Rendering/iblCdfGeneratorSceneComponent.d.ts:15

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.

Inherited from

Scene.iblCdfGenerator

---

iblIntensity

iblIntensity: number

Defined in: node_modules/@babylonjs/core/scene.d.ts:196

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

Inherited from

Scene.iblIntensity

---

importedMeshesFiles

importedMeshesFiles: string[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:973

Gets the list of meshes imported to the scene through SceneLoader

Inherited from

Scene.importedMeshesFiles

---

layers

layers: Layer[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:370

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

Inherited from

Scene.layers

---

lensFlaresEnabled

lensFlaresEnabled: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:930

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

Inherited from

Scene.lensFlaresEnabled

---

lensFlareSystems

lensFlareSystems: LensFlareSystem[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:375

The list of lens flare system added to the scene

See

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

Inherited from

Scene.lensFlareSystems

---

lights

lights: Light[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:272

All of the lights added to this scene

See

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

Inherited from

Scene.lights

---

loadingPluginName

loadingPluginName: string

Defined in: node_modules/@babylonjs/core/scene.d.ts:438

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

Inherited from

Scene.loadingPluginName

---

mainSoundTrack

mainSoundTrack: SoundTrack

Defined in: node_modules/@babylonjs/core/Audio/audioSceneComponent.d.ts:20

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

Inherited from

Scene.mainSoundTrack

---

materials

materials: Material[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:312

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

Inherited from

Scene.materials

---

meshes

meshes: AbstractMesh[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:276

All of the (abstract) meshes added to this scene

Inherited from

Scene.meshes

---

metadata

metadata: any

Defined in: node_modules/@babylonjs/core/scene.d.ts:430

Gets or sets user defined metadata

Inherited from

Scene.metadata

---

morphTargetManagers

morphTargetManagers: MorphTargetManager[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:317

The list of morph target managers added to the scene

See

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

Inherited from

Scene.morphTargetManagers

---

multiMaterials

multiMaterials: MultiMaterial[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:304

All of the multi-materials added to this scene

See

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

Inherited from

Scene.multiMaterials

---

needsPreviousWorldMatrices

needsPreviousWorldMatrices: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:862

Flag indicating if we need to store previous matrices when rendering

Inherited from

Scene.needsPreviousWorldMatrices

---

offlineProvider

offlineProvider: IOfflineProvider

Defined in: node_modules/@babylonjs/core/scene.d.ts:982

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

See

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

Inherited from

Scene.offlineProvider

---

onActiveCameraChanged

onActiveCameraChanged: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:619

An event triggered when the activeCamera property is updated

Inherited from

Scene.onActiveCameraChanged

---

onActiveCamerasChanged

onActiveCamerasChanged: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:623

An event triggered when the activeCameras property is updated

Inherited from

Scene.onActiveCamerasChanged

---

onAfterActiveMeshesEvaluationObservable

onAfterActiveMeshesEvaluationObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:511

An event triggered when active meshes evaluation is done

Inherited from

Scene.onAfterActiveMeshesEvaluationObservable

---

onAfterAnimationsObservable

onAfterAnimationsObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:476

An event triggered after animations processing

Inherited from

Scene.onAfterAnimationsObservable

---

onAfterCameraRenderObservable

onAfterCameraRenderObservable: Observable<Camera>

Defined in: node_modules/@babylonjs/core/scene.d.ts:500

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

Inherited from

Scene.onAfterCameraRenderObservable

---

onAfterDrawPhaseObservable

onAfterDrawPhaseObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:484

An event triggered after draw calls have been sent

Inherited from

Scene.onAfterDrawPhaseObservable

---

onAfterParticlesRenderingObservable

onAfterParticlesRenderingObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:521

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)

Inherited from

Scene.onAfterParticlesRenderingObservable

---

onAfterPhysicsObservable

onAfterPhysicsObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/Physics/joinedPhysicsEngineComponent.d.ts:51

An event triggered when physic simulation has been done

Inherited from

Scene.onAfterPhysicsObservable

---

onAfterRenderCameraObservable

onAfterRenderCameraObservable: Observable<Camera>

Defined in: node_modules/@babylonjs/core/scene.d.ts:465

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

Inherited from

Scene.onAfterRenderCameraObservable

---

onAfterRenderingGroupObservable

onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>

Defined in: node_modules/@babylonjs/core/scene.d.ts:635

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)

Inherited from

Scene.onAfterRenderingGroupObservable

---

onAfterRenderObservable

onAfterRenderObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:460

An event triggered after rendering the scene

Inherited from

Scene.onAfterRenderObservable

---

onAfterRenderTargetsRenderObservable

onAfterRenderTargetsRenderObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:607

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

Inherited from

Scene.onAfterRenderTargetsRenderObservable

---

onAfterSpritesRenderingObservable

onAfterSpritesRenderingObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/Sprites/spriteSceneComponent.d.ts:32

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)

Inherited from

Scene.onAfterSpritesRenderingObservable

---

onAfterStepObservable

onAfterStepObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:615

An event triggered after calculating deterministic simulation step

Inherited from

Scene.onAfterStepObservable

---

onAnimationFileImportedObservable

onAnimationFileImportedObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:643

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

Inherited from

Scene.onAnimationFileImportedObservable

---

onBeforeActiveMeshesEvaluationObservable

onBeforeActiveMeshesEvaluationObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:507

An event triggered when active meshes evaluation is about to start

Inherited from

Scene.onBeforeActiveMeshesEvaluationObservable

---

onBeforeAnimationsObservable

onBeforeAnimationsObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:472

An event triggered before animating the scene

Inherited from

Scene.onBeforeAnimationsObservable

---

onBeforeCameraRenderObservable

onBeforeCameraRenderObservable: Observable<Camera>

Defined in: node_modules/@babylonjs/core/scene.d.ts:492

An event triggered before rendering a camera

Inherited from

Scene.onBeforeCameraRenderObservable

---

onBeforeDrawPhaseObservable

onBeforeDrawPhaseObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:480

An event triggered before draw calls are ready to be sent

Inherited from

Scene.onBeforeDrawPhaseObservable

---

onBeforeParticlesRenderingObservable

onBeforeParticlesRenderingObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:516

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)

Inherited from

Scene.onBeforeParticlesRenderingObservable

---

onBeforePhysicsObservable

onBeforePhysicsObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/Physics/joinedPhysicsEngineComponent.d.ts:47

An event triggered when physic simulation is about to be run

Inherited from

Scene.onBeforePhysicsObservable

---

onBeforeRenderingGroupObservable

onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>

Defined in: node_modules/@babylonjs/core/scene.d.ts:629

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)

Inherited from

Scene.onBeforeRenderingGroupObservable

---

onBeforeRenderObservable

onBeforeRenderObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:453

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

Inherited from

Scene.onBeforeRenderObservable

---

onBeforeRenderTargetsRenderObservable

onBeforeRenderTargetsRenderObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:602

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

Inherited from

Scene.onBeforeRenderTargetsRenderObservable

---

onBeforeSpritesRenderingObservable

onBeforeSpritesRenderingObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/Sprites/spriteSceneComponent.d.ts:27

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)

Inherited from

Scene.onBeforeSpritesRenderingObservable

---

onBeforeStepObservable

onBeforeStepObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:611

An event triggered before calculating deterministic simulation step

Inherited from

Scene.onBeforeStepObservable

---

onCameraRemovedObservable

onCameraRemovedObservable: Observable<Camera>

Defined in: node_modules/@babylonjs/core/scene.d.ts:533

An event triggered when a camera is removed

Inherited from

Scene.onCameraRemovedObservable

---

onClearColorChangedObservable

onClearColorChangedObservable: Observable<Color4>

Defined in: node_modules/@babylonjs/core/scene.d.ts:164

Observable triggered when the performance priority is changed

Inherited from

Scene.onClearColorChangedObservable

---

onDataLoadedObservable

onDataLoadedObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:525

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

Inherited from

Scene.onDataLoadedObservable

---

onDisposeObservable

onDisposeObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:446

An event triggered when the scene is disposed.

Inherited from

Scene.onDisposeObservable

---

onEnvironmentTextureChangedObservable

onEnvironmentTextureChangedObservable: Observable<BaseTexture>

Defined in: node_modules/@babylonjs/core/scene.d.ts:647

An event triggered when the environmentTexture is changed.

Inherited from

Scene.onEnvironmentTextureChangedObservable

---

onGeometryRemovedObservable

onGeometryRemovedObservable: Observable<Geometry>

Defined in: node_modules/@babylonjs/core/scene.d.ts:549

An event triggered when a geometry is removed

Inherited from

Scene.onGeometryRemovedObservable

---

onKeyboardObservable

onKeyboardObservable: Observable<KeyboardInfo>

Defined in: node_modules/@babylonjs/core/scene.d.ts:782

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

Inherited from

Scene.onKeyboardObservable

---

onLightRemovedObservable

onLightRemovedObservable: Observable<Light>

Defined in: node_modules/@babylonjs/core/scene.d.ts:541

An event triggered when a light is removed

Inherited from

Scene.onLightRemovedObservable

---

onMaterialRemovedObservable

onMaterialRemovedObservable: Observable<Material>

Defined in: node_modules/@babylonjs/core/scene.d.ts:585

An event triggered when a material is removed

Inherited from

Scene.onMaterialRemovedObservable

---

onMeshImportedObservable

onMeshImportedObservable: Observable<AbstractMesh>

Defined in: node_modules/@babylonjs/core/scene.d.ts:639

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

Inherited from

Scene.onMeshImportedObservable

---

onMeshRemovedObservable

onMeshRemovedObservable: Observable<AbstractMesh>

Defined in: node_modules/@babylonjs/core/scene.d.ts:565

An event triggered when a mesh is removed

Inherited from

Scene.onMeshRemovedObservable

---

onMeshUnderPointerUpdatedObservable

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

Defined in: node_modules/@babylonjs/core/scene.d.ts:651

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

Inherited from

Scene.onMeshUnderPointerUpdatedObservable

---

onMultiMaterialRemovedObservable

onMultiMaterialRemovedObservable: Observable<MultiMaterial>

Defined in: node_modules/@babylonjs/core/scene.d.ts:589

An event triggered when a multi material is removed

Inherited from

Scene.onMultiMaterialRemovedObservable

---

onNewCameraAddedObservable

onNewCameraAddedObservable: Observable<Camera>

Defined in: node_modules/@babylonjs/core/scene.d.ts:529

An event triggered when a camera is created

Inherited from

Scene.onNewCameraAddedObservable

---

onNewGeometryAddedObservable

onNewGeometryAddedObservable: Observable<Geometry>

Defined in: node_modules/@babylonjs/core/scene.d.ts:545

An event triggered when a geometry is created

Inherited from

Scene.onNewGeometryAddedObservable

---

onNewLightAddedObservable

onNewLightAddedObservable: Observable<Light>

Defined in: node_modules/@babylonjs/core/scene.d.ts:537

An event triggered when a light is created

Inherited from

Scene.onNewLightAddedObservable

---

onNewMaterialAddedObservable

onNewMaterialAddedObservable: Observable<Material>

Defined in: node_modules/@babylonjs/core/scene.d.ts:577

An event triggered when a material is created

Inherited from

Scene.onNewMaterialAddedObservable

---

onNewMeshAddedObservable

onNewMeshAddedObservable: Observable<AbstractMesh>

Defined in: node_modules/@babylonjs/core/scene.d.ts:561

An event triggered when a mesh is created

Inherited from

Scene.onNewMeshAddedObservable

---

onNewMultiMaterialAddedObservable

onNewMultiMaterialAddedObservable: Observable<MultiMaterial>

Defined in: node_modules/@babylonjs/core/scene.d.ts:581

An event triggered when a multi material is created

Inherited from

Scene.onNewMultiMaterialAddedObservable

---

onNewSkeletonAddedObservable

onNewSkeletonAddedObservable: Observable<Skeleton>

Defined in: node_modules/@babylonjs/core/scene.d.ts:569

An event triggered when a skeleton is created

Inherited from

Scene.onNewSkeletonAddedObservable

---

onNewTextureAddedObservable

onNewTextureAddedObservable: Observable<BaseTexture>

Defined in: node_modules/@babylonjs/core/scene.d.ts:593

An event triggered when a texture is created

Inherited from

Scene.onNewTextureAddedObservable

---

onNewTransformNodeAddedObservable

onNewTransformNodeAddedObservable: Observable<TransformNode>

Defined in: node_modules/@babylonjs/core/scene.d.ts:553

An event triggered when a transform node is created

Inherited from

Scene.onNewTransformNodeAddedObservable

---

onPointerDown()?

optional onPointerDown: (evt, pickInfo, type) => void

Defined in: node_modules/@babylonjs/core/scene.d.ts:711

Callback called when a pointer down is detected

Parameters

evt

IPointerEvent

pickInfo

PickingInfo

type

PointerEventTypes

Returns

void

Inherited from

Scene.onPointerDown

---

onPointerMove()?

optional onPointerMove: (evt, pickInfo, type) => void

Defined in: node_modules/@babylonjs/core/scene.d.ts:709

Callback called when a pointer move is detected

Parameters

evt

IPointerEvent

pickInfo

PickingInfo

type

PointerEventTypes

Returns

void

Inherited from

Scene.onPointerMove

---

onPointerObservable

onPointerObservable: Observable<PointerInfo>

Defined in: node_modules/@babylonjs/core/scene.d.ts:736

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

Inherited from

Scene.onPointerObservable

---

onPointerPick()?

optional onPointerPick: (evt, pickInfo) => void

Defined in: node_modules/@babylonjs/core/scene.d.ts:715

Callback called when a pointer pick is detected

Parameters

evt

IPointerEvent

pickInfo

PickingInfo

Returns

void

Inherited from

Scene.onPointerPick

---

onPointerUp()?

optional onPointerUp: (evt, pickInfo, type) => void

Defined in: node_modules/@babylonjs/core/scene.d.ts:713

Callback called when a pointer up is detected

Parameters

evt

IPointerEvent

pickInfo

PickingInfo

type

PointerEventTypes

Returns

void

Inherited from

Scene.onPointerUp

---

onPreKeyboardObservable

onPreKeyboardObservable: Observable<KeyboardInfoPre>

Defined in: node_modules/@babylonjs/core/scene.d.ts:778

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

Inherited from

Scene.onPreKeyboardObservable

---

onPrePointerObservable

onPrePointerObservable: Observable<PointerInfoPre>

Defined in: node_modules/@babylonjs/core/scene.d.ts:732

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

Inherited from

Scene.onPrePointerObservable

---

onReadyObservable

onReadyObservable: Observable<Scene>

Defined in: node_modules/@babylonjs/core/scene.d.ts:488

An event triggered when the scene is ready

Inherited from

Scene.onReadyObservable

---

onScenePerformancePriorityChangedObservable

onScenePerformancePriorityChangedObservable: Observable<ScenePerformancePriority>

Defined in: node_modules/@babylonjs/core/scene.d.ts:212

Observable triggered when the performance priority is changed

Inherited from

Scene.onScenePerformancePriorityChangedObservable

---

onSkeletonRemovedObservable

onSkeletonRemovedObservable: Observable<Skeleton>

Defined in: node_modules/@babylonjs/core/scene.d.ts:573

An event triggered when a skeleton is removed

Inherited from

Scene.onSkeletonRemovedObservable

---

onTextureRemovedObservable

onTextureRemovedObservable: Observable<BaseTexture>

Defined in: node_modules/@babylonjs/core/scene.d.ts:597

An event triggered when a texture is removed

Inherited from

Scene.onTextureRemovedObservable

---

onTransformNodeRemovedObservable

onTransformNodeRemovedObservable: Observable<TransformNode>

Defined in: node_modules/@babylonjs/core/scene.d.ts:557

An event triggered when a transform node is removed

Inherited from

Scene.onTransformNodeRemovedObservable

---

particlesEnabled

particlesEnabled: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:916

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

Inherited from

Scene.particlesEnabled

---

particleSystems

particleSystems: IParticleSystem[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:286

All of the particle systems added to this scene

See

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

Inherited from

Scene.particleSystems

---

physicsEnabled

physicsEnabled: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:912

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

Inherited from

Scene.physicsEnabled

---

pointerDownTrianglePredicate()

pointerDownTrianglePredicate: (p0, p1, p2, ray) => boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:723

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

Parameters

p0

Vector3

p1

Vector3

p2

Vector3

ray

Ray

Returns

boolean

Inherited from

Scene.pointerDownTrianglePredicate

---

pointerMoveTrianglePredicate()

pointerMoveTrianglePredicate: (p0, p1, p2, ray) => boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:719

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

Parameters

p0

Vector3

p1

Vector3

p2

Vector3

ray

Ray

Returns

boolean

Inherited from

Scene.pointerMoveTrianglePredicate

---

pointerUpTrianglePredicate()

pointerUpTrianglePredicate: (p0, p1, p2, ray) => boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:727

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

Parameters

p0

Vector3

p1

Vector3

p2

Vector3

ray

Ray

Returns

boolean

Inherited from

Scene.pointerUpTrianglePredicate

---

postProcesses

postProcesses: PostProcess[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:356

The list of postprocesses added to the scene

Inherited from

Scene.postProcesses

---

postProcessesEnabled

postProcessesEnabled: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:947

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

Inherited from

Scene.postProcessesEnabled

---

postProcessManager

postProcessManager: PostProcessManager

Defined in: node_modules/@babylonjs/core/scene.d.ts:951

Gets the current postprocess manager

Inherited from

Scene.postProcessManager

---

postProcessRenderPipelineManager

readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager

Defined in: node_modules/@babylonjs/core/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent.d.ts:13

Gets the postprocess render pipeline manager

See

• https://doc.babylonjs.com/features/featuresDeepDive/postProcesses/postProcessRenderPipeline
• https://doc.babylonjs.com/features/featuresDeepDive/postProcesses/defaultRenderingPipeline

Inherited from

Scene.postProcessRenderPipelineManager

---

prePassRenderer

prePassRenderer: PrePassRenderer

Defined in: node_modules/@babylonjs/core/Rendering/prePassRendererSceneComponent.d.ts:13

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

Inherited from

Scene.prePassRenderer

---

preventDefaultOnPointerDown

preventDefaultOnPointerDown: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:421

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

Inherited from

Scene.preventDefaultOnPointerDown

---

preventDefaultOnPointerUp

preventDefaultOnPointerUp: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:426

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

Inherited from

Scene.preventDefaultOnPointerUp

---

probesEnabled

probesEnabled: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:977

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

Inherited from

Scene.probesEnabled

---

proceduralTextures

proceduralTextures: ProceduralTexture[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:380

The list of procedural textures added to the scene

See

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

Inherited from

Scene.proceduralTextures

---

proceduralTexturesEnabled

proceduralTexturesEnabled: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:992

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

Inherited from

Scene.proceduralTexturesEnabled

---

reflectionProbes

reflectionProbes: ReflectionProbe[]

Defined in: node_modules/@babylonjs/core/Probes/reflectionProbe.d.ts:13

The list of reflection probes added to the scene

See

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

Inherited from

Scene.reflectionProbes

---

renderTargetsEnabled

renderTargetsEnabled: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:955

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

Inherited from

Scene.renderTargetsEnabled

---

requireLightSorting

requireLightSorting: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:1068

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

Inherited from

Scene.requireLightSorting

---

reservedDataStore

reservedDataStore: any

Defined in: node_modules/@babylonjs/core/scene.d.ts:434

For internal use only. Please do not use.

Inherited from

Scene.reservedDataStore

---

rootNodes

rootNodes: Node[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:263

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

Inherited from

Scene.rootNodes

---

selectionOctree

selectionOctree: Octree<AbstractMesh>

Defined in: node_modules/@babylonjs/core/Culling/Octrees/octreeSceneComponent.d.ts:19

Gets the octree used to boost mesh selection (picking)

See

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

Inherited from

Scene.selectionOctree

---

simplificationQueue

simplificationQueue: SimplificationQueue

Defined in: node_modules/@babylonjs/core/Meshes/meshSimplificationSceneComponent.d.ts:13

Gets or sets the simplification queue attached to the scene

See

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

Inherited from

Scene.simplificationQueue

---

skeletons

skeletons: Skeleton[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:281

The list of skeletons added to the scene

See

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

Inherited from

Scene.skeletons

---

sounds

sounds: Sound[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:366

The list of sounds used in the scene.

Inherited from

Scene.sounds

---

soundTracks

soundTracks: SoundTrack[]

Defined in: node_modules/@babylonjs/core/Audio/audioSceneComponent.d.ts:25

The list of sound tracks added to the scene

See

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

Inherited from

Scene.soundTracks

---

spriteManagers?

optional spriteManagers: ISpriteManager[]

Defined in: node_modules/@babylonjs/core/Sprites/spriteSceneComponent.d.ts:22

All of the sprite managers added to this scene

See

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

Inherited from

Scene.spriteManagers

---

spritesEnabled

spritesEnabled: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:920

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

Inherited from

Scene.spritesEnabled

---

subSurfaceConfiguration

subSurfaceConfiguration: SubSurfaceConfiguration

Defined in: node_modules/@babylonjs/core/Rendering/subSurfaceSceneComponent.d.ts:12

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

Inherited from

Scene.subSurfaceConfiguration

---

textures

textures: BaseTexture[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:338

Textures to keep.

Inherited from

Scene.textures

---

transformNodes

transformNodes: TransformNode[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:329

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

Inherited from

Scene.transformNodes

---

useClonedMeshMap

readonly useClonedMeshMap: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:1072

Internal

Inherited from

Scene.useClonedMeshMap

---

useConstantAnimationDeltaTime

useConstantAnimationDeltaTime: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:399

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

Inherited from

Scene.useConstantAnimationDeltaTime

---

useDelayedTextureLoading

useDelayedTextureLoading: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:969

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

Inherited from

Scene.useDelayedTextureLoading

---

useMaterialMeshMap

readonly useMaterialMeshMap: boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:1070

Internal

Inherited from

Scene.useMaterialMeshMap

---

useOrderIndependentTransparency

useOrderIndependentTransparency: boolean

Defined in: node_modules/@babylonjs/core/Rendering/depthPeelingSceneComponent.d.ts:16

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

Inherited from

Scene.useOrderIndependentTransparency

---

FOGMODE_EXP

readonly static FOGMODE_EXP: number

Defined in: node_modules/@babylonjs/core/scene.d.ts:111

The fog density is following an exponential function

Inherited from

Scene.FOGMODE_EXP

---

FOGMODE_EXP2

readonly static FOGMODE_EXP2: number

Defined in: node_modules/@babylonjs/core/scene.d.ts:113

The fog density is following an exponential function faster than FOGMODE_EXP

Inherited from

Scene.FOGMODE_EXP2

---

FOGMODE_LINEAR

readonly static FOGMODE_LINEAR: number

Defined in: node_modules/@babylonjs/core/scene.d.ts:115

The fog density is following a linear function.

Inherited from

Scene.FOGMODE_LINEAR

---

FOGMODE_NONE

readonly static FOGMODE_NONE: number

Defined in: node_modules/@babylonjs/core/scene.d.ts:109

The fog is deactivated

Inherited from

Scene.FOGMODE_NONE

---

MaxDeltaTime

static MaxDeltaTime: number

Defined in: node_modules/@babylonjs/core/scene.d.ts:125

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

See

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

Inherited from

Scene.MaxDeltaTime

---

MinDeltaTime

static MinDeltaTime: number

Defined in: node_modules/@babylonjs/core/scene.d.ts:120

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

See

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

Inherited from

Scene.MinDeltaTime

Accessors

_hasDefaultMaterial

Get Signature

get _hasDefaultMaterial(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:886

Internal

Returns

boolean

Inherited from

Scene._hasDefaultMaterial

---

activeBonesPerfCounter

Get Signature

get activeBonesPerfCounter(): PerfCounter

Defined in: node_modules/@babylonjs/core/scene.d.ts:1339

Gets the performance counter for active bones

See

https://doc.babylonjs.com/features/featuresDeepDive/scene/optimize_your_scene#instrumentation

Returns

PerfCounter

Inherited from

Scene.activeBonesPerfCounter

---

activeCamera

Get Signature

get activeCamera(): Camera

Defined in: node_modules/@babylonjs/core/scene.d.ts:883

Gets or sets the current active camera

Returns

Camera

Set Signature

set activeCamera(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:884

Parameters

value

Camera

Returns

void

Inherited from

Scene.activeCamera

---

activeCameras

Get Signature

get activeCameras(): Camera[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:878

All of the active cameras added to this scene.

Returns

Camera[]

Set Signature

set activeCameras(cameras): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:879

Parameters

cameras

Camera[]

Returns

void

Inherited from

Scene.activeCameras

---

activeParticlesPerfCounter

Get Signature

get activeParticlesPerfCounter(): PerfCounter

Defined in: node_modules/@babylonjs/core/scene.d.ts:1329

Gets the performance counter for active particles

See

https://doc.babylonjs.com/features/featuresDeepDive/scene/optimize_your_scene#instrumentation

Returns

PerfCounter

Inherited from

Scene.activeParticlesPerfCounter

---

afterCameraRender

Set Signature

set afterCameraRender(callback): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:503

Sets a function to be executed after rendering a camera

Parameters

callback

() => void

Returns

void

Inherited from

Scene.afterCameraRender

---

afterRender

Set Signature

set afterRender(callback): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:468

Sets a function to be executed after rendering this scene

Parameters

callback

() => void

Returns

void

Inherited from

Scene.afterRender

---

animatables

Get Signature

get animatables(): Animatable[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:1479

Gets all animatable attached to the scene

Returns

Animatable[]

Inherited from

Scene.animatables

---

animationPropertiesOverride

Get Signature

get animationPropertiesOverride(): AnimationPropertiesOverride

Defined in: node_modules/@babylonjs/core/scene.d.ts:393

Gets or sets the animation properties override

Returns

AnimationPropertiesOverride

Set Signature

set animationPropertiesOverride(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:394

Parameters

value

AnimationPropertiesOverride

Returns

void

Inherited from

Scene.animationPropertiesOverride

---

beforeCameraRender

Set Signature

set beforeCameraRender(callback): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:495

Sets a function to be executed before rendering a camera

Parameters

callback

() => void

Returns

void

Inherited from

Scene.beforeCameraRender

---

beforeRender

Set Signature

set beforeRender(callback): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:456

Sets a function to be executed before rendering this scene

Parameters

callback

() => void

Returns

void

Inherited from

Scene.beforeRender

---

blockfreeActiveMeshesAndRenderingGroups

Get Signature

get blockfreeActiveMeshesAndRenderingGroups(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:2017

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

Set Signature

set blockfreeActiveMeshesAndRenderingGroups(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2018

Parameters

value

boolean

Returns

void

Inherited from

Scene.blockfreeActiveMeshesAndRenderingGroups

---

blockMaterialDirtyMechanism

Get Signature

get blockMaterialDirtyMechanism(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:2336

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

Set Signature

set blockMaterialDirtyMechanism(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2337

Parameters

value

boolean

Returns

void

Inherited from

Scene.blockMaterialDirtyMechanism

---

clearColor

Get Signature

get clearColor(): Color4

Defined in: node_modules/@babylonjs/core/scene.d.ts:168

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

Returns

Color4

Set Signature

set clearColor(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:169

Parameters

value

Color4

Returns

void

Inherited from

Scene.clearColor

---

collisionCoordinator

Get Signature

get collisionCoordinator(): ICollisionCoordinator

Defined in: node_modules/@babylonjs/core/scene.d.ts:938

Internal

Returns

ICollisionCoordinator

Inherited from

Scene.collisionCoordinator

---

defaultMaterial

Get Signature

get defaultMaterial(): Material

Defined in: node_modules/@babylonjs/core/scene.d.ts:889

The default material used on meshes when no material is affected

Returns

Material

Set Signature

set defaultMaterial(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:891

The default material used on meshes when no material is affected

Parameters

value

Material

Returns

void

Inherited from

Scene.defaultMaterial

---

environmentTexture

Get Signature

get environmentTexture(): BaseTexture

Defined in: node_modules/@babylonjs/core/scene.d.ts:346

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

BaseTexture

Set Signature

set environmentTexture(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:352

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

BaseTexture

Returns

void

Inherited from

Scene.environmentTexture

---

fogEnabled

Get Signature

get fogEnabled(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:817

Returns

boolean

Set Signature

set fogEnabled(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:816

Gets or sets a boolean indicating if fog is enabled on this scene

See

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

Parameters

value

boolean

Returns

void

Inherited from

Scene.fogEnabled

---

fogMode

Get Signature

get fogMode(): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:830

Returns

number

Set Signature

set fogMode(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:829

Gets or sets the fog mode to use

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

Parameters

value

number

Returns

void

Inherited from

Scene.fogMode

---

forcePointsCloud

Get Signature

get forcePointsCloud(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:235

Returns

boolean

Set Signature

set forcePointsCloud(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:234

Gets or sets a boolean indicating if all rendering must be done in point cloud

Parameters

value

boolean

Returns

void

Inherited from

Scene.forcePointsCloud

---

forceWireframe

Get Signature

get forceWireframe(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:223

Returns

boolean

Set Signature

set forceWireframe(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:222

Gets or sets a boolean indicating if all rendering must be done in wireframe

Parameters

value

boolean

Returns

void

Inherited from

Scene.forceWireframe

---

frameGraph

Get Signature

get frameGraph(): FrameGraph

Defined in: node_modules/@babylonjs/core/scene.d.ts:903

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

FrameGraph

Set Signature

set frameGraph(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:904

Parameters

value

FrameGraph

Returns

void

Inherited from

Scene.frameGraph

---

frustumPlanes

Get Signature

get frustumPlanes(): Plane[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:1063

Gets the list of frustum planes (built from the active camera)

Returns

Plane[]

Inherited from

Scene.frustumPlanes

---

imageProcessingConfiguration

Get Signature

get imageProcessingConfiguration(): ImageProcessingConfiguration

Defined in: node_modules/@babylonjs/core/scene.d.ts:207

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

Inherited from

Scene.imageProcessingConfiguration

---

isDisposed

Get Signature

get isDisposed(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:2137

Gets if the scene is already disposed

Returns

boolean

Inherited from

Scene.isDisposed

---

isLoading

Get Signature

get isLoading(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:1459

Returns a boolean indicating if the scene is still loading data

Returns

boolean

Inherited from

Scene.isLoading

---

lightsEnabled

Get Signature

get lightsEnabled(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:874

Returns

boolean

Set Signature

set lightsEnabled(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:873

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

Parameters

value

boolean

Returns

void

Inherited from

Scene.lightsEnabled

---

meshUnderPointer

Get Signature

get meshUnderPointer(): AbstractMesh

Defined in: node_modules/@babylonjs/core/scene.d.ts:1261

Gets the mesh that is currently under the pointer

Returns

AbstractMesh

Inherited from

Scene.meshUnderPointer

---

onDispose

Set Signature

set onDispose(callback): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:449

Sets a function to be executed when this scene is disposed.

Parameters

callback

() => void

Returns

void

Inherited from

Scene.onDispose

---

performancePriority

Get Signature

get performancePriority(): ScenePerformancePriority

Defined in: node_modules/@babylonjs/core/scene.d.ts:216

Gets or sets a value indicating how to treat performance relatively to ease of use and backward compatibility

Returns

ScenePerformancePriority

Set Signature

set performancePriority(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:217

Parameters

value

ScenePerformancePriority

Returns

void

Inherited from

Scene.performancePriority

---

pointerDownFastCheck

Get Signature

get pointerDownFastCheck(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:681

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

Returns

boolean

Set Signature

set pointerDownFastCheck(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:682

Parameters

value

boolean

Returns

void

Inherited from

Scene.pointerDownFastCheck

---

pointerDownPredicate

Get Signature

get pointerDownPredicate(): (Mesh) => boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:666

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

Returns

(Mesh): boolean

Parameters

Mesh

AbstractMesh

Returns

boolean

Set Signature

set pointerDownPredicate(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:667

Parameters

value

(Mesh) => boolean

Returns

void

Inherited from

Scene.pointerDownPredicate

---

pointerMoveFastCheck

Get Signature

get pointerMoveFastCheck(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:691

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

Returns

boolean

Set Signature

set pointerMoveFastCheck(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:692

Parameters

value

boolean

Returns

void

Inherited from

Scene.pointerMoveFastCheck

---

pointerMovePredicate

Get Signature

get pointerMovePredicate(): (Mesh) => boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:676

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

Returns

(Mesh): boolean

Parameters

Mesh

AbstractMesh

Returns

boolean

Set Signature

set pointerMovePredicate(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:677

Parameters

value

(Mesh) => boolean

Returns

void

Inherited from

Scene.pointerMovePredicate

---

pointerUpFastCheck

Get Signature

get pointerUpFastCheck(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:686

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

Returns

boolean

Set Signature

set pointerUpFastCheck(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:687

Parameters

value

boolean

Returns

void

Inherited from

Scene.pointerUpFastCheck

---

pointerUpPredicate

Get Signature

get pointerUpPredicate(): (Mesh) => boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:671

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

Returns

(Mesh): boolean

Parameters

Mesh

AbstractMesh

Returns

boolean

Set Signature

set pointerUpPredicate(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:672

Parameters

value

(Mesh) => boolean

Returns

void

Inherited from

Scene.pointerUpPredicate

---

pointerX

Get Signature

get pointerX(): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1265

Gets or sets the current on-screen X position of the pointer

Returns

number

Set Signature

set pointerX(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1266

Parameters

value

number

Returns

void

Inherited from

Scene.pointerX

---

pointerY

Get Signature

get pointerY(): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1270

Gets or sets the current on-screen Y position of the pointer

Returns

number

Set Signature

set pointerY(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1271

Parameters

value

number

Returns

void

Inherited from

Scene.pointerY

---

prePass

Get Signature

get prePass(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:858

Flag indicating that the frame buffer binding is handled by another component

Returns

boolean

Inherited from

Scene.prePass

---

renderingManager

Get Signature

get renderingManager(): RenderingManager

Defined in: node_modules/@babylonjs/core/scene.d.ts:1047

Gets the scene's rendering manager

Returns

RenderingManager

Inherited from

Scene.renderingManager

---

shadowsEnabled

Get Signature

get shadowsEnabled(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:868

Returns

boolean

Set Signature

set shadowsEnabled(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:867

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

Parameters

value

boolean

Returns

void

Inherited from

Scene.shadowsEnabled

---

skeletonsEnabled

Get Signature

get skeletonsEnabled(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:926

Returns

boolean

Set Signature

set skeletonsEnabled(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:925

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

Parameters

value

boolean

Returns

void

Inherited from

Scene.skeletonsEnabled

---

skipFrustumClipping

Get Signature

get skipFrustumClipping(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:229

Returns

boolean

Set Signature

set skipFrustumClipping(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:228

Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection

Parameters

value

boolean

Returns

void

Inherited from

Scene.skipFrustumClipping

---

skipPointerDownPicking

Get Signature

get skipPointerDownPicking(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:701

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

Returns

boolean

Set Signature

set skipPointerDownPicking(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:702

Parameters

value

boolean

Returns

void

Inherited from

Scene.skipPointerDownPicking

---

skipPointerMovePicking

Get Signature

get skipPointerMovePicking(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:696

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

Returns

boolean

Set Signature

set skipPointerMovePicking(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:697

Parameters

value

boolean

Returns

void

Inherited from

Scene.skipPointerMovePicking

---

skipPointerUpPicking

Get Signature

get skipPointerUpPicking(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:706

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

Set Signature

set skipPointerUpPicking(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:707

Parameters

value

boolean

Returns

void

Inherited from

Scene.skipPointerUpPicking

---

texturesEnabled

Get Signature

get texturesEnabled(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:897

Returns

boolean

Set Signature

set texturesEnabled(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:896

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

Parameters

value

boolean

Returns

void

Inherited from

Scene.texturesEnabled

---

totalActiveIndicesPerfCounter

Get Signature

get totalActiveIndicesPerfCounter(): PerfCounter

Defined in: node_modules/@babylonjs/core/scene.d.ts:1319

Gets the performance counter for active indices

See

https://doc.babylonjs.com/features/featuresDeepDive/scene/optimize_your_scene#instrumentation

Returns

PerfCounter

Inherited from

Scene.totalActiveIndicesPerfCounter

---

totalVerticesPerfCounter

Get Signature

get totalVerticesPerfCounter(): PerfCounter

Defined in: node_modules/@babylonjs/core/scene.d.ts:1309

Gets the performance counter for total vertices

See

https://doc.babylonjs.com/features/featuresDeepDive/scene/optimize_your_scene#instrumentation

Returns

PerfCounter

Inherited from

Scene.totalVerticesPerfCounter

---

uid

Get Signature

get uid(): string

Defined in: node_modules/@babylonjs/core/scene.d.ts:1977

Return a unique id as a string which can serve as an identifier for the scene

Returns

string

Inherited from

Scene.uid

---

unTranslatedPointer

Get Signature

get unTranslatedPointer(): Vector2

Defined in: node_modules/@babylonjs/core/scene.d.ts:740

Gets the pointer coordinates without any translation (ie. straight out of the pointer event)

Returns

Vector2

Inherited from

Scene.unTranslatedPointer

---

useRightHandedSystem

Get Signature

get useRightHandedSystem(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:788

Returns

boolean

Set Signature

set useRightHandedSystem(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:787

Gets or sets a boolean indicating if the scene must use right-handed coordinates system

Parameters

value

boolean

Returns

void

Inherited from

Scene.useRightHandedSystem

---

DoubleClickDelay

Get Signature

get static DoubleClickDelay(): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:754

Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms

Returns

number

Set Signature

set static DoubleClickDelay(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:755

Parameters

value

number

Returns

void

Inherited from

Scene.DoubleClickDelay

---

DragMovementThreshold

Get Signature

get static DragMovementThreshold(): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:744

Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels

Returns

number

Set Signature

set static DragMovementThreshold(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:745

Parameters

value

number

Returns

void

Inherited from

Scene.DragMovementThreshold

---

ExclusiveDoubleClickMode

Get Signature

get static ExclusiveDoubleClickMode(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:757

If you need to check double click without raising a single click at first click, enable this flag

Returns

boolean

Set Signature

set static ExclusiveDoubleClickMode(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:758

Parameters

value

boolean

Returns

void

Inherited from

Scene.ExclusiveDoubleClickMode

---

LongPressDelay

Get Signature

get static LongPressDelay(): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:749

Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms

Returns

number

Set Signature

set static LongPressDelay(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:750

Parameters

value

number

Returns

void

Inherited from

Scene.LongPressDelay

Methods

_addComponent()

_addComponent(component): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1100

Internal

Add a component to the scene. Note that the ccomponent could be registered on th next frame if this is called after the register component stage.

Parameters

component

ISceneComponent

Defines the component to add to the scene

Returns

void

Inherited from

Scene._addComponent

---

_advancePhysicsEngineStep()

_advancePhysicsEngineStep(step): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2090

Internal

Parameters

step

number

Returns

void

Inherited from

Scene._advancePhysicsEngineStep

---

_animate()

_animate(customDeltaTime?): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2097

Internal

Parameters

customDeltaTime?

number

Returns

void

Inherited from

Scene._animate

---

_checkIsReady()

_checkIsReady(checkRenderTargets?): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1475

Internal

Parameters

checkRenderTargets?

boolean

Returns

void

Inherited from

Scene._checkIsReady

---

_createMultiviewUbo()

_createMultiviewUbo(): void

Defined in: node_modules/@babylonjs/core/Engines/Extensions/engine.multiview.d.ts:61

Internal

Returns

void

Inherited from

Scene._createMultiviewUbo

---

_forceBlockMaterialDirtyMechanism()

_forceBlockMaterialDirtyMechanism(value): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2334

Internal

Parameters

value

boolean

Returns

void

Inherited from

Scene._forceBlockMaterialDirtyMechanism

---

_getComponent()

_getComponent(name): ISceneComponent

Defined in: node_modules/@babylonjs/core/scene.d.ts:1107

Internal

Gets a component from the scene.

Parameters

name

string

defines the name of the component to retrieve

Returns

ISceneComponent

the component or null if not present

Inherited from

Scene._getComponent

---

_getDefaultMeshCandidates()

_getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1246

Internal

Returns

ISmartArrayLike<AbstractMesh>

Inherited from

Scene._getDefaultMeshCandidates

---

_getDefaultSubMeshCandidates()

_getDefaultSubMeshCandidates(mesh): ISmartArrayLike<SubMesh>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1251

Internal

Parameters

mesh

AbstractMesh

Returns

ISmartArrayLike<SubMesh>

Inherited from

Scene._getDefaultSubMeshCandidates

---

_internalMultiPickSprites()

_internalMultiPickSprites(ray, predicate?, camera?): PickingInfo[]

Defined in: node_modules/@babylonjs/core/Sprites/spriteSceneComponent.d.ts:53

Internal

Parameters

ray

Ray

predicate?

(sprite) => boolean

camera?

Camera

Returns

PickingInfo[]

Inherited from

Scene._internalMultiPickSprites

---

_internalPickSprites()

_internalPickSprites(ray, predicate?, fastCheck?, camera?): PickingInfo

Defined in: node_modules/@babylonjs/core/Sprites/spriteSceneComponent.d.ts:34

Internal

Parameters

ray

Ray

predicate?

(sprite) => boolean

fastCheck?

boolean

camera?

Camera

Returns

PickingInfo

Inherited from

Scene._internalPickSprites

---

_isInIntermediateRendering()

_isInIntermediateRendering(): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:2028

Internal

Returns

boolean

Inherited from

Scene._isInIntermediateRendering

---

_loadFile()

_loadFile(fileOrUrl, onSuccess, onProgress?, useOfflineSupport?, useArrayBuffer?, onError?, onOpened?): IFileRequest

Defined in: node_modules/@babylonjs/core/scene.d.ts:2347

Internal

Parameters

fileOrUrl

string | File

onSuccess

(data, responseURL?) => void

onProgress?

(ev) => void

useOfflineSupport?

boolean

useArrayBuffer?

boolean

onError?

(request?, exception?) => void

onOpened?

(request) => void

Returns

IFileRequest

Inherited from

Scene._loadFile

---

_loadFileAsync()

Call Signature

_loadFileAsync(fileOrUrl, onProgress?, useOfflineSupport?, useArrayBuffer?, onOpened?): Promise<string>

Defined in: node_modules/@babylonjs/core/scene.d.ts:2348

Parameters

fileOrUrl

string | File

onProgress?

(data) => void

useOfflineSupport?

boolean

useArrayBuffer?

false

onOpened?

(request) => void

Returns

Promise<string>

Inherited from

Scene._loadFileAsync

Call Signature

_loadFileAsync(fileOrUrl, onProgress?, useOfflineSupport?, useArrayBuffer?, onOpened?): Promise<ArrayBuffer>

Defined in: node_modules/@babylonjs/core/scene.d.ts:2349

Parameters

fileOrUrl

string | File

onProgress?

(data) => void

useOfflineSupport?

boolean

useArrayBuffer?

true

onOpened?

(request) => void

Returns

Promise<ArrayBuffer>

Inherited from

Scene._loadFileAsync

---

_prepareSkeleton()

_prepareSkeleton(mesh): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2068

Internal

Parameters

mesh

AbstractMesh

Returns

void

Inherited from

Scene._prepareSkeleton

---

_readFile()

_readFile(file, onSuccess, onProgress?, useArrayBuffer?, onError?): IFileRequest

Defined in: node_modules/@babylonjs/core/scene.d.ts:2361

Internal

Parameters

file

File

onSuccess

(data) => void

onProgress?

(ev) => any

useArrayBuffer?

boolean

onError?

(error) => void

Returns

IFileRequest

Inherited from

Scene._readFile

---

_readFileAsync()

_readFileAsync(file, onProgress?, useArrayBuffer?): Promise<string | ArrayBuffer>

Defined in: node_modules/@babylonjs/core/scene.d.ts:2365

Internal

Parameters

file

File

onProgress?

(ev) => any

useArrayBuffer?

boolean

Returns

Promise<string | ArrayBuffer>

Inherited from

Scene._readFileAsync

---

_rebuildGeometries()

_rebuildGeometries(): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2260

Internal

Returns

void

Inherited from

Scene._rebuildGeometries

---

_rebuildTextures()

_rebuildTextures(): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2262

Internal

Returns

void

Inherited from

Scene._rebuildTextures

---

_renderForCamera()

_renderForCamera(camera, rigParent?, bindFrameBuffer?): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2084

Internal

Parameters

camera

Camera

rigParent?

Camera

bindFrameBuffer?

boolean

Returns

void

Inherited from

Scene._renderForCamera

---

_renderMultiviewToSingleView()

_renderMultiviewToSingleView(camera): void

Defined in: node_modules/@babylonjs/core/Engines/Extensions/engine.multiview.d.ts:65

Internal

Parameters

camera

Camera

Returns

void

Inherited from

Scene._renderMultiviewToSingleView

---

_requestFile()

_requestFile(url, onSuccess, onProgress?, useOfflineSupport?, useArrayBuffer?, onError?, onOpened?): IFileRequest

Defined in: node_modules/@babylonjs/core/scene.d.ts:2353

Internal

Parameters

url

string

onSuccess

(data, request?) => void

onProgress?

(ev) => void

useOfflineSupport?

boolean

useArrayBuffer?

boolean

onError?

(error) => void

onOpened?

(request) => void

Returns

IFileRequest

Inherited from

Scene._requestFile

---

_requestFileAsync()

_requestFileAsync(url, onProgress?, useOfflineSupport?, useArrayBuffer?, onOpened?): Promise<string | ArrayBuffer>

Defined in: node_modules/@babylonjs/core/scene.d.ts:2357

Internal

Parameters

url

string

onProgress?

(ev) => void

useOfflineSupport?

boolean

useArrayBuffer?

boolean

onOpened?

(request) => void

Returns

Promise<string | ArrayBuffer>

Inherited from

Scene._requestFileAsync

---

_updateMultiviewUbo()

_updateMultiviewUbo(viewR?, projectionR?): void

Defined in: node_modules/@babylonjs/core/Engines/Extensions/engine.multiview.d.ts:63

Internal

Parameters

viewR?

Matrix

projectionR?

Matrix

Returns

void

Inherited from

Scene._updateMultiviewUbo

---

addActionManager()

addActionManager(newActionManager): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1686

Adds the given action manager to this scene

Parameters

newActionManager

AbstractActionManager

The action manager to add

Returns

void

Deprecated

Inherited from

Scene.addActionManager

---

addAnimation()

addAnimation(newAnimation): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1655

Adds the given animation to this scene

Parameters

newAnimation

Animation

The animation to add

Returns

void

Inherited from

Scene.addAnimation

---

addAnimationGroup()

addAnimationGroup(newAnimationGroup): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1660

Adds the given animation group to this scene.

Parameters

newAnimationGroup

AnimationGroup

The animation group to add

Returns

void

Inherited from

Scene.addAnimationGroup

---

addCamera()

addCamera(newCamera): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1640

Adds the given camera to this scene

Parameters

newCamera

Camera

The camera to add

Returns

void

Inherited from

Scene.addCamera

---

addEffectLayer()

addEffectLayer(newEffectLayer): void

Defined in: node_modules/@babylonjs/core/Layers/effectLayerSceneComponent.d.ts:17

Adds the given effect layer to this scene

Parameters

newEffectLayer

EffectLayer

defines the effect layer to add

Returns

void

Inherited from

Scene.addEffectLayer

---

addExternalData()

addExternalData<T>(key, data): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:1986

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

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

Inherited from

Scene.addExternalData

---

addGeometry()

addGeometry(newGeometry): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1680

Adds the given geometry to this scene

Parameters

newGeometry

Geometry

The geometry to add

Returns

void

Inherited from

Scene.addGeometry

---

addLensFlareSystem()

addLensFlareSystem(newLensFlareSystem): void

Defined in: node_modules/@babylonjs/core/LensFlares/lensFlareSystemSceneComponent.d.ts:18

Adds the given lens flare system to this scene

Parameters

newLensFlareSystem

LensFlareSystem

The lens flare system to add

Returns

void

Inherited from

Scene.addLensFlareSystem

---

addLight()

addLight(newLight): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1631

Adds the given light to this scene

Parameters

newLight

Light

The light to add

Returns

void

Inherited from

Scene.addLight

---

addMaterial()

addMaterial(newMaterial): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1670

Adds the given material to this scene

Parameters

newMaterial

Material

The material to add

Returns

void

Inherited from

Scene.addMaterial

---

addMesh()

addMesh(newMesh, recursive?): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1534

Add a mesh to the list of scene's meshes

Parameters

newMesh

AbstractMesh

defines the mesh to add

recursive?

boolean

if all child meshes should also be added to the scene

Returns

void

Inherited from

Scene.addMesh

---

addMorphTargetManager()

addMorphTargetManager(newMorphTargetManager): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1675

Adds the given morph target to this scene

Parameters

newMorphTargetManager

MorphTargetManager

The morph target to add

Returns

void

Inherited from

Scene.addMorphTargetManager

---

addMultiMaterial()

addMultiMaterial(newMultiMaterial): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1665

Adds the given multi-material to this scene

Parameters

newMultiMaterial

MultiMaterial

The multi-material to add

Returns

void

Inherited from

Scene.addMultiMaterial

---

addParticleSystem()

addParticleSystem(newParticleSystem): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1650

Adds the given particle system to this scene

Parameters

newParticleSystem

IParticleSystem

The particle system to add

Returns

void

Inherited from

Scene.addParticleSystem

---

addPendingData()

addPendingData(data): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1445

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

Inherited from

Scene.addPendingData

---

addReflectionProbe()

addReflectionProbe(newReflectionProbe): void

Defined in: node_modules/@babylonjs/core/Probes/reflectionProbe.d.ts:24

Adds the given reflection probe to this scene.

Parameters

newReflectionProbe

ReflectionProbe

The reflection probe to add

Returns

void

Inherited from

Scene.addReflectionProbe

---

addSkeleton()

addSkeleton(newSkeleton): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1645

Adds the given skeleton to this scene

Parameters

newSkeleton

Skeleton

The skeleton to add

Returns

void

Inherited from

Scene.addSkeleton

---

addTexture()

addTexture(newTexture): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1691

Adds the given texture to this scene.

Parameters

newTexture

BaseTexture

The texture to add

Returns

void

Inherited from

Scene.addTexture

---

addTransformNode()

addTransformNode(newTransformNode): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1546

Add a transform node to the list of scene's transform nodes

Parameters

newTransformNode

TransformNode

defines the transform node to add

Returns

void

Inherited from

Scene.addTransformNode

---

animate()

animate(): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2099

Execute all animations (for a frame)

Returns

void

Inherited from

Scene.animate

---

attachControl()

attachControl(attachUp?, attachDown?, attachMove?): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1400

Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp

Parameters

attachUp?

boolean

defines if you want to attach events to pointerup

attachDown?

boolean

defines if you want to attach events to pointerdown

attachMove?

boolean

defines if you want to attach events to pointermove

Returns

void

Inherited from

Scene.attachControl

---

beginAnimation()

beginAnimation(target, from, to, loop?, speedRatio?, onAnimationEnd?, animatable?, stopCurrent?, targetMask?, onAnimationLoop?, isAdditive?): Animatable

Defined in: node_modules/@babylonjs/core/Animations/animatable.d.ts:46

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.

loop?

boolean

defines if the animation loops

speedRatio?

number

defines the speed in which to run the animation (1.0 by default)

onAnimationEnd?

() => void

defines the function to be executed when the animation ends

animatable?

Animatable

defines an animatable object. If not provided a new one will be created from the given params

stopCurrent?

boolean

defines if the current animations must be stopped first (true by default)

targetMask?

(target) => boolean

defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)

onAnimationLoop?

() => void

defines the callback to call when an animation loops

isAdditive?

boolean

defines whether the animation should be evaluated additively (false by default)

Returns

Animatable

the animatable object created for this animation

Inherited from

Scene.beginAnimation

---

beginDirectAnimation()

beginDirectAnimation(target, animations, from, to, loop?, speedRatio?, onAnimationEnd?, onAnimationLoop?, isAdditive?): Animatable

Defined in: node_modules/@babylonjs/core/Animations/animatable.d.ts:79

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

loop?

boolean

defines if you want animation to loop (off by default)

speedRatio?

number

defines the speed ratio to apply to all animations

onAnimationEnd?

() => void

defines the callback to call when an animation ends (will be called once per node)

onAnimationLoop?

() => void

defines the callback to call when an animation loops

isAdditive?

boolean

defines whether the animation should be evaluated additively (false by default)

Returns

Animatable

the list of created animatables

Inherited from

Scene.beginDirectAnimation

---

beginDirectHierarchyAnimation()

beginDirectHierarchyAnimation(target, directDescendantsOnly, animations, from, to, loop?, speedRatio?, onAnimationEnd?, onAnimationLoop?, isAdditive?): Animatable[]

Defined in: node_modules/@babylonjs/core/Animations/animatable.d.ts:94

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

loop?

boolean

defines if you want animation to loop (off by default)

speedRatio?

number

defines the speed ratio to apply to all animations

onAnimationEnd?

() => void

defines the callback to call when an animation ends (will be called once per node)

onAnimationLoop?

() => void

defines the callback to call when an animation loops

isAdditive?

boolean

defines whether the animation should be evaluated additively (false by default)

Returns

Animatable[]

the list of animatables created for all nodes

Inherited from

Scene.beginDirectHierarchyAnimation

---

beginHierarchyAnimation()

beginHierarchyAnimation(target, directDescendantsOnly, from, to, loop?, speedRatio?, onAnimationEnd?, animatable?, stopCurrent?, targetMask?, onAnimationLoop?, isAdditive?): Animatable[]

Defined in: node_modules/@babylonjs/core/Animations/animatable.d.ts:63

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.

loop?

boolean

defines if the animation loops

speedRatio?

number

defines the speed in which to run the animation (1.0 by default)

onAnimationEnd?

() => void

defines the function to be executed when the animation ends

animatable?

Animatable

defines an animatable object. If not provided a new one will be created from the given params

stopCurrent?

boolean

defines if the current animations must be stopped first (true by default)

targetMask?

(target) => boolean

defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)

onAnimationLoop?

() => void

defines the callback to call when an animation loops

isAdditive?

boolean

defines whether the animation should be evaluated additively (false by default)

Returns

Animatable[]

the list of created animatables

Inherited from

Scene.beginHierarchyAnimation

---

beginWeightedAnimation()

beginWeightedAnimation(target, from, to, weight, loop?, speedRatio?, onAnimationEnd?, animatable?, targetMask?, onAnimationLoop?, isAdditive?): Animatable

Defined in: node_modules/@babylonjs/core/Animations/animatable.d.ts:28

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)

loop?

boolean

defines if the animation loops

speedRatio?

number

defines the speed in which to run the animation (1.0 by default)

onAnimationEnd?

() => void

defines the function to be executed when the animation ends

animatable?

Animatable

defines an animatable object. If not provided a new one will be created from the given params

targetMask?

(target) => boolean

defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)

onAnimationLoop?

() => void

defines the callback to call when an animation loops

isAdditive?

boolean

defines whether the animation should be evaluated additively (false by default)

Returns

Animatable

the animatable object created for this animation

Inherited from

Scene.beginWeightedAnimation

---

bindEyePosition()

bindEyePosition(effect, variableName?, isVector3?): Vector4

Defined in: node_modules/@babylonjs/core/scene.d.ts:766

Bind the current view position to an effect.

Parameters

effect

Effect

The effect to be bound

variableName?

string

name of the shader variable that will hold the eye position

isVector3?

boolean

true to indicates that variableName is a Vector3 and not a Vector4

Returns

Vector4

the computed eye position

Inherited from

Scene.bindEyePosition

---

cleanCachedTextureBuffer()

cleanCachedTextureBuffer(): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2147

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

Inherited from

Scene.cleanCachedTextureBuffer

---

clearCachedVertexData()

clearCachedVertexData(): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2142

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

Inherited from

Scene.clearCachedVertexData

---

createDefaultCamera()

createDefaultCamera(createArcRotateCamera?, replace?, attachCameraControls?): void

Defined in: node_modules/@babylonjs/core/Helpers/sceneHelpers.d.ts:30

Creates a default camera for the scene.

Parameters

createArcRotateCamera?

boolean

has the default false which creates a free camera, when true creates an arc rotate camera

replace?

boolean

has default false, when true replaces the active camera in the scene

attachCameraControls?

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

Inherited from

Scene.createDefaultCamera

---

createDefaultCameraOrLight()

createDefaultCameraOrLight(createArcRotateCamera?, replace?, attachCameraControls?): void

Defined in: node_modules/@babylonjs/core/Helpers/sceneHelpers.d.ts:38

Creates a default camera and a default light.

Parameters

createArcRotateCamera?

boolean

has the default false which creates a free camera, when true creates an arc rotate camera

replace?

boolean

has the default false, when true replaces the active camera/light in the scene

attachCameraControls?

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

Inherited from

Scene.createDefaultCameraOrLight

---

createDefaultEnvironment()

createDefaultEnvironment(options?): EnvironmentHelper

Defined in: node_modules/@babylonjs/core/Helpers/sceneHelpers.d.ts:56

Creates a new environment

Parameters

options?

Partial<IEnvironmentHelperOptions>

defines the options you can use to configure the environment

Returns

EnvironmentHelper

the new EnvironmentHelper

See

https://doc.babylonjs.com/features/featuresDeepDive/scene/fastBuildWorld#create-default-environment

Inherited from

Scene.createDefaultEnvironment

---

createDefaultLight()

createDefaultLight(replace?): void

Defined in: node_modules/@babylonjs/core/Helpers/sceneHelpers.d.ts:22

Creates a default light for the scene.

Parameters

replace?

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

Inherited from

Scene.createDefaultLight

---

createDefaultSkybox()

createDefaultSkybox(environmentTexture?, pbr?, scale?, blur?, setGlobalEnvTexture?): Mesh

Defined in: node_modules/@babylonjs/core/Helpers/sceneHelpers.d.ts:49

Creates a new sky box

Parameters

environmentTexture?

BaseTexture

defines the texture to use as environment texture

pbr?

boolean

has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used

scale?

number

defines the overall scale of the skybox

blur?

number

is only available when pbr is true, default is 0, no blur, maximum value is 1

setGlobalEnvTexture?

boolean

has default true indicating that scene.environmentTexture must match the current skybox texture

Returns

Mesh

a new mesh holding the sky box

See

https://doc.babylonjs.com/features/featuresDeepDive/scene/fastBuildWorld#create-default-skybox

Inherited from

Scene.createDefaultSkybox

---

createDefaultVRExperience()

createDefaultVRExperience(webVROptions?): VRExperienceHelper

Defined in: node_modules/@babylonjs/core/Helpers/sceneHelpers.d.ts:64

Creates a new VREXperienceHelper

Parameters

webVROptions?

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

Inherited from

Scene.createDefaultVRExperience

---

createDefaultXRExperienceAsync()

createDefaultXRExperienceAsync(options?): Promise<WebXRDefaultExperience>

Defined in: node_modules/@babylonjs/core/Helpers/sceneHelpers.d.ts:71

Creates a new WebXRDefaultExperience

Parameters

options?

WebXRDefaultExperienceOptions

experience options

Returns

Promise<WebXRDefaultExperience>

a promise for a new WebXRDefaultExperience

See

https://doc.babylonjs.com/features/featuresDeepDive/webXR/introToWebXR

Inherited from

Scene.createDefaultXRExperienceAsync

---

createOrUpdateSelectionOctree()

createOrUpdateSelectionOctree(maxCapacity?, maxDepth?): Octree<AbstractMesh>

Defined in: node_modules/@babylonjs/core/Culling/Octrees/octreeSceneComponent.d.ts:27

Creates or updates the octree used to boost selection (picking)

Parameters

maxCapacity?

number

defines the maximum capacity per leaf

maxDepth?

number

defines the maximum depth of the octree

Returns

Octree<AbstractMesh>

an octree of AbstractMesh

See

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

Inherited from

Scene.createOrUpdateSelectionOctree

---

createPickingRay()

createPickingRay(x, y, world, camera, cameraViewSpace?): Ray

Defined in: node_modules/@babylonjs/core/scene.d.ts:2167

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

Matrix

defines the world matrix to use if you want to pick in object space (instead of world space)

camera

Camera

defines the camera to use for the picking

cameraViewSpace?

boolean

defines if picking will be done in view space (false by default)

Returns

Ray

a Ray

Inherited from

Scene.createPickingRay

---

createPickingRayInCameraSpace()

createPickingRayInCameraSpace(x, y, camera?): Ray

Defined in: node_modules/@babylonjs/core/scene.d.ts:2187

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)

camera?

Camera

defines the camera to use for the picking

Returns

Ray

a Ray

Inherited from

Scene.createPickingRayInCameraSpace

---

createPickingRayInCameraSpaceToRef()

createPickingRayInCameraSpaceToRef(x, y, result, camera?): Scene

Defined in: node_modules/@babylonjs/core/scene.d.ts:2196

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

camera?

Camera

defines the camera to use for the picking

Returns

Scene

the current scene

Inherited from

Scene.createPickingRayInCameraSpaceToRef

---

createPickingRayToRef()

createPickingRayToRef(x, y, world, result, camera, cameraViewSpace?, enableDistantPicking?): Scene

Defined in: node_modules/@babylonjs/core/scene.d.ts:2179

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

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

Camera

defines the camera to use for the picking

cameraViewSpace?

boolean

defines if picking will be done in view space (false by default)

enableDistantPicking?

boolean

defines if picking should handle large values for mesh position/scaling (false by default)

Returns

Scene

the current scene

Inherited from

Scene.createPickingRayToRef

---

createSceneUniformBuffer()

createSceneUniformBuffer(name?): UniformBuffer

Defined in: node_modules/@babylonjs/core/scene.d.ts:1518

Creates a scene UBO

Parameters

name?

string

name of the uniform buffer (optional, for debugging purpose only)

Returns

UniformBuffer

a new ubo

Inherited from

Scene.createSceneUniformBuffer

---

deleteCompoundImpostor()

deleteCompoundImpostor(compound): void

Defined in: node_modules/@babylonjs/core/Physics/joinedPhysicsEngineComponent.d.ts:43

Deletes a physics compound impostor

Parameters

compound

any

defines the compound to delete

Returns

void

Inherited from

Scene.deleteCompoundImpostor

---

detachControl()

detachControl(): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1402

Detaches all event handlers

Returns

void

Inherited from

Scene.detachControl

---

disableDepthRenderer()

disableDepthRenderer(camera?): void

Defined in: node_modules/@babylonjs/core/Rendering/depthRendererSceneComponent.d.ts:26

Disables a depth renderer for a given camera

Parameters

camera?

Camera

The camera to disable the depth renderer on (default: scene's active camera)

Returns

void

Inherited from

Scene.disableDepthRenderer

---

disableFluidRenderer()

disableFluidRenderer(): void

Defined in: node_modules/@babylonjs/core/Rendering/fluidRenderer/fluidRenderer.d.ts:25

Disables the fluid renderer associated with the scene

Returns

void

Inherited from

Scene.disableFluidRenderer

---

disableGeometryBufferRenderer()

disableGeometryBufferRenderer(): void

Defined in: node_modules/@babylonjs/core/Rendering/geometryBufferRendererSceneComponent.d.ts:32

Disables the GeometryBufferRender associated with the scene

Returns

void

Inherited from

Scene.disableGeometryBufferRenderer

---

disableIblCdfGenerator()

disableIblCdfGenerator(): void

Defined in: node_modules/@babylonjs/core/Rendering/iblCdfGeneratorSceneComponent.d.ts:24

Disables the GeometryBufferRender associated with the scene

Returns

void

Inherited from

Scene.disableIblCdfGenerator

---

disablePhysicsEngine()

disablePhysicsEngine(): void

Defined in: node_modules/@babylonjs/core/Physics/joinedPhysicsEngineComponent.d.ts:33

Disables and disposes the physics engine associated with the scene

Returns

void

Inherited from

Scene.disablePhysicsEngine

---

disablePrePassRenderer()

disablePrePassRenderer(): void

Defined in: node_modules/@babylonjs/core/Rendering/prePassRendererSceneComponent.d.ts:22

Disables the prepass associated with the scene

Returns

void

Inherited from

Scene.disablePrePassRenderer

---

disableSubSurfaceForPrePass()

disableSubSurfaceForPrePass(): void

Defined in: node_modules/@babylonjs/core/Rendering/subSurfaceSceneComponent.d.ts:21

Disables the subsurface effect for prepass

Returns

void

Inherited from

Scene.disableSubSurfaceForPrePass

---

dispose()

dispose(): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2132

Releases all held resources

Returns

void

Inherited from

Scene.dispose

---

enableDepthRenderer()

enableDepthRenderer(camera?, storeNonLinearDepth?, force32bitsFloat?, samplingMode?, storeCameraSpaceZ?): DepthRenderer

Defined in: node_modules/@babylonjs/core/Rendering/depthRendererSceneComponent.d.ts:21

Creates a depth renderer a given camera which contains a depth map which can be used for post processing.

Parameters

camera?

Camera

The camera to create the depth renderer on (default: scene's active camera)

storeNonLinearDepth?

boolean

Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z

force32bitsFloat?

boolean

Forces 32 bits float when supported (else 16 bits float is prioritized over 32 bits float if supported)

samplingMode?

number

The sampling mode to be used with the render target (Linear, Nearest...)

storeCameraSpaceZ?

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

Inherited from

Scene.enableDepthRenderer

---

enableFluidRenderer()

enableFluidRenderer(): FluidRenderer

Defined in: node_modules/@babylonjs/core/Rendering/fluidRenderer/fluidRenderer.d.ts:21

Enables the fluid renderer and associates it with the scene

Returns

FluidRenderer

the FluidRenderer

Inherited from

Scene.enableFluidRenderer

---

enableGeometryBufferRenderer()

enableGeometryBufferRenderer(ratioOrDimensions?, depthFormat?, textureTypesAndFormats?): GeometryBufferRenderer

Defined in: node_modules/@babylonjs/core/Rendering/geometryBufferRendererSceneComponent.d.ts:20

Enables a GeometryBufferRender and associates it with the scene

Parameters

ratioOrDimensions?

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

number | { height: number; width: number; }

depthFormat?

number

Format of the depth texture (default: Constants.TEXTUREFORMAT_DEPTH16)

textureTypesAndFormats?

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

GeometryBufferRenderer

the GeometryBufferRenderer

Inherited from

Scene.enableGeometryBufferRenderer

---

enableIblCdfGenerator()

enableIblCdfGenerator(): IblCdfGenerator

Defined in: node_modules/@babylonjs/core/Rendering/iblCdfGeneratorSceneComponent.d.ts:20

Enables a IblCdfGenerator and associates it with the scene.

Returns

IblCdfGenerator

the IblCdfGenerator

Inherited from

Scene.enableIblCdfGenerator

---

enablePhysics()

enablePhysics(gravity?, plugin?): boolean

Defined in: node_modules/@babylonjs/core/Physics/joinedPhysicsEngineComponent.d.ts:29

Enables physics to the current scene

Parameters

gravity?

Vector3

defines the scene's gravity for the physics engine. defaults to real earth gravity : (0, -9.81, 0)

plugin?

defines the physics engine to be used. defaults to CannonJS.

IPhysicsEnginePlugin | IPhysicsEnginePluginV2

Returns

boolean

a boolean indicating if the physics engine was initialized

Inherited from

Scene.enablePhysics

---

enablePrePassRenderer()

enablePrePassRenderer(): PrePassRenderer

Defined in: node_modules/@babylonjs/core/Rendering/prePassRendererSceneComponent.d.ts:18

Enables the prepass and associates it with the scene

Returns

PrePassRenderer

the PrePassRenderer

Inherited from

Scene.enablePrePassRenderer

---

enableSubSurfaceForPrePass()

enableSubSurfaceForPrePass(): SubSurfaceConfiguration

Defined in: node_modules/@babylonjs/core/Rendering/subSurfaceSceneComponent.d.ts:17

Enables the subsurface effect for prepass

Returns

SubSurfaceConfiguration

the SubSurfaceConfiguration

Inherited from

Scene.enableSubSurfaceForPrePass

---

executeOnceBeforeRender()

executeOnceBeforeRender(func, timeout?): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1440

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.

timeout?

number

optional delay in ms

Returns

void

Inherited from

Scene.executeOnceBeforeRender

---

executeWhenReady()

executeWhenReady(func, checkRenderTargets?): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1465

Registers a function to be executed when the scene is ready

Parameters

func

() => void

the function to be executed

checkRenderTargets?

boolean

true to also check that the meshes rendered as part of a render target are ready (default: false)

Returns

void

Inherited from

Scene.executeWhenReady

---

finalizeSceneUbo()

finalizeSceneUbo(): UniformBuffer

Defined in: node_modules/@babylonjs/core/scene.d.ts:771

Update the scene ubo before it can be used in rendering processing

Returns

UniformBuffer

the scene UniformBuffer

Inherited from

Scene.finalizeSceneUbo

---

freeActiveMeshes()

freeActiveMeshes(): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2022

Clear the active meshes smart array preventing retention point in mesh dispose.

Returns

void

Inherited from

Scene.freeActiveMeshes

---

freeProcessedMaterials()

freeProcessedMaterials(): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2010

Clear the processed materials smart array preventing retention point in material dispose.

Returns

void

Inherited from

Scene.freeProcessedMaterials

---

freeRenderingGroups()

freeRenderingGroups(): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2026

Clear the info related to rendering groups preventing retention points during dispose.

Returns

void

Inherited from

Scene.freeRenderingGroups

---

freezeActiveMeshes()

freezeActiveMeshes(skipEvaluateActiveMeshes?, onSuccess?, onError?, freezeMeshes?, keepFrustumCulling?): Scene

Defined in: node_modules/@babylonjs/core/scene.d.ts:2059

Use this function to stop evaluating active meshes. The current list will be keep alive between frames

Parameters

skipEvaluateActiveMeshes?

boolean

defines an optional boolean indicating that the evaluate active meshes step must be completely skipped

onSuccess?

() => void

optional success callback

onError?

(message) => void

optional error callback

freezeMeshes?

boolean

defines if meshes should be frozen (true by default)

keepFrustumCulling?

boolean

defines if you want to keep running the frustum clipping (false by default)

Returns

Scene

the current scene

Inherited from

Scene.freezeActiveMeshes

---

freezeMaterials()

freezeMaterials(): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2123

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

Inherited from

Scene.freezeMaterials

---

getActiveBones()

getActiveBones(): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1334

Gets the total number of active bones rendered per frame

Returns

number

the total number of active bones rendered per frame

Inherited from

Scene.getActiveBones

---

getActiveIndices()

getActiveIndices(): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1314

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

Inherited from

Scene.getActiveIndices

---

getActiveMeshes()

getActiveMeshes(): SmartArray<AbstractMesh>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1344

Gets the array of active meshes

Returns

SmartArray<AbstractMesh>

an array of AbstractMesh

Inherited from

Scene.getActiveMeshes

---

getActiveParticles()

getActiveParticles(): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1324

Gets the total number of active particles rendered per frame

Returns

number

the total number of active particles rendered per frame

Inherited from

Scene.getActiveParticles

---

getAllAnimatablesByTarget()

getAllAnimatablesByTarget(target): Animatable[]

Defined in: node_modules/@babylonjs/core/Animations/animatable.d.ts:106

Gets all animatables associated with a given target

Parameters

target

any

defines the target to look animatables for

Returns

Animatable[]

an array of Animatables

Inherited from

Scene.getAllAnimatablesByTarget

---

getAllSceneExtends()

getAllSceneExtends(): object

Defined in: packages/core/sdk/src/core/PScene.ts:29

获取场景中所有的网格形成的包围盒. 排除隐藏和未启用的网格

Returns

object

max

max: Vector3

min

min: Vector3

---

getAnimatableByTarget()

getAnimatableByTarget(target): Animatable

Defined in: node_modules/@babylonjs/core/Animations/animatable.d.ts:100

Gets the animatable associated with a specific target

Parameters

target

any

defines the target of the animatable

Returns

Animatable

the required animatable if found

Inherited from

Scene.getAnimatableByTarget

---

getAnimationGroupByName()

getAnimationGroupByName(name): AnimationGroup

Defined in: node_modules/@babylonjs/core/scene.d.ts:1715

get an animation group using its name

Parameters

name

string

defines the material's name

Returns

AnimationGroup

the animation group or null if none found.

Inherited from

Scene.getAnimationGroupByName

---

getAnimationRatio()

getAnimationRatio(): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1349

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

Inherited from

Scene.getAnimationRatio

---

getAutoClearDepthStencilSetup()

getAutoClearDepthStencilSetup(index): IRenderingManagerAutoClearSetup

Defined in: node_modules/@babylonjs/core/scene.d.ts:2331

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

Inherited from

Scene.getAutoClearDepthStencilSetup

---

getBoneById()

getBoneById(id): Bone

Defined in: node_modules/@babylonjs/core/scene.d.ts:1780

Gets a bone using its Id

Parameters

id

string

defines the bone's Id

Returns

Bone

the bone or null if not found

Inherited from

Scene.getBoneById

---

getBoneByID()

getBoneByID(id): Bone

Defined in: node_modules/@babylonjs/core/scene.d.ts:2424

Gets a bone using its Id

Parameters

id

string

defines the bone's Id

Returns

Bone

the bone or null if not found

Deprecated

Please use getBoneById instead

Inherited from

Scene.getBoneByID

---

getBoneByName()

getBoneByName(name): Bone

Defined in: node_modules/@babylonjs/core/scene.d.ts:1786

Gets a bone using its id

Parameters

name

string

defines the bone's name

Returns

Bone

the bone or null if not found

Inherited from

Scene.getBoneByName

---

getBoundingBoxRenderer()

getBoundingBoxRenderer(): BoundingBoxRenderer

Defined in: node_modules/@babylonjs/core/Rendering/boundingBoxRenderer.d.ts:25

Gets the bounding box renderer associated with the scene

Returns

BoundingBoxRenderer

a BoundingBoxRenderer

Inherited from

Scene.getBoundingBoxRenderer

---

getCachedEffect()

getCachedEffect(): Effect

Defined in: node_modules/@babylonjs/core/scene.d.ts:1281

Gets the cached effect (ie. the latest rendered one)

Returns

Effect

the cached effect

Inherited from

Scene.getCachedEffect

---

getCachedMaterial()

getCachedMaterial(): Material

Defined in: node_modules/@babylonjs/core/scene.d.ts:1276

Gets the cached material (ie. the latest rendered one)

Returns

Material

the cached material

Inherited from

Scene.getCachedMaterial

---

getCachedVisibility()

getCachedVisibility(): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1286

Gets the cached visibility state (ie. the latest rendered one)

Returns

number

the cached visibility state

Inherited from

Scene.getCachedVisibility

---

getCameraById()

getCameraById(id): Camera

Defined in: node_modules/@babylonjs/core/scene.d.ts:1762

Gets a camera using its Id

Parameters

id

string

defines the Id to look for

Returns

Camera

the camera or null if not found

Inherited from

Scene.getCameraById

---

getCameraByID()

getCameraByID(id): Camera

Defined in: node_modules/@babylonjs/core/scene.d.ts:2410

Gets a camera using its Id

Parameters

id

string

defines the Id to look for

Returns

Camera

the camera or null if not found

Deprecated

Please use getCameraById instead

Inherited from

Scene.getCameraByID

---

getCameraByName()

getCameraByName(name): Camera

Defined in: node_modules/@babylonjs/core/scene.d.ts:1774

Gets a camera using its name

Parameters

name

string

defines the camera's name

Returns

Camera

the camera or null if none found.

Inherited from

Scene.getCameraByName

---

getCameraByUniqueId()

getCameraByUniqueId(uniqueId): Camera

Defined in: node_modules/@babylonjs/core/scene.d.ts:1768

Gets a camera using its unique Id

Parameters

uniqueId

number

defines the unique Id to look for

Returns

Camera

the camera or null if not found

Inherited from

Scene.getCameraByUniqueId

---

getCameraByUniqueID()

getCameraByUniqueID(uniqueId): Camera

Defined in: node_modules/@babylonjs/core/scene.d.ts:2417

Gets a camera using its unique Id

Parameters

uniqueId

number

defines the unique Id to look for

Returns

Camera

the camera or null if not found

Deprecated

Please use getCameraByUniqueId instead

Inherited from

Scene.getCameraByUniqueID

---

getCamerasByTags()

getCamerasByTags(tagsQuery, filter?): Camera[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:2284

Get a list of cameras by tags

Parameters

tagsQuery

string

defines the tags query to use

filter?

(camera) => boolean

defines a predicate used to filter results

Returns

Camera[]

an array of Camera

Inherited from

Scene.getCamerasByTags

---

getClassName()

getClassName(): string

Defined in: node_modules/@babylonjs/core/scene.d.ts:1241

Gets a string identifying the name of the class

Returns

string

"Scene" string

Inherited from

Scene.getClassName

---

getEngine()

getEngine(): AbstractEngine

Defined in: node_modules/@babylonjs/core/scene.d.ts:1299

Gets the engine associated with the scene

Returns

AbstractEngine

an Engine

Inherited from

Scene.getEngine

---

getExternalData()

getExternalData<T>(key): T

Defined in: node_modules/@babylonjs/core/scene.d.ts:1992

Get an externally attached data from its key

Type Parameters

T

T

Parameters

key

string

the unique key that identifies the data

Returns

T

the associated data, if present (can be null), or undefined if not present

Inherited from

Scene.getExternalData

---

getFrameGraphByName()

getFrameGraphByName(name): FrameGraph

Defined in: node_modules/@babylonjs/core/scene.d.ts:1823

Gets a frame graph using its name

Parameters

name

string

defines the frame graph's name

Returns

FrameGraph

the frame graph or null if none found.

Inherited from

Scene.getFrameGraphByName

---

getFrameId()

getFrameId(): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1359

Gets an unique Id for the current frame

Returns

number

a number

Inherited from

Scene.getFrameId

---

getGeometries()

getGeometries(): Geometry[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:1841

Gets the list of geometries attached to the scene

Returns

Geometry[]

an array of Geometry

Inherited from

Scene.getGeometries

---

getGeometryById()

getGeometryById(id): Geometry

Defined in: node_modules/@babylonjs/core/scene.d.ts:1816

Gets a geometry using its Id

Parameters

id

string

defines the geometry's Id

Returns

Geometry

the geometry or null if none found.

Inherited from

Scene.getGeometryById

---

getGeometryByID()

getGeometryByID(id): Geometry

Defined in: node_modules/@babylonjs/core/scene.d.ts:2452

Gets a geometry using its Id

Parameters

id

string

defines the geometry's Id

Returns

Geometry

the geometry or null if none found.

Deprecated

Please use getGeometryById instead

Inherited from

Scene.getGeometryByID

---

getGlowLayerByName()

getGlowLayerByName(name): GlowLayer

Defined in: node_modules/@babylonjs/core/Layers/glowLayer.d.ts:21

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

GlowLayer

The glow layer if found otherwise null.

Inherited from

Scene.getGlowLayerByName

---

getHighlightLayerByName()

getHighlightLayerByName(name): HighlightLayer

Defined in: node_modules/@babylonjs/core/Layers/highlightLayer.d.ts:21

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

HighlightLayer

The highlight layer if found otherwise null.

Inherited from

Scene.getHighlightLayerByName

---

getInternalStep()

getInternalStep(): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:809

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

Inherited from

Scene.getInternalStep

---

getLastEntryById()

getLastEntryById(id): Node

Defined in: node_modules/@babylonjs/core/scene.d.ts:1895

Gets a the last added node (Mesh, Camera, Light) using a given Id

Parameters

id

string

defines the Id to search for

Returns

Node

the found node or null if not found at all

Inherited from

Scene.getLastEntryById

---

getLastEntryByID()

getLastEntryByID(id): Node

Defined in: node_modules/@babylonjs/core/scene.d.ts:2515

Gets a the last added node (Mesh, Camera, Light) using a given Id

Parameters

id

string

defines the Id to search for

Returns

Node

the found node or null if not found at all

Deprecated

Please use getLastEntryById instead

Inherited from

Scene.getLastEntryByID

---

getLastMaterialById()

getLastMaterialById(id, allowMultiMaterials?): Material

Defined in: node_modules/@babylonjs/core/scene.d.ts:1744

Gets a last added material using a given id

Parameters

id

string

defines the material's id

allowMultiMaterials?

boolean

determines whether multimaterials should be considered

Returns

Material

the last material with the given id or null if none found.

Inherited from

Scene.getLastMaterialById

---

getLastMaterialByID()

getLastMaterialByID(id): Material

Defined in: node_modules/@babylonjs/core/scene.d.ts:2396

Gets a the last added material using a given id

Parameters

id

string

defines the material's Id

Returns

Material

the last material with the given id or null if none found.

Deprecated

Please use getLastMaterialById instead

Inherited from

Scene.getLastMaterialByID

---

getLastMeshById()

getLastMeshById(id): AbstractMesh

Defined in: node_modules/@babylonjs/core/scene.d.ts:1883

Gets a the last added mesh using a given Id

Parameters

id

string

defines the Id to search for

Returns

AbstractMesh

the found mesh or null if not found at all.

Inherited from

Scene.getLastMeshById

---

getLastMeshByID()

getLastMeshByID(id): AbstractMesh

Defined in: node_modules/@babylonjs/core/scene.d.ts:2473

Gets a the last added mesh using a given Id

Parameters

id

string

defines the Id to search for

Returns

AbstractMesh

the found mesh or null if not found at all.

Deprecated

Please use getLastMeshById instead

Inherited from

Scene.getLastMeshByID

---

getLastSkeletonById()

getLastSkeletonById(id): Skeleton

Defined in: node_modules/@babylonjs/core/scene.d.ts:1925

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

Skeleton

the found skeleton or null if not found at all.

Inherited from

Scene.getLastSkeletonById

---

getLastSkeletonByID()

getLastSkeletonByID(id): Skeleton

Defined in: node_modules/@babylonjs/core/scene.d.ts:2522

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

Skeleton

the found skeleton or null if not found at all.

Deprecated

Please use getLastSkeletonById instead

Inherited from

Scene.getLastSkeletonByID

---

getLastTransformNodeById()

getLastTransformNodeById(id): TransformNode

Defined in: node_modules/@babylonjs/core/scene.d.ts:1889

Gets a the last transform node using a given Id

Parameters

id

string

defines the Id to search for

Returns

TransformNode

the found mesh or null if not found at all.

Inherited from

Scene.getLastTransformNodeById

---

getLensFlareSystemById()

getLensFlareSystemById(id): LensFlareSystem

Defined in: node_modules/@babylonjs/core/LensFlares/lensFlareSystemSceneComponent.d.ts:37

Gets a lens flare system using its Id

Parameters

id

string

defines the Id to look for

Returns

LensFlareSystem

the lens flare system or null if not found

Inherited from

Scene.getLensFlareSystemById

---

getLensFlareSystemByID()

getLensFlareSystemByID(id): LensFlareSystem

Defined in: node_modules/@babylonjs/core/LensFlares/lensFlareSystemSceneComponent.d.ts:31

Gets a lens flare system using its Id

Parameters

id

string

defines the Id to look for

Returns

LensFlareSystem

the lens flare system or null if not found

Deprecated

Please use getLensFlareSystemById instead

Inherited from

Scene.getLensFlareSystemByID

---

getLensFlareSystemByName()

getLensFlareSystemByName(name): LensFlareSystem

Defined in: node_modules/@babylonjs/core/LensFlares/lensFlareSystemSceneComponent.d.ts:24

Gets a lens flare system using its name

Parameters

name

string

defines the name to look for

Returns

LensFlareSystem

the lens flare system or null if not found

Inherited from

Scene.getLensFlareSystemByName

---

getLightById()

getLightById(id): Light

Defined in: node_modules/@babylonjs/core/scene.d.ts:1798

Gets a light node using its Id

Parameters

id

string

defines the light's Id

Returns

Light

the light or null if none found.

Inherited from

Scene.getLightById

---

getLightByID()

getLightByID(id): Light

Defined in: node_modules/@babylonjs/core/scene.d.ts:2431

Gets a light node using its Id

Parameters

id

string

defines the light's Id

Returns

Light

the light or null if none found.

Deprecated

Please use getLightById instead

Inherited from

Scene.getLightByID

---

getLightByName()

getLightByName(name): Light

Defined in: node_modules/@babylonjs/core/scene.d.ts:1792

Gets a light node using its name

Parameters

name

string

defines the light's name

Returns

Light

the light or null if none found.

Inherited from

Scene.getLightByName

---

getLightByUniqueId()

getLightByUniqueId(uniqueId): Light

Defined in: node_modules/@babylonjs/core/scene.d.ts:1804

Gets a light node using its scene-generated unique Id

Parameters

uniqueId

number

defines the light's unique Id

Returns

Light

the light or null if none found.

Inherited from

Scene.getLightByUniqueId

---

getLightByUniqueID()

getLightByUniqueID(uniqueId): Light

Defined in: node_modules/@babylonjs/core/scene.d.ts:2438

Gets a light node using its scene-generated unique Id

Parameters

uniqueId

number

defines the light's unique Id

Returns

Light

the light or null if none found.

Deprecated

Please use getLightByUniqueId instead

Inherited from

Scene.getLightByUniqueID

---

getLightsByTags()

getLightsByTags(tagsQuery, filter?): Light[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:2291

Get a list of lights by tags

Parameters

tagsQuery

string

defines the tags query to use

filter?

(light) => boolean

defines a predicate used to filter results

Returns

Light[]

an array of Light

Inherited from

Scene.getLightsByTags

---

getMaterialById()

getMaterialById(id, allowMultiMaterials?): Material

Defined in: node_modules/@babylonjs/core/scene.d.ts:1730

get a material using its id

Parameters

id

string

defines the material's Id

allowMultiMaterials?

boolean

determines whether multimaterials should be considered

Returns

Material

the material or null if none found.

Inherited from

Scene.getMaterialById

---

getMaterialByID()

getMaterialByID(id): Material

Defined in: node_modules/@babylonjs/core/scene.d.ts:2389

Get a material using its id

Parameters

id

string

defines the material's Id

Returns

Material

the material or null if none found.

Deprecated

Please use getMaterialById instead

Inherited from

Scene.getMaterialByID

---

getMaterialByName()

getMaterialByName(name, allowMultiMaterials?): Material

Defined in: node_modules/@babylonjs/core/scene.d.ts:1737

Gets a material using its name

Parameters

name

string

defines the material's name

allowMultiMaterials?

boolean

determines whether multimaterials should be considered

Returns

Material

the material or null if none found.

Inherited from

Scene.getMaterialByName

---

getMaterialByTags()

getMaterialByTags(tagsQuery, filter?): Material[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:2298

Get a list of materials by tags

Parameters

tagsQuery

string

defines the tags query to use

filter?

(material) => boolean

defines a predicate used to filter results

Returns

Material[]

an array of Material

Inherited from

Scene.getMaterialByTags

---

getMaterialByUniqueID()

getMaterialByUniqueID(uniqueId, allowMultiMaterials?): Material

Defined in: node_modules/@babylonjs/core/scene.d.ts:1723

Get a material using its unique id

Parameters

uniqueId

number

defines the material's unique id

allowMultiMaterials?

boolean

determines whether multimaterials should be considered

Returns

Material

the material or null if none found.

Inherited from

Scene.getMaterialByUniqueID

---

getMeshById()

getMeshById(id): AbstractMesh

Defined in: node_modules/@babylonjs/core/scene.d.ts:1847

Gets the first added mesh found of a given Id

Parameters

id

string

defines the Id to search for

Returns

AbstractMesh

the mesh found or null if not found at all

Inherited from

Scene.getMeshById

---

getMeshByID()

getMeshByID(id): AbstractMesh

Defined in: node_modules/@babylonjs/core/scene.d.ts:2459

Gets the first added mesh found of a given Id

Parameters

id

string

defines the Id to search for

Returns

AbstractMesh

the mesh found or null if not found at all

Deprecated

Please use getMeshById instead

Inherited from

Scene.getMeshByID

---

getMeshByName()

getMeshByName(name): AbstractMesh

Defined in: node_modules/@babylonjs/core/scene.d.ts:1913

Gets a mesh using a given name

Parameters

name

string

defines the name to search for

Returns

AbstractMesh

the found mesh or null if not found at all.

Inherited from

Scene.getMeshByName

---

getMeshByUniqueId()

getMeshByUniqueId(uniqueId): AbstractMesh

Defined in: node_modules/@babylonjs/core/scene.d.ts:1877

Gets a mesh with its auto-generated unique Id

Parameters

uniqueId

number

defines the unique Id to search for

Returns

AbstractMesh

the found mesh or null if not found at all.

Inherited from

Scene.getMeshByUniqueId

---

getMeshByUniqueID()

getMeshByUniqueID(uniqueId): AbstractMesh

Defined in: node_modules/@babylonjs/core/scene.d.ts:2466

Gets a mesh with its auto-generated unique Id

Parameters

uniqueId

number

defines the unique Id to search for

Returns

AbstractMesh

the found mesh or null if not found at all.

Deprecated

Please use getMeshByUniqueId instead

Inherited from

Scene.getMeshByUniqueID

---

getMeshesById()

getMeshesById(id): AbstractMesh[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:1853

Gets a list of meshes using their Id

Parameters

id

string

defines the Id to search for

Returns

AbstractMesh[]

a list of meshes

Inherited from

Scene.getMeshesById

---

getMeshesByID()

getMeshesByID(id): AbstractMesh[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:2480

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

Inherited from

Scene.getMeshesByID

---

getMeshesByTags()

getMeshesByTags(tagsQuery, filter?): AbstractMesh[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:2277

Get a list of meshes by tags

Parameters

tagsQuery

string

defines the tags query to use

filter?

(mesh) => boolean

defines a predicate used to filter results

Returns

AbstractMesh[]

an array of Mesh

Inherited from

Scene.getMeshesByTags

---

getMorphTargetById()

getMorphTargetById(id): MorphTarget

Defined in: node_modules/@babylonjs/core/scene.d.ts:1955

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

MorphTarget

the found morph target or null if not found at all.

Inherited from

Scene.getMorphTargetById

---

getMorphTargetByName()

getMorphTargetByName(name): MorphTarget

Defined in: node_modules/@babylonjs/core/scene.d.ts:1961

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

MorphTarget

the found morph target or null if not found at all.

Inherited from

Scene.getMorphTargetByName

---

getMorphTargetManagerById()

getMorphTargetManagerById(id): MorphTargetManager

Defined in: node_modules/@babylonjs/core/scene.d.ts:1949

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

MorphTargetManager

the found morph target manager or null if not found at all.

Inherited from

Scene.getMorphTargetManagerById

---

getNodeById()

getNodeById(id): Node

Defined in: node_modules/@babylonjs/core/scene.d.ts:1901

Gets a node (Mesh, Camera, Light) using a given Id

Parameters

id

string

defines the Id to search for

Returns

Node

the found node or null if not found at all

Inherited from

Scene.getNodeById

---

getNodeByID()

getNodeByID(id): Node

Defined in: node_modules/@babylonjs/core/scene.d.ts:2508

Gets a node (Mesh, Camera, Light) using a given Id

Parameters

id

string

defines the Id to search for

Returns

Node

the found node or null if not found at all

Deprecated

Please use getNodeById instead

Inherited from

Scene.getNodeByID

---

getNodeByName()

getNodeByName(name): Node

Defined in: node_modules/@babylonjs/core/scene.d.ts:1907

Gets a node (Mesh, Camera, Light) using a given name

Parameters

name

string

defines the name to search for

Returns

Node

the found node or null if not found at all.

Inherited from

Scene.getNodeByName

---

getNodes()

getNodes(): Node[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:384

Returns

Node[]

all meshes, lights, cameras, transformNodes and bones

Inherited from

Scene.getNodes

---

getOrAddExternalDataWithFactory()

getOrAddExternalDataWithFactory<T>(key, factory): T

Defined in: node_modules/@babylonjs/core/scene.d.ts:1999

Get an externally attached data from its key, create it using a factory if it's not already present

Type Parameters

T

T extends Object

Parameters

key

string

the unique key that identifies the data

factory

(k) => 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.

Inherited from

Scene.getOrAddExternalDataWithFactory

---

getOutlineRenderer()

getOutlineRenderer(): OutlineRenderer

Defined in: node_modules/@babylonjs/core/Rendering/outlineRenderer.d.ts:14

Gets the outline renderer associated with the scene

Returns

OutlineRenderer

a OutlineRenderer

Inherited from

Scene.getOutlineRenderer

---

getParticleSystemById()

getParticleSystemById(id): IParticleSystem

Defined in: node_modules/@babylonjs/core/scene.d.ts:1810

Gets a particle system by Id

Parameters

id

string

defines the particle system Id

Returns

IParticleSystem

the corresponding system or null if none found

Inherited from

Scene.getParticleSystemById

---

getParticleSystemByID()

getParticleSystemByID(id): IParticleSystem

Defined in: node_modules/@babylonjs/core/scene.d.ts:2445

Gets a particle system by Id

Parameters

id

string

defines the particle system Id

Returns

IParticleSystem

the corresponding system or null if none found

Deprecated

Please use getParticleSystemById instead

Inherited from

Scene.getParticleSystemByID

---

getPerfCollector()

getPerfCollector(): PerformanceViewerCollector

Defined in: node_modules/@babylonjs/core/scene.d.ts:2375

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.

Inherited from

Scene.getPerfCollector

---

getPhysicsEngine()

getPhysicsEngine(): IPhysicsEngine

Defined in: node_modules/@babylonjs/core/Physics/joinedPhysicsEngineComponent.d.ts:22

Gets the current physics engine

Returns

IPhysicsEngine

a IPhysicsEngine or null if none attached

Inherited from

Scene.getPhysicsEngine

---

getPointerOverMesh()

getPointerOverMesh(): AbstractMesh

Defined in: node_modules/@babylonjs/core/scene.d.ts:2258

Gets the mesh under the pointer

Returns

AbstractMesh

a Mesh or null if no mesh is under the pointer

Inherited from

Scene.getPointerOverMesh

---

getPointerOverSprite()

getPointerOverSprite(): Sprite

Defined in: node_modules/@babylonjs/core/Sprites/spriteSceneComponent.d.ts:78

Gets the sprite under the pointer

Returns

Sprite

a Sprite or null if no sprite is under the pointer

Inherited from

Scene.getPointerOverSprite

---

getPostProcessByName()

getPostProcessByName(name): PostProcess

Defined in: node_modules/@babylonjs/core/scene.d.ts:1967

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

PostProcess

the found post process or null if not found at all.

Inherited from

Scene.getPostProcessByName

---

getProjectionMatrix()

getProjectionMatrix(): Matrix

Defined in: node_modules/@babylonjs/core/scene.d.ts:1494

Gets the current projection matrix

Returns

Matrix

a Matrix

Inherited from

Scene.getProjectionMatrix

---

getRenderId()

getRenderId(): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1354

Gets an unique Id for the current render phase

Returns

number

a number

Inherited from

Scene.getRenderId

---

getSceneUniformBuffer()

getSceneUniformBuffer(): UniformBuffer

Defined in: node_modules/@babylonjs/core/scene.d.ts:1512

Gets the uniform buffer used to store scene data

Returns

UniformBuffer

a UniformBuffer

Inherited from

Scene.getSceneUniformBuffer

---

getSkeletonById()

getSkeletonById(id): Skeleton

Defined in: node_modules/@babylonjs/core/scene.d.ts:1937

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

Skeleton

the found skeleton or null if not found at all.

Inherited from

Scene.getSkeletonById

---

getSkeletonByName()

getSkeletonByName(name): Skeleton

Defined in: node_modules/@babylonjs/core/scene.d.ts:1943

Gets a skeleton using a given name

Parameters

name

string

defines the name to search for

Returns

Skeleton

the found skeleton or null if not found at all.

Inherited from

Scene.getSkeletonByName

---

getSkeletonByUniqueId()

getSkeletonByUniqueId(uniqueId): Skeleton

Defined in: node_modules/@babylonjs/core/scene.d.ts:1931

Gets a skeleton using a given auto generated unique id

Parameters

uniqueId

number

defines the unique id to search for

Returns

Skeleton

the found skeleton or null if not found at all.

Inherited from

Scene.getSkeletonByUniqueId

---

getSoundByName()

getSoundByName(name): Sound

Defined in: node_modules/@babylonjs/core/Audio/audioSceneComponent.d.ts:31

Gets a sound using a given name

Parameters

name

string

defines the name to search for

Returns

Sound

the found sound or null if not found at all.

Inherited from

Scene.getSoundByName

---

getStepId()

getStepId(): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:803

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

Inherited from

Scene.getStepId

---

getTextureByName()

getTextureByName(name): BaseTexture

Defined in: node_modules/@babylonjs/core/scene.d.ts:1756

Gets a texture using its name

Parameters

name

string

defines the texture's name

Returns

BaseTexture

the texture or null if none found.

Inherited from

Scene.getTextureByName

---

getTextureByUniqueId()

getTextureByUniqueId(uniqueId): BaseTexture

Defined in: node_modules/@babylonjs/core/scene.d.ts:1750

Get a texture using its unique id

Parameters

uniqueId

number

defines the texture's unique id

Returns

BaseTexture

the texture or null if none found.

Inherited from

Scene.getTextureByUniqueId

---

getTextureByUniqueID()

getTextureByUniqueID(uniqueId): BaseTexture

Defined in: node_modules/@babylonjs/core/scene.d.ts:2403

Get a texture using its unique id

Parameters

uniqueId

number

defines the texture's unique id

Returns

BaseTexture

the texture or null if none found.

Deprecated

Please use getTextureByUniqueId instead

Inherited from

Scene.getTextureByUniqueID

---

getTotalVertices()

getTotalVertices(): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1304

Gets the total number of vertices rendered per frame

Returns

number

the total number of vertices rendered per frame

Inherited from

Scene.getTotalVertices

---

getTransformMatrix()

getTransformMatrix(): Matrix

Defined in: node_modules/@babylonjs/core/scene.d.ts:1499

Gets the current transform matrix

Returns

Matrix

a Matrix made of View * Projection

Inherited from

Scene.getTransformMatrix

---

getTransformNodeById()

getTransformNodeById(id): TransformNode

Defined in: node_modules/@babylonjs/core/scene.d.ts:1859

Gets the first added transform node found of a given Id

Parameters

id

string

defines the Id to search for

Returns

TransformNode

the found transform node or null if not found at all.

Inherited from

Scene.getTransformNodeById

---

getTransformNodeByID()

getTransformNodeByID(id): TransformNode

Defined in: node_modules/@babylonjs/core/scene.d.ts:2487

Gets the first added transform node found of a given Id

Parameters

id

string

defines the Id to search for

Returns

TransformNode

the found transform node or null if not found at all.

Deprecated

Please use getTransformNodeById instead

Inherited from

Scene.getTransformNodeByID

---

getTransformNodeByName()

getTransformNodeByName(name): TransformNode

Defined in: node_modules/@babylonjs/core/scene.d.ts:1919

Gets a transform node using a given name

Parameters

name

string

defines the name to search for

Returns

TransformNode

the found transform node or null if not found at all.

Inherited from

Scene.getTransformNodeByName

---

getTransformNodeByUniqueId()

getTransformNodeByUniqueId(uniqueId): TransformNode

Defined in: node_modules/@babylonjs/core/scene.d.ts:1865

Gets a transform node with its auto-generated unique Id

Parameters

uniqueId

number

defines the unique Id to search for

Returns

TransformNode

the found transform node or null if not found at all.

Inherited from

Scene.getTransformNodeByUniqueId

---

getTransformNodeByUniqueID()

getTransformNodeByUniqueID(uniqueId): TransformNode

Defined in: node_modules/@babylonjs/core/scene.d.ts:2494

Gets a transform node with its auto-generated unique Id

Parameters

uniqueId

number

defines the unique Id to search for

Returns

TransformNode

the found transform node or null if not found at all.

Deprecated

Please use getTransformNodeByUniqueId instead

Inherited from

Scene.getTransformNodeByUniqueID

---

getTransformNodesById()

getTransformNodesById(id): TransformNode[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:1871

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

Inherited from

Scene.getTransformNodesById

---

getTransformNodesByID()

getTransformNodesByID(id): TransformNode[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:2501

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

Inherited from

Scene.getTransformNodesByID

---

getTransformNodesByTags()

getTransformNodesByTags(tagsQuery, filter?): TransformNode[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:2305

Get a list of transform nodes by tags

Parameters

tagsQuery

string

defines the tags query to use

filter?

(transform) => boolean

defines a predicate used to filter results

Returns

TransformNode[]

an array of TransformNode

Inherited from

Scene.getTransformNodesByTags

---

getUniqueId()

getUniqueId(): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1528

Gets an unique (relatively to the current scene) Id

Returns

number

an unique number for the scene

Inherited from

Scene.getUniqueId

---

getViewMatrix()

getViewMatrix(): Matrix

Defined in: node_modules/@babylonjs/core/scene.d.ts:1489

Gets the current view matrix

Returns

Matrix

a Matrix

Inherited from

Scene.getViewMatrix

---

getWaitingItemsCount()

getWaitingItemsCount(): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1455

Returns the number of items waiting to be loaded

Returns

number

the number of items waiting to be loaded

Inherited from

Scene.getWaitingItemsCount

---

getWorldExtends()

getWorldExtends(filterPredicate?): object

Defined in: node_modules/@babylonjs/core/scene.d.ts:2154

Get the world extend vectors with an optional filter

Parameters

filterPredicate?

(mesh) => boolean

the predicate - which meshes should be included when calculating the world size

Returns

object

min and max vectors

max

max: Vector3

min

min: Vector3

Inherited from

Scene.getWorldExtends

---

incrementRenderId()

incrementRenderId(): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1361

Call this function if you want to manually increment the render Id

Returns

void

Inherited from

Scene.incrementRenderId

---

isActiveMesh()

isActiveMesh(mesh): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:1973

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

Inherited from

Scene.isActiveMesh

---

isCachedMaterialInvalid()

isCachedMaterialInvalid(material, effect, visibility?): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:1294

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

visibility?

number

defines the current visibility state

Returns

boolean

true if one parameter is not cached

Inherited from

Scene.isCachedMaterialInvalid

---

isPhysicsEnabled()

isPhysicsEnabled(): boolean

Defined in: node_modules/@babylonjs/core/Physics/joinedPhysicsEngineComponent.d.ts:38

Gets a boolean indicating if there is an active physics engine

Returns

boolean

a boolean indicating if there is an active physics engine

Inherited from

Scene.isPhysicsEnabled

---

isPointerCaptured()

isPointerCaptured(pointerId?): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:1393

Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)

Parameters

pointerId?

number

defines the pointer id to use in a multi-touch scenario (0 by default)

Returns

boolean

true if the pointer was captured

Inherited from

Scene.isPointerCaptured

---

isReady()

isReady(checkRenderTargets?): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:1409

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

checkRenderTargets?

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

Inherited from

Scene.isReady

---

markAllMaterialsAsDirty()

markAllMaterialsAsDirty(flag, predicate?): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2343

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

predicate?

(mat) => boolean

If not null, it will be used to specify if a material has to be marked as dirty

Returns

void

Inherited from

Scene.markAllMaterialsAsDirty

---

multiPick()

multiPick(x, y, predicate?, camera?, trianglePredicate?): PickingInfo[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:2238

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

predicate?

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

camera?

Camera

camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used

trianglePredicate?

TrianglePickingPredicate

defines an optional predicate used to select faces when a mesh intersection is detected

Returns

PickingInfo[]

an array of PickingInfo

Inherited from

Scene.multiPick

---

multiPickSprite()

multiPickSprite(x, y, predicate?, camera?): PickingInfo[]

Defined in: node_modules/@babylonjs/core/Sprites/spriteSceneComponent.d.ts:61

Launch a ray to try to pick sprites in the scene

Parameters

x

number

position on screen

y

number

position on screen

predicate?

(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

camera?

Camera

camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used

Returns

PickingInfo[]

a PickingInfo array

Inherited from

Scene.multiPickSprite

---

multiPickSpriteWithRay()

multiPickSpriteWithRay(ray, predicate?, camera?): PickingInfo[]

Defined in: node_modules/@babylonjs/core/Sprites/spriteSceneComponent.d.ts:68

Use the given ray to pick sprites in the scene

Parameters

ray

Ray

The ray (in world space) to use to pick meshes

predicate?

(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

camera?

Camera

camera to use. Can be set to null. In this case, the scene.activeCamera will be used

Returns

PickingInfo[]

a PickingInfo array

Inherited from

Scene.multiPickSpriteWithRay

---

multiPickWithRay()

multiPickWithRay(ray, predicate?, trianglePredicate?): PickingInfo[]

Defined in: node_modules/@babylonjs/core/scene.d.ts:2246

Launch a ray to try to pick a mesh in the scene

Parameters

ray

Ray

Ray to use

predicate?

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

trianglePredicate?

TrianglePickingPredicate

defines an optional predicate used to select faces when a mesh intersection is detected

Returns

PickingInfo[]

an array of PickingInfo

Inherited from

Scene.multiPickWithRay

---

objectIsInScene()

objectIsInScene(node): boolean

Defined in: packages/core/sdk/src/core/PScene.ts:16

判断场景中是否包含指定的节点

Parameters

node

Node

节点

Returns

boolean

是否包含

---

pick()

pick(x, y, predicate?, fastCheck?, camera?, trianglePredicate?): PickingInfo

Defined in: node_modules/@babylonjs/core/scene.d.ts:2208

Launch a ray to try to pick a mesh in the scene

Parameters

x

number

position on screen

y

number

position on screen

predicate?

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

fastCheck?

boolean

defines if the first intersection will be used (and not the closest)

camera?

Camera

to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used

trianglePredicate?

TrianglePickingPredicate

defines an optional predicate used to select faces when a mesh intersection is detected

Returns

PickingInfo

a PickingInfo

Inherited from

Scene.pick

---

pickSprite()

pickSprite(x, y, predicate?, fastCheck?, camera?): PickingInfo

Defined in: node_modules/@babylonjs/core/Sprites/spriteSceneComponent.d.ts:43

Launch a ray to try to pick a sprite in the scene

Parameters

x

number

position on screen

y

number

position on screen

predicate?

(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

fastCheck?

boolean

defines if the first intersection will be used (and not the closest)

camera?

Camera

camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used

Returns

PickingInfo

a PickingInfo

Inherited from

Scene.pickSprite

---

pickSpriteWithRay()

pickSpriteWithRay(ray, predicate?, fastCheck?, camera?): PickingInfo

Defined in: node_modules/@babylonjs/core/Sprites/spriteSceneComponent.d.ts:51

Use the given ray to pick a sprite in the scene

Parameters

ray

Ray

The ray (in world space) to use to pick meshes

predicate?

(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

fastCheck?

boolean

defines if the first intersection will be used (and not the closest)

camera?

Camera

camera to use. Can be set to null. In this case, the scene.activeCamera will be used

Returns

PickingInfo

a PickingInfo

Inherited from

Scene.pickSpriteWithRay

---

pickWithBoundingInfo()

pickWithBoundingInfo(x, y, predicate?, fastCheck?, camera?): PickingInfo

Defined in: node_modules/@babylonjs/core/scene.d.ts:2217

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

predicate?

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

fastCheck?

boolean

defines if the first intersection will be used (and not the closest)

camera?

Camera

to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used

Returns

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)

Inherited from

Scene.pickWithBoundingInfo

---

pickWithRay()

pickWithRay(ray, predicate?, fastCheck?, trianglePredicate?): PickingInfo

Defined in: node_modules/@babylonjs/core/scene.d.ts:2227

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

predicate?

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

fastCheck?

boolean

defines if the first intersection will be used (and not the closest)

trianglePredicate?

TrianglePickingPredicate

defines an optional predicate used to select faces when a mesh intersection is detected

Returns

PickingInfo

a PickingInfo

Inherited from

Scene.pickWithRay

---

pushGeometry()

pushGeometry(geometry, force?): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:1830

Add a new geometry to this scene

Parameters

geometry

Geometry

defines the geometry to be added to the scene.

force?

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

Inherited from

Scene.pushGeometry

---

registerAfterRender()

registerAfterRender(func): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1426

Registers a function to be called after every frame render

Parameters

func

() => void

defines the function to register

Returns

void

Inherited from

Scene.registerAfterRender

---

registerBeforeRender()

registerBeforeRender(func): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1416

Registers a function to be called before every frame render

Parameters

func

() => void

defines the function to register

Returns

void

Inherited from

Scene.registerBeforeRender

---

removeActionManager()

removeActionManager(toRemove): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1620

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

Inherited from

Scene.removeActionManager

---

removeAnimation()

removeAnimation(toRemove): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1588

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

Inherited from

Scene.removeAnimation

---

removeAnimationGroup()

removeAnimationGroup(toRemove): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1601

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

Inherited from

Scene.removeAnimationGroup

---

removeCamera()

removeCamera(toRemove): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1576

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

Inherited from

Scene.removeCamera

---

removeEffectLayer()

removeEffectLayer(toRemove): number

Defined in: node_modules/@babylonjs/core/Layers/effectLayerSceneComponent.d.ts:12

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

Inherited from

Scene.removeEffectLayer

---

removeExternalData()

removeExternalData(key): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:2005

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

Inherited from

Scene.removeExternalData

---

removeGeometry()

removeGeometry(geometry): boolean

Defined in: node_modules/@babylonjs/core/scene.d.ts:1836

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

Inherited from

Scene.removeGeometry

---

removeLensFlareSystem()

removeLensFlareSystem(toRemove): number

Defined in: node_modules/@babylonjs/core/LensFlares/lensFlareSystemSceneComponent.d.ts:13

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

Inherited from

Scene.removeLensFlareSystem

---

removeLight()

removeLight(toRemove): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1570

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

Inherited from

Scene.removeLight

---

removeMaterial()

removeMaterial(toRemove): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1613

Removes the given material from this scene.

Parameters

toRemove

Material

The material to remove

Returns

number

The index of the removed material

Inherited from

Scene.removeMaterial

---

removeMesh()

removeMesh(toRemove, recursive?): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1541

Remove a mesh for the list of scene's meshes

Parameters

toRemove

AbstractMesh

defines the mesh to remove

recursive?

boolean

if all child meshes should also be removed from the scene

Returns

number

the index where the mesh was in the mesh list

Inherited from

Scene.removeMesh

---

removeMorphTargetManager()

removeMorphTargetManager(toRemove): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1564

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

Inherited from

Scene.removeMorphTargetManager

---

removeMultiMaterial()

removeMultiMaterial(toRemove): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1607

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

Inherited from

Scene.removeMultiMaterial

---

removeParticleSystem()

removeParticleSystem(toRemove): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1582

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

Inherited from

Scene.removeParticleSystem

---

removePendingData()

removePendingData(data): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1450

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

Inherited from

Scene.removePendingData

---

removeReflectionProbe()

removeReflectionProbe(toRemove): number

Defined in: node_modules/@babylonjs/core/Probes/reflectionProbe.d.ts:19

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

Inherited from

Scene.removeReflectionProbe

---

removeSkeleton()

removeSkeleton(toRemove): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1558

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

Inherited from

Scene.removeSkeleton

---

removeTexture()

removeTexture(toRemove): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1626

Removes the given texture from this scene.

Parameters

toRemove

BaseTexture

The texture to remove

Returns

number

The index of the removed texture

Inherited from

Scene.removeTexture

---

removeTransformNode()

removeTransformNode(toRemove): number

Defined in: node_modules/@babylonjs/core/scene.d.ts:1552

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

Inherited from

Scene.removeTransformNode

---

render()

render(updateCameras?, ignoreAnimations?): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2117

Render the scene

Parameters

updateCameras?

boolean

defines a boolean indicating if cameras must update according to their inputs (true by default)

ignoreAnimations?

boolean

defines a boolean indicating if animations should not be executed (false by default)

Returns

void

Inherited from

Scene.render

---

resetCachedMaterial()

resetCachedMaterial(): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1411

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

Returns

void

Inherited from

Scene.resetCachedMaterial

---

resetDrawCache()

resetDrawCache(passId?): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2106

Resets the draw wrappers cache of all meshes

Parameters

passId?

number

If provided, releases only the draw wrapper corresponding to this render pass id

Returns

void

Inherited from

Scene.resetDrawCache

---

resetLastAnimationTimeFrame()

resetLastAnimationTimeFrame(): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1484

Resets the last animation time frame. Useful to override when animations start running when loading a scene for the first time.

Returns

void

Inherited from

Scene.resetLastAnimationTimeFrame

---

setActiveCameraById()

setActiveCameraById(id): Camera

Defined in: node_modules/@babylonjs/core/scene.d.ts:1703

sets the active camera of the scene using its Id

Parameters

id

string

defines the camera's Id

Returns

Camera

the new active camera or null if none found.

Inherited from

Scene.setActiveCameraById

---

setActiveCameraByID()

setActiveCameraByID(id): Camera

Defined in: node_modules/@babylonjs/core/scene.d.ts:2382

Sets the active camera of the scene using its Id

Parameters

id

string

defines the camera's Id

Returns

Camera

the new active camera or null if none found.

Deprecated

Please use setActiveCameraById instead

Inherited from

Scene.setActiveCameraByID

---

setActiveCameraByName()

setActiveCameraByName(name): Camera

Defined in: node_modules/@babylonjs/core/scene.d.ts:1709

sets the active camera of the scene using its name

Parameters

name

string

defines the camera's name

Returns

Camera

the new active camera or null if none found.

Inherited from

Scene.setActiveCameraByName

---

setDefaultCandidateProviders()

setDefaultCandidateProviders(): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1257

Sets the default candidate providers for the scene. This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates and getCollidingSubMeshCandidates to their default function

Returns

void

Inherited from

Scene.setDefaultCandidateProviders

---

setPointerOverMesh()

setPointerOverMesh(mesh, pointerId?, pickResult?): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2253

Force the value of meshUnderPointer

Parameters

mesh

AbstractMesh

defines the mesh to use

pointerId?

number

optional pointer id when using more than one pointer

pickResult?

PickingInfo

optional pickingInfo data used to find mesh

Returns

void

Inherited from

Scene.setPointerOverMesh

---

setPointerOverSprite()

setPointerOverSprite(sprite): void

Defined in: node_modules/@babylonjs/core/Sprites/spriteSceneComponent.d.ts:73

Force the sprite under the pointer

Parameters

sprite

Sprite

defines the sprite to use

Returns

void

Inherited from

Scene.setPointerOverSprite

---

setRenderingAutoClearDepthStencil()

setRenderingAutoClearDepthStencil(renderingGroupId, autoClearDepthStencil, depth?, stencil?): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2324

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.

depth?

boolean

Automatically clears depth between groups if true and autoClear is true.

stencil?

boolean

Automatically clears stencil between groups if true and autoClear is true.

Returns

void

Inherited from

Scene.setRenderingAutoClearDepthStencil

---

setRenderingOrder()

setRenderingOrder(renderingGroupId, opaqueSortCompareFn?, alphaTestSortCompareFn?, transparentSortCompareFn?): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2315

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

opaqueSortCompareFn?

(a, b) => number

The opaque queue comparison function use to sort.

alphaTestSortCompareFn?

(a, b) => number

The alpha test queue comparison function use to sort.

transparentSortCompareFn?

(a, b) => number

The transparent queue comparison function use to sort.

Returns

void

Inherited from

Scene.setRenderingOrder

---

setSceneUniformBuffer()

setSceneUniformBuffer(ubo): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1523

Sets the scene ubo

Parameters

ubo

UniformBuffer

the ubo to set for the scene

Returns

void

Inherited from

Scene.setSceneUniformBuffer

---

setStepId()

setStepId(newStepId): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:797

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

Inherited from

Scene.setStepId

---

setTransformMatrix()

setTransformMatrix(viewL, projectionL, viewR?, projectionR?): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1507

Sets the current transform matrix

Parameters

viewL

Matrix

defines the View matrix to use

projectionL

Matrix

defines the Projection matrix to use

viewR?

Matrix

defines the right View matrix to use (if provided)

projectionR?

Matrix

defines the right Projection matrix to use (if provided)

Returns

void

Inherited from

Scene.setTransformMatrix

---

simulatePointerDown()

simulatePointerDown(pickResult, pointerEventInit?): Scene

Defined in: node_modules/@babylonjs/core/scene.d.ts:1378

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

pointerEventInit?

PointerEventInit

pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)

Returns

Scene

the current scene

Inherited from

Scene.simulatePointerDown

---

simulatePointerMove()

simulatePointerMove(pickResult, pointerEventInit?): Scene

Defined in: node_modules/@babylonjs/core/scene.d.ts:1370

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

pointerEventInit?

PointerEventInit

pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)

Returns

Scene

the current scene

Inherited from

Scene.simulatePointerMove

---

simulatePointerUp()

simulatePointerUp(pickResult, pointerEventInit?, doubleTap?): Scene

Defined in: node_modules/@babylonjs/core/scene.d.ts:1387

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

pointerEventInit?

PointerEventInit

pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)

doubleTap?

boolean

indicates that the pointer up event should be considered as part of a double click (false by default)

Returns

Scene

the current scene

Inherited from

Scene.simulatePointerUp

---

sortActiveAnimatables()

sortActiveAnimatables(): void

Defined in: node_modules/@babylonjs/core/Animations/animatable.d.ts:12

Sort active animatables based on their playOrder property

Returns

void

Inherited from

Scene.sortActiveAnimatables

---

sortLightsByPriority()

sortLightsByPriority(): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1635

Sorts the list list based on light priorities

Returns

void

Inherited from

Scene.sortLightsByPriority

---

stopAllAnimations()

stopAllAnimations(): void

Defined in: node_modules/@babylonjs/core/Animations/animatable.d.ts:110

Stops and removes all animations that have been applied to the scene

Returns

void

Inherited from

Scene.stopAllAnimations

---

stopAnimation()

stopAnimation(target, animationName?, targetMask?): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1595

Will stop the animation of the given target

Parameters

target

any

the target

animationName?

string

the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)

targetMask?

(target) => 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

Inherited from

Scene.stopAnimation

---

switchActiveCamera()

switchActiveCamera(newCamera, attachControl?): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1697

Switch active camera

Parameters

newCamera

Camera

defines the new active camera

attachControl?

boolean

defines if attachControl must be called for the new active camera (default: true)

Returns

void

Inherited from

Scene.switchActiveCamera

---

unfreezeActiveMeshes()

unfreezeActiveMeshes(): Scene

Defined in: node_modules/@babylonjs/core/scene.d.ts:2064

Use this function to restart evaluating active meshes on every frame

Returns

Scene

the current scene

Inherited from

Scene.unfreezeActiveMeshes

---

unfreezeMaterials()

unfreezeMaterials(): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2128

Unfreeze all materials A frozen material will not be updatable but should be faster to render

Returns

void

Inherited from

Scene.unfreezeMaterials

---

unregisterAfterRender()

unregisterAfterRender(func): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1431

Unregisters a function called after every frame render

Parameters

func

() => void

defines the function to unregister

Returns

void

Inherited from

Scene.unregisterAfterRender

---

unregisterBeforeRender()

unregisterBeforeRender(func): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:1421

Unregisters a function called before every frame render

Parameters

func

() => void

defines the function to unregister

Returns

void

Inherited from

Scene.unregisterBeforeRender

---

updateTransformMatrix()

updateTransformMatrix(force?): void

Defined in: node_modules/@babylonjs/core/scene.d.ts:2074

Update the transform matrix to update from the current active camera

Parameters

force?

boolean

defines a boolean used to force the update even if cache is up to date

Returns

void

Inherited from

Scene.updateTransformMatrix

---

whenReadyAsync()

whenReadyAsync(checkRenderTargets?): Promise<void>

Defined in: node_modules/@babylonjs/core/scene.d.ts:1471

Returns a promise that resolves when the scene is ready

Parameters

checkRenderTargets?

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

Inherited from

Scene.whenReadyAsync

---

CollisionCoordinatorFactory()

static CollisionCoordinatorFactory(): ICollisionCoordinator

Defined in: node_modules/@babylonjs/core/scene.d.ts:137

Factory used to create the a collision coordinator.

Returns

ICollisionCoordinator

The collision coordinator

Inherited from

Scene.CollisionCoordinatorFactory

---

DefaultMaterialFactory()

static DefaultMaterialFactory(scene): Material

Defined in: node_modules/@babylonjs/core/scene.d.ts:131

Factory used to create the default material.

Parameters

scene

Scene

The scene to create the material for

Returns

Material

The default material

Inherited from

Scene.DefaultMaterialFactory