Class Scene
Hierarchy
-
AbstractScene
- Scene
Implements
Index
Constructors
Properties
- _active
Meshes Frozen But Keep Clipping - action
Manager - action
Managers - active
Cameras - ambient
Color - animation
Groups - animation
Time Scale - animations
- animations
Enabled - audio
Enabled - audio
Listener Position Provider - audio
Positioning Refresh Rate - auto
Clear - auto
Clear Depth And Stencil - camera
ToUse For Pointers - cameras
- clear
Color - clip
Plane - clip
Plane2 - clip
Plane3 - clip
Plane4 - clip
Plane5 - clip
Plane6 - collisions
Enabled - constantly
Update Mesh Under Pointer - customLODSelector
- custom
Render Targets - debug
Layer - default
Cursor - delta
Time - depth
Peeling Renderer - disable
Offline Support Exception Rules - dispatch
All Sub Meshes OfActive Meshes - do
Not Handle Cursors - dump
Next Render Targets - effect
Layers - environmentBRDFTexture
- environment
Intensity - fog
Color - fog
Density - fog
End - fog
Start - force
Show Bounding Boxes - gamepad
Manager - geometries
- geometry
Buffer Renderer - get
Active Mesh Candidates - get
Active Sub Mesh Candidates - get
Colliding Sub Mesh Candidates - get
Deterministic Frame Time - get
Intersecting Sub Mesh Candidates - gravity
- headphone
- hover
Cursor - imported
Meshes Files - layers
- lens
Flare Systems - lens
Flares Enabled - lights
- loading
Plugin Name - main
Sound Track - materials
- meshes
- metadata
- morph
Target Managers - multi
Materials - needs
Previous World Matrices - offline
Provider - on
Active Camera Changed - on
After Active Meshes Evaluation Observable - on
After Animations Observable - on
After Camera Render Observable - on
After Draw Phase Observable - on
After Particles Rendering Observable - on
After Physics Observable - on
After Render Camera Observable - on
After Render Observable - on
After Render Targets Render Observable - on
After Rendering Group Observable - on
After Sprites Rendering Observable - on
After Step Observable - on
Animation File Imported Observable - on
Before Active Meshes Evaluation Observable - on
Before Animations Observable - on
Before Camera Render Observable - on
Before Draw Phase Observable - on
Before Particles Rendering Observable - on
Before Physics Observable - on
Before Render Observable - on
Before Render Targets Render Observable - on
Before Rendering Group Observable - on
Before Sprites Rendering Observable - on
Before Step Observable - on
Camera Removed Observable - on
Compute Pressure Changed - on
Data Loaded Observable - on
Dispose Observable - on
Geometry Removed Observable - on
Keyboard Observable - on
Light Removed Observable - on
Material Removed Observable - on
Mesh Imported Observable - on
Mesh Removed Observable - on
Multi Material Removed Observable - on
New Camera Added Observable - on
New Geometry Added Observable - on
New Light Added Observable - on
New Material Added Observable - on
New Mesh Added Observable - on
New Multi Material Added Observable - on
New Skeleton Added Observable - on
New Texture Added Observable - on
New Transform Node Added Observable - on
Pointer Down - on
Pointer Move - on
Pointer Observable - on
Pointer Pick - on
Pointer Up - on
Pre Keyboard Observable - on
Pre Pointer Observable - on
Ready Observable - on
Skeleton Removed Observable - on
Texture Removed Observable - on
Transform Node Removed Observable - particle
Systems - particles
Enabled - physics
Enabled - pointer
Down Predicate - pointer
Move Predicate - pointer
Move Triangle Predicate - pointer
UpPredicate - post
Process Manager - post
Process Render Pipeline Manager - post
Processes - post
Processes Enabled - pre
Pass Renderer - prevent
Default OnPointer Down - prevent
Default OnPointer Up - probes
Enabled - procedural
Textures - procedural
Textures Enabled - reflection
Probes - render
Targets Enabled - require
Light Sorting - reserved
Data Store - root
Nodes - selection
Octree - simplification
Queue - skeletons
- skip
Pointer Down Picking - skip
Pointer Move Picking - skip
Pointer UpPicking - sound
Tracks - sounds
- sprite
Managers - sprites
Enabled - sub
Surface Configuration - textures
- transform
Nodes - use
Constant Animation Delta Time - use
Delayed Texture Loading - use
Order Independent Transparency - FOGMODE_
EXP - FOGMODE_
EXP2 - FOGMODE_
LINEAR - FOGMODE_
NONE - Max
Delta Time - Min
Delta Time
Accessors
- active
Bones Perf Counter - active
Camera - active
Particles Perf Counter - after
Camera Render - after
Render - animatables
- animation
Properties Override - before
Camera Render - before
Render - block
Material Dirty Mechanism - blockfree
Active Meshes And Rendering Groups - default
Material - environment
Texture - fog
Enabled - fog
Mode - force
Points Cloud - force
Wireframe - frustum
Planes - image
Processing Configuration - is
Disposed - is
Loading - lights
Enabled - mesh
Under Pointer - on
Dispose - pointerX
- pointerY
- pre
Pass - shadows
Enabled - skeletons
Enabled - skip
Frustum Clipping - textures
Enabled - total
Active Indices Perf Counter - total
Vertices Perf Counter - uid
- un
Translated Pointer - use
Right Handed System - Double
Click Delay - Drag
Movement Threshold - Exclusive
Double Click Mode - Long
Press Delay
Methods
- add
Action Manager - add
Animation - add
Animation Group - add
Camera - add
Effect Layer - add
External Data - add
Geometry - add
Lens Flare System - add
Light - add
Material - add
Mesh - add
Morph Target Manager - add
Multi Material - add
Particle System - add
Reflection Probe - add
Skeleton - add
Texture - add
Transform Node - animate
- attach
Control - begin
Animation - begin
Direct Animation - begin
Direct Hierarchy Animation - begin
Hierarchy Animation - begin
Weighted Animation - bind
Eye Position - clean
Cached Texture Buffer - clear
Cached Vertex Data - create
Default Camera - create
Default Camera OrLight - create
Default Environment - create
Default Light - create
Default Skybox - create
DefaultVRExperience - create
DefaultXRExperience Async - create
OrUpdate Selection Octree - create
Picking Ray - create
Picking Ray InCamera Space - create
Picking Ray InCamera Space ToRef - create
Picking Ray ToRef - create
Scene Uniform Buffer - delete
Compound Impostor - detach
Control - disable
Depth Renderer - disable
Geometry Buffer Renderer - disable
Physics Engine - disable
Pre Pass Renderer - disable
Sub Surface For Pre Pass - dispose
- enable
Depth Renderer - enable
Geometry Buffer Renderer - enable
Physics - enable
Pre Pass Renderer - enable
Sub Surface For Pre Pass - execute
Once Before Render - execute
When Ready - finalize
Scene Ubo - free
Active Meshes - free
Processed Materials - free
Rendering Groups - freeze
Active Meshes - freeze
Materials - get
Active Bones - get
Active Indices - get
Active Meshes - get
Active Particles - get
All Animatables ByTarget - get
Animatable ByTarget - get
Animation Group ByName - get
Animation Ratio - get
Auto Clear Depth Stencil Setup - get
Bone ByID - get
Bone ById - get
Bone ByName - get
Bounding Box Renderer - get
Cached Effect - get
Cached Material - get
Cached Visibility - get
Camera ByID - get
Camera ById - get
Camera ByName - get
Camera ByUniqueID - get
Camera ByUnique Id - get
Cameras ByTags - get
Class Name - get
Engine - get
External Data - get
Frame Id - get
Geometries - get
Geometry ByID - get
Geometry ById - get
Glow Layer ByName - get
Highlight Layer ByName - get
Internal Step - get
Last Entry ByID - get
Last Entry ById - get
Last Material ByID - get
Last Material ById - get
Last Mesh ByID - get
Last Mesh ById - get
Last Skeleton ByID - get
Last Skeleton ById - get
Lens Flare System ByID - get
Lens Flare System ById - get
Lens Flare System ByName - get
Light ByID - get
Light ById - get
Light ByName - get
Light ByUniqueID - get
Light ByUnique Id - get
Lights ByTags - get
Material ByID - get
Material ById - get
Material ByName - get
Material ByTags - get
Material ByUniqueID - get
Mesh ByID - get
Mesh ById - get
Mesh ByName - get
Mesh ByUniqueID - get
Mesh ByUnique Id - get
Meshes ByID - get
Meshes ById - get
Meshes ByTags - get
Morph Target ById - get
Morph Target ByName - get
Morph Target Manager ById - get
Node ByID - get
Node ById - get
Node ByName - get
Nodes - get
OrAdd External Data With Factory - get
Outline Renderer - get
Particle System ByID - get
Particle System ById - get
Perf Collector - get
Physics Engine - get
Pointer Over Mesh - get
Pointer Over Sprite - get
Post Process ByName - get
Projection Matrix - get
Render Id - get
Scene Uniform Buffer - get
Skeleton ById - get
Skeleton ByName - get
Skeleton ByUnique Id - get
Sound ByName - get
Step Id - get
Texture ByName - get
Texture ByUniqueID - get
Texture ByUnique Id - get
Total Vertices - get
Transform Matrix - get
Transform Node ByID - get
Transform Node ById - get
Transform Node ByName - get
Transform Node ByUniqueID - get
Transform Node ByUnique Id - get
Transform Nodes ByID - get
Transform Nodes ById - get
Transform Nodes ByTags - get
Unique Id - get
View Matrix - get
Waiting Items Count - get
World Extends - increment
Render Id - is
Active Mesh - is
Cached Material Invalid - is
Physics Enabled - is
Pointer Captured - is
Ready - mark
All Materials AsDirty - multi
Pick - multi
Pick Sprite - multi
Pick Sprite With Ray - multi
Pick With Ray - pick
- pick
Sprite - pick
Sprite With Ray - pick
With Bounding Info - pick
With Ray - push
Geometry - register
After Render - register
Before Render - remove
Action Manager - remove
Animation - remove
Animation Group - remove
Camera - remove
Effect Layer - remove
External Data - remove
Geometry - remove
Lens Flare System - remove
Light - remove
Material - remove
Mesh - remove
Morph Target Manager - remove
Multi Material - remove
Particle System - remove
Reflection Probe - remove
Skeleton - remove
Texture - remove
Transform Node - render
- reset
Cached Material - reset
Draw Cache - reset
Last Animation Time Frame - set
Active Camera ByID - set
Active Camera ById - set
Active Camera ByName - set
Default Candidate Providers - set
Pointer Over Mesh - set
Pointer Over Sprite - set
Rendering Auto Clear Depth Stencil - set
Rendering Order - set
Scene Uniform Buffer - set
Step Id - set
Transform Matrix - simulate
Pointer Down - simulate
Pointer Move - simulate
Pointer Up - sort
Lights ByPriority - stop
All Animations - stop
Animation - switch
Active Camera - unfreeze
Active Meshes - unfreeze
Materials - unregister
After Render - unregister
Before Render - update
Transform Matrix - when
Ready Async - Add
Individual Parser - Add
Parser - Collision
Coordinator Factory - Default
Material Factory - Get
Individual Parser - Get
Parser - Parse
Constructors
constructor
-
Creates a new Scene
Parameters
-
engine: Engine
defines the engine to use to render this scene
-
Optional options: SceneOptions
defines the scene options
Returns Scene
-
Properties
_active
action
Gets or sets the action manager associated with the scene
action
ActionManagers available on the scene.
active
All of the active cameras added to this scene.
ambient
Defines the color used to simulate the ambient color (Default is (0, 0, 0))
animation
All of the animation groups added to this scene
animation
Gets or sets a general scale for animation speed
animationsSearch playground for animations
Gets a list of Animations associated with the scene
animations
Gets or sets a boolean indicating if animations are enabled
audio
Gets or sets if audio support is enabled
audio
Gets or sets custom audio listener position provider
audio
Gets or sets a refresh rate when using 3D audio positioning
auto
Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
auto
Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
camera
Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position
camerasSearch playground for cameras
All of the cameras added to this scene
clear
Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
clip
Gets or sets the active clipplane 1
clip
Gets or sets the active clipplane 2
clip
Gets or sets the active clipplane 3
clip
Gets or sets the active clipplane 4
clip
Gets or sets the active clipplane 5
clip
Gets or sets the active clipplane 6
collisions
Gets or sets a boolean indicating if collisions are enabled on this scene
constantly
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
customLODSelectorSearch playground for customLODSelector
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
Type declaration
-
-
Parameters
-
mesh: AbstractMesh
-
camera: Camera
Returns Nullable<AbstractMesh>
-
-
custom
The list of user defined render targets added to the scene
debug
Gets the debug layer (aka Inspector) associated with the scene
default
Defines the HTML default cursor to use (empty by default)
delta
Gets the current delta time used by animation engine
depth
The depth peeling renderer
disable
Use this array to add regular expressions used to disable offline support for specific urls
dispatch
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)
do
Defines whether cursors are handled by the scene.
dump
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
effect
The list of effect layers (highlights/glow) added to the scene
environmentBRDFTextureSearch playground for environmentBRDFTexture
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.
environment
Intensity of the environment in all pbr material. This dims or reinforces the IBL 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.
fog
Gets or sets the fog color to use
fog
Gets or sets the fog density to use
fog
Gets or sets the fog end distance to use
fog
Gets or sets the fog start distance to use
force
Gets or sets a boolean indicating if all bounding boxes must be rendered
gamepad
Gets the gamepad manager associated with the scene
geometriesSearch playground for geometries
The list of geometries used in the scene.
geometry
Gets or Sets the current geometry buffer associated to the scene.
get
Lambda returning the list of potentially active meshes.
Type declaration
-
-
Returns ISmartArrayLike<AbstractMesh>
-
get
Lambda returning the list of potentially active sub meshes.
Type declaration
-
-
Parameters
-
mesh: AbstractMesh
Returns ISmartArrayLike<SubMesh>
-
-
get
Lambda returning the list of potentially colliding sub meshes.
Type declaration
-
-
Parameters
-
mesh: AbstractMesh
-
collider: Collider
Returns ISmartArrayLike<SubMesh>
-
-
get
User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
Type declaration
-
-
Returns number
-
get
Lambda returning the list of potentially intersecting sub meshes.
Type declaration
-
-
Parameters
-
mesh: AbstractMesh
-
localRay: Ray
Returns ISmartArrayLike<SubMesh>
-
-
gravitySearch playground for gravity
Defines the gravity applied to this scene (used only for collisions)
headphoneSearch playground for headphone
Gets or sets if audio will be output to headphones
hover
Defines the HTML cursor to use when hovering over interactive elements
imported
Gets the list of meshes imported to the scene through SceneLoader
layersSearch playground for layers
The list of layers (background and foreground) of the scene
lens
The list of lens flare system added to the scene
lens
Gets or sets a boolean indicating if lens flares are enabled on this scene
lightsSearch playground for lights
All of the lights added to this scene
loading
Gets the name of the plugin used to load this scene (null by default)
main
The main sound track played by the scene. It contains your primary collection of sounds.
materialsSearch playground for materials
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.
meshesSearch playground for meshes
All of the (abstract) meshes added to this scene
metadataSearch playground for metadata
Gets or sets user defined metadata
morph
The list of morph target managers added to the scene
multi
All of the multi-materials added to this scene
needs
Flag indicating if we need to store previous matrices when rendering
offline
Gets or sets the current offline provider to use to store scene data
on
An event triggered when the activeCamera property is updated
on
An event triggered when active meshes evaluation is done
on
An event triggered after animations processing
on
An event triggered after rendering a camera
on
An event triggered after draw calls have been sent
on
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)
on
An event triggered when physic simulation has been done
on
An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
on
An event triggered after rendering the scene
on
An event triggered when render targets were rendered. Can happen multiple times per frame.
on
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)
on
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)
on
An event triggered after calculating deterministic simulation step
on
This Observable will when an animation file has been imported into the scene.
on
An event triggered when active meshes evaluation is about to start
on
An event triggered before animating the scene
on
An event triggered before rendering a camera
on
An event triggered before draw calls are ready to be sent
on
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)
on
An event triggered when physic simulation is about to be run
on
An event triggered before rendering the scene (right after animations and physics)
on
An event triggered when render targets are about to be rendered Can happen multiple times per frame.
on
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)
on
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)
on
An event triggered before calculating deterministic simulation step
on
An event triggered when a camera is removed
on
An event triggered when the cpu usage/speed meets certain thresholds. Note: Compute pressure is an experimental API.
on
An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
on
An event triggered when the scene is disposed.
on
An event triggered when a geometry is removed
on
Observable event triggered each time an keyboard event is received from the hosting window
on
An event triggered when a light is removed
on
An event triggered when a material is removed
on
This Observable will when a mesh has been imported into the scene.
on
An event triggered when a mesh is removed
on
An event triggered when a multi material is removed
on
An event triggered when a camera is created
on
An event triggered when a geometry is created
on
An event triggered when a light is created
on
An event triggered when a material is created
on
An event triggered when a mesh is created
on
An event triggered when a multi material is created
on
An event triggered when a skeleton is created
on
An event triggered when a texture is created
on
An event triggered when a transform node is created
on
Callback called when a pointer down is detected
Type declaration
-
-
Parameters
-
evt: IPointerEvent
-
pickInfo: PickingInfo
-
type: PointerEventTypes
Returns void
-
-
on
Callback called when a pointer move is detected
Type declaration
-
-
Parameters
-
evt: IPointerEvent
-
pickInfo: PickingInfo
-
type: PointerEventTypes
Returns void
-
-
on
Observable event triggered each time an input event is received from the rendering canvas
on
Callback called when a pointer pick is detected
Type declaration
-
-
Parameters
-
evt: IPointerEvent
-
pickInfo: PickingInfo
Returns void
-
-
on
Callback called when a pointer up is detected
Type declaration
-
-
Parameters
-
evt: IPointerEvent
-
pickInfo: Nullable<PickingInfo>
-
type: PointerEventTypes
Returns void
-
-
on
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
on
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
on
An event triggered when the scene is ready
on
An event triggered when a skeleton is removed
on
An event triggered when a texture is removed
on
An event triggered when a transform node is removed
particle
All of the particle systems added to this scene
particles
Gets or sets a boolean indicating if particles are enabled on this scene
physics
Gets or sets a boolean indicating if physic engines are enabled on this scene
pointer
Gets or sets a predicate used to select candidate meshes for a pointer down event
Type declaration
-
-
Parameters
-
Mesh: AbstractMesh
Returns boolean
-
-
pointer
Gets or sets a predicate used to select candidate meshes for a pointer move event
Type declaration
-
-
Parameters
-
Mesh: AbstractMesh
Returns boolean
-
-
pointer
Gets or sets a predicate used to select candidate faces for a pointer move event
pointer
Gets or sets a predicate used to select candidate meshes for a pointer up event
Type declaration
-
-
Parameters
-
Mesh: AbstractMesh
Returns boolean
-
-
post
Gets the current postprocess manager
Readonly post
Gets the postprocess render pipeline manager
post
The list of postprocesses added to the scene
post
Gets or sets a boolean indicating if postprocesses are enabled on this scene
pre
Gets or Sets the current prepass renderer associated to the scene.
prevent
This is used to call preventDefault() on pointer down in order to block unwanted artifacts like system double clicks
prevent
This is used to call preventDefault() on pointer up in order to block unwanted artifacts like system double clicks
probes
Gets or sets a boolean indicating if probes are enabled on this scene
procedural
The list of procedural textures added to the scene
procedural
Gets or sets a boolean indicating if procedural textures are enabled on this scene
reflection
The list of reflection probes added to the scene
render
Gets or sets a boolean indicating if render targets are enabled on this scene
require
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
reserved
For internal use only. Please do not use.
root
Gets the list of root nodes (ie. nodes with no parent)
selection
Gets the octree used to boost mesh selection (picking)
simplification
Gets or sets the simplification queue attached to the scene
skeletonsSearch playground for skeletons
The list of skeletons added to the scene
skip
Gets or sets a boolean indicating if the user want to entirely skip the picking phase when a pointer down event occurs.
skip
Gets or sets a boolean indicating if the user want to entirely skip the picking phase when a pointer move event occurs.
skip
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.
sound
The list of sound tracks added to the scene
soundsSearch playground for sounds
The list of sounds used in the scene.
sprite
All of the sprite managers added to this scene
sprites
Gets or sets a boolean indicating if sprites are enabled on this scene
sub
Gets or Sets the current prepass renderer associated to the scene.
texturesSearch playground for textures
Textures to keep.
transform
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.
use
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
use
Defines if texture loading must be delayed If true, textures will only be loaded when they need to be rendered
use
Flag to indicate if we want to use order independent transparency, despite the performance hit
Static Readonly FOGMODE_
The fog density is following an exponential function
Static Readonly FOGMODE_
The fog density is following an exponential function faster than FOGMODE_EXP
Static Readonly FOGMODE_
The fog density is following a linear function.
Static Readonly FOGMODE_
The fog is deactivated
Static Max
Gets or sets the maximum deltatime when deterministic lock step is enabled
Static Min
Gets or sets the minimum deltatime when deterministic lock step is enabled
Accessors
active
-
Gets the performance counter for active bones
Returns PerfCounter
active
active
-
Gets the performance counter for active particles
Returns PerfCounter
after
-
Sets a function to be executed after rendering a camera
Parameters
-
callback: () => void
-
-
Returns void
-
-
Returns any
-
after
-
Sets a function to be executed after rendering this scene
Parameters
-
callback: Nullable<() => void>
Returns any
-
animatables
-
Gets all animatable attached to the scene
Returns Animatable[]
animation
-
Gets or sets the animation properties override
Returns Nullable<AnimationPropertiesOverride>
-
Gets or sets the animation properties override
Parameters
-
value: Nullable<AnimationPropertiesOverride>
Returns any
-
before
-
Sets a function to be executed before rendering a camera
Parameters
-
callback: () => void
-
-
Returns void
-
-
Returns any
-
before
-
Sets a function to be executed before rendering this scene
Parameters
-
callback: Nullable<() => void>
Returns any
-
block
-
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
-
Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync)
Parameters
-
value: boolean
Returns any
-
blockfree
-
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
-
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.
Parameters
-
value: boolean
Returns any
-
default
environment
-
Texture used in all pbr material as the reflection texture. As in the majority of the scene they are the same (exception for multi room and so on), this is easier to reference from here than from all the materials.
Returns Nullable<BaseTexture>
-
Texture used in all pbr material as the reflection texture. As in the majority of the scene they are the same (exception for multi room and so on), this is easier to set here than in all the materials.
Parameters
-
value: Nullable<BaseTexture>
Returns any
-
fog
-
Gets or sets a boolean indicating if fog is enabled on this scene
Returns boolean
-
Gets or sets a boolean indicating if fog is enabled on this scene
Parameters
-
value: boolean
Returns any
-
fog
-
Gets or sets the fog mode to use
Returns number
-
Gets or sets the fog mode to use
Parameters
-
value: number
Returns any
-
force
-
Gets or sets a boolean indicating if all rendering must be done in point cloud
Returns boolean
-
Gets or sets a boolean indicating if all rendering must be done in point cloud
Parameters
-
value: boolean
Returns any
-
force
-
Gets or sets a boolean indicating if all rendering must be done in wireframe
Returns boolean
-
Gets or sets a boolean indicating if all rendering must be done in wireframe
Parameters
-
value: boolean
Returns any
-
frustum
-
Gets the list of frustum planes (built from the active camera)
Returns Plane[]
image
-
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
is
-
Gets if the scene is already disposed
Returns boolean
is
-
Returns a boolean indicating if the scene is still loading data
Returns boolean
lights
-
Gets or sets a boolean indicating if lights are enabled on this scene
Returns boolean
-
Gets or sets a boolean indicating if lights are enabled on this scene
Parameters
-
value: boolean
Returns any
-
mesh
-
Gets the mesh that is currently under the pointer
Returns Nullable<AbstractMesh>
on
-
Sets a function to be executed when this scene is disposed.
Parameters
-
callback: () => void
-
-
Returns void
-
-
Returns any
-
pointerX
-
Gets or sets the current on-screen X position of the pointer
Returns number
-
Gets or sets the current on-screen X position of the pointer
Parameters
-
value: number
Returns any
-
pointerY
-
Gets or sets the current on-screen Y position of the pointer
Returns number
-
Gets or sets the current on-screen Y position of the pointer
Parameters
-
value: number
Returns any
-
pre
-
Flag indicating that the frame buffer binding is handled by another component
Returns boolean
shadows
-
Gets or sets a boolean indicating if shadows are enabled on this scene
Returns boolean
-
Gets or sets a boolean indicating if shadows are enabled on this scene
Parameters
-
value: boolean
Returns any
-
skeletons
-
Gets or sets a boolean indicating if skeletons are enabled on this scene
Returns boolean
-
Gets or sets a boolean indicating if skeletons are enabled on this scene
Parameters
-
value: boolean
Returns any
-
skip
-
Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
Returns boolean
-
Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
Parameters
-
value: boolean
Returns any
-
textures
-
Gets or sets a boolean indicating if textures are enabled on this scene
Returns boolean
-
Gets or sets a boolean indicating if textures are enabled on this scene
Parameters
-
value: boolean
Returns any
-
total
-
Gets the performance counter for active indices
Returns PerfCounter
total
-
Gets the performance counter for total vertices
Returns PerfCounter
uid
-
Return a unique id as a string which can serve as an identifier for the scene
Returns string
un
-
Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
Returns Vector2
use
-
Gets or sets a boolean indicating if the scene must use right-handed coordinates system
Returns boolean
-
Gets or sets a boolean indicating if the scene must use right-handed coordinates system
Parameters
-
value: boolean
Returns any
-
Static Double
-
Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
Returns number
-
Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
Parameters
-
value: number
Returns any
-
Static Drag
-
Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
Returns number
-
Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
Parameters
-
value: number
Returns any
-
Static Exclusive
-
If you need to check double click without raising a single click at first click, enable this flag
Returns boolean
-
If you need to check double click without raising a single click at first click, enable this flag
Parameters
-
value: boolean
Returns any
-
Static Long
-
Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
Returns number
-
Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
Parameters
-
value: number
Returns any
-
Methods
add
-
Adds the given action manager to this scene
Parameters
-
newActionManager: AbstractActionManager
The action manager to add
Returns void
-
add
-
Adds the given animation to this scene
Parameters
-
newAnimation: Animation
The animation to add
Returns void
-
add
-
Adds the given animation group to this scene.
Parameters
-
newAnimationGroup: AnimationGroup
The animation group to add
Returns void
-
add
-
Adds the given camera to this scene
Parameters
-
newCamera: Camera
The camera to add
Returns void
-
add
-
Adds the given effect layer to this scene
Parameters
-
newEffectLayer: EffectLayer
defines the effect layer to add
Returns void
-
add
-
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
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
-
add
-
Adds the given geometry to this scene
Parameters
-
newGeometry: Geometry
The geometry to add
Returns void
-
add
-
Adds the given lens flare system to this scene
Parameters
-
newLensFlareSystem: LensFlareSystem
The lens flare system to add
Returns void
-
add
-
Adds the given light to this scene
Parameters
-
newLight: Light
The light to add
Returns void
-
add
-
Adds the given material to this scene
Parameters
-
newMaterial: Material
The material to add
Returns void
-
add
-
Add a mesh to the list of scene's meshes
Parameters
-
newMesh: AbstractMesh
defines the mesh to add
-
Optional recursive: boolean
if all child meshes should also be added to the scene
Returns void
-
add
-
Adds the given morph target to this scene
Parameters
-
newMorphTargetManager: MorphTargetManager
The morph target to add
Returns void
-
add
-
Adds the given multi-material to this scene
Parameters
-
newMultiMaterial: MultiMaterial
The multi-material to add
Returns void
-
add
-
Adds the given particle system to this scene
Parameters
-
newParticleSystem: IParticleSystem
The particle system to add
Returns void
-
add
-
Adds the given reflection probe to this scene.
Parameters
-
newReflectionProbe: ReflectionProbe
The reflection probe to add
Returns void
-
add
-
Adds the given skeleton to this scene
Parameters
-
newSkeleton: Skeleton
The skeleton to add
Returns void
-
add
-
Adds the given texture to this scene.
Parameters
-
newTexture: BaseTexture
The texture to add
Returns void
-
add
-
Add a transform node to the list of scene's transform nodes
Parameters
-
newTransformNode: TransformNode
defines the transform node to add
Returns void
-
animateSearch playground for animate
-
Execute all animations (for a frame)
Returns void
attach
-
Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
Parameters
-
Optional attachUp: boolean
defines if you want to attach events to pointerup
-
Optional attachDown: boolean
defines if you want to attach events to pointerdown
-
Optional attachMove: boolean
defines if you want to attach events to pointermove
Returns void
-
begin
-
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.
-
Optional loop: boolean
defines if the animation loops
-
Optional speedRatio: number
defines the speed in which to run the animation (1.0 by default)
-
Optional onAnimationEnd: () => void
defines the function to be executed when the animation ends
-
-
Returns void
-
-
-
Optional animatable: Animatable
defines an animatable object. If not provided a new one will be created from the given params
-
Optional stopCurrent: boolean
defines if the current animations must be stopped first (true by default)
-
Optional targetMask: (target: any) => boolean
defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
-
-
Parameters
-
target: any
Returns boolean
-
-
-
-
Optional onAnimationLoop: () => void
defines the callback to call when an animation loops
-
-
Returns void
-
-
-
Optional isAdditive: boolean
defines whether the animation should be evaluated additively (false by default)
Returns Animatable
the animatable object created for this animation
-
begin
-
Begin a new animation on a given node
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
-
Optional loop: boolean
defines if you want animation to loop (off by default)
-
Optional speedRatio: number
defines the speed ratio to apply to all animations
-
Optional onAnimationEnd: () => void
defines the callback to call when an animation ends (will be called once per node)
-
-
Returns void
-
-
-
Optional onAnimationLoop: () => void
defines the callback to call when an animation loops
-
-
Returns void
-
-
-
Optional isAdditive: boolean
defines whether the animation should be evaluated additively (false by default)
Returns Animatable
the list of created animatables
-
begin
-
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
-
Optional loop: boolean
defines if you want animation to loop (off by default)
-
Optional speedRatio: number
defines the speed ratio to apply to all animations
-
Optional onAnimationEnd: () => void
defines the callback to call when an animation ends (will be called once per node)
-
-
Returns void
-
-
-
Optional onAnimationLoop: () => void
defines the callback to call when an animation loops
-
-
Returns void
-
-
-
Optional isAdditive: boolean
defines whether the animation should be evaluated additively (false by default)
Returns Animatable[]
the list of animatables created for all nodes
-
begin
-
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.
-
Optional loop: boolean
defines if the animation loops
-
Optional speedRatio: number
defines the speed in which to run the animation (1.0 by default)
-
Optional onAnimationEnd: () => void
defines the function to be executed when the animation ends
-
-
Returns void
-
-
-
Optional animatable: Animatable
defines an animatable object. If not provided a new one will be created from the given params
-
Optional stopCurrent: boolean
defines if the current animations must be stopped first (true by default)
-
Optional targetMask: (target: any) => boolean
defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
-
-
Parameters
-
target: any
Returns boolean
-
-
-
-
Optional onAnimationLoop: () => void
defines the callback to call when an animation loops
-
-
Returns void
-
-
-
Optional isAdditive: boolean
defines whether the animation should be evaluated additively (false by default)
Returns Animatable[]
the list of created animatables
-
begin
-
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)
-
Optional loop: boolean
defines if the animation loops
-
Optional speedRatio: number
defines the speed in which to run the animation (1.0 by default)
-
Optional onAnimationEnd: () => void
defines the function to be executed when the animation ends
-
-
Returns void
-
-
-
Optional animatable: Animatable
defines an animatable object. If not provided a new one will be created from the given params
-
Optional targetMask: (target: any) => boolean
defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
-
-
Parameters
-
target: any
Returns boolean
-
-
-
-
Optional onAnimationLoop: () => void
defines the callback to call when an animation loops
-
-
Returns void
-
-
-
Optional isAdditive: boolean
defines whether the animation should be evaluated additively (false by default)
Returns Animatable
the animatable object created for this animation
-
bind
-
Bind the current view position to an effect.
Parameters
-
effect: Nullable<Effect>
The effect to be bound
-
Optional variableName: string
name of the shader variable that will hold the eye position
-
Optional isVector3: boolean
true to indicates that variableName is a Vector3 and not a Vector4
Returns Vector4
the computed eye position
-
clean
-
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
clear
-
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
create
-
Creates a default camera for the scene.
Parameters
-
Optional createArcRotateCamera: boolean
has the default false which creates a free camera, when true creates an arc rotate camera
-
Optional replace: boolean
has default false, when true replaces the active camera in the scene
-
Optional attachCameraControls: boolean
has default false, when true attaches camera controls to the canvas.
Returns void
-
create
-
Creates a default camera and a default light.
Parameters
-
Optional createArcRotateCamera: boolean
has the default false which creates a free camera, when true creates an arc rotate camera
-
Optional replace: boolean
has the default false, when true replaces the active camera/light in the scene
-
Optional attachCameraControls: boolean
has the default false, when true attaches camera controls to the canvas.
Returns void
-
create
-
Creates a new environment
Parameters
-
Optional options: Partial<IEnvironmentHelperOptions>
defines the options you can use to configure the environment
Returns Nullable<EnvironmentHelper>
the new EnvironmentHelper
-
create
-
Creates a default light for the scene.
Parameters
-
Optional replace: boolean
has the default false, when true replaces the existing lights in the scene with a hemispheric light
Returns void
-
create
-
Creates a new sky box
Parameters
-
Optional environmentTexture: BaseTexture
defines the texture to use as environment texture
-
Optional pbr: boolean
has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
-
Optional scale: number
defines the overall scale of the skybox
-
Optional blur: number
is only available when pbr is true, default is 0, no blur, maximum value is 1
-
Optional setGlobalEnvTexture: boolean
has default true indicating that scene.environmentTexture must match the current skybox texture
Returns Nullable<Mesh>
a new mesh holding the sky box
-
create
-
Creates a new VREXperienceHelper
Parameters
-
Optional webVROptions: VRExperienceHelperOptions
defines the options used to create the new VREXperienceHelper
Returns VRExperienceHelper
a new VREXperienceHelper
-
create
-
Creates a new WebXRDefaultExperience
Parameters
-
Optional options: WebXRDefaultExperienceOptions
experience options
Returns Promise<WebXRDefaultExperience>
a promise for a new WebXRDefaultExperience
-
create
-
Creates or updates the octree used to boost selection (picking)
Parameters
-
Optional maxCapacity: number
defines the maximum capacity per leaf
-
Optional maxDepth: number
defines the maximum depth of the octree
Returns Octree<AbstractMesh>
an octree of AbstractMesh
-
create
-
Creates a ray that can be used to pick in the scene
Parameters
-
x: number
defines the x coordinate of the origin (on-screen)
-
y: number
defines the y coordinate of the origin (on-screen)
-
world: Nullable<Matrix>
defines the world matrix to use if you want to pick in object space (instead of world space)
-
camera: Nullable<Camera>
defines the camera to use for the picking
-
Optional cameraViewSpace: boolean
defines if picking will be done in view space (false by default)
Returns Ray
a Ray
-
create
create
-
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
-
Optional camera: Camera
defines the camera to use for the picking
Returns Scene
the current scene
-
create
-
Creates a ray that can be used to pick in the scene
Parameters
-
x: number
defines the x coordinate of the origin (on-screen)
-
y: number
defines the y coordinate of the origin (on-screen)
-
world: Nullable<Matrix>
defines the world matrix to use if you want to pick in object space (instead of world space)
-
result: Ray
defines the ray where to store the picking ray
-
camera: Nullable<Camera>
defines the camera to use for the picking
-
Optional cameraViewSpace: boolean
defines if picking will be done in view space (false by default)
-
Optional enableDistantPicking: boolean
defines if picking should handle large values for mesh position/scaling (false by default)
Returns Scene
the current scene
-
create
-
Creates a scene UBO
Parameters
-
Optional name: string
name of the uniform buffer (optional, for debugging purpose only)
Returns UniformBuffer
a new ubo
-
delete
-
Deletes a physics compound impostor
Parameters
-
compound: any
defines the compound to delete
Returns void
-
detach
-
Detaches all event handlers
Returns void
disable
disable
-
Disables the GeometryBufferRender associated with the scene
Returns void
disable
-
Disables and disposes the physics engine associated with the scene
Returns void
disable
-
Disables the prepass associated with the scene
Returns void
disable
-
Disables the subsurface effect for prepass
Returns void
disposeSearch playground for dispose
-
Releases all held resources
Returns void
enable
-
Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
Parameters
-
Optional camera: Nullable<Camera>
The camera to create the depth renderer on (default: scene's active camera)
-
Optional storeNonLinearDepth: boolean
Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
-
Optional force32bitsFloat: boolean
Forces 32 bits float when supported (else 16 bits float is prioritized over 32 bits float if supported)
Returns DepthRenderer
the created depth renderer
-
enable
-
Enables a GeometryBufferRender and associates it with the scene
Parameters
-
Optional ratio: number
defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
Returns Nullable<GeometryBufferRenderer>
the GeometryBufferRenderer
-
enable
-
Enables physics to the current scene
Parameters
-
Optional gravity: Nullable<Vector3>
defines the scene's gravity for the physics engine. defaults to real earth gravity : (0, -9.81, 0)
-
Optional plugin: IPhysicsEnginePlugin
defines the physics engine to be used. defaults to CannonJS.
Returns boolean
a boolean indicating if the physics engine was initialized
-
enable
-
Enables the prepass and associates it with the scene
Returns Nullable<PrePassRenderer>
the PrePassRenderer
enable
-
Enables the subsurface effect for prepass
Returns Nullable<SubSurfaceConfiguration>
the SubSurfaceConfiguration
execute
-
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.
-
-
Returns void
-
-
-
Optional timeout: number
optional delay in ms
Returns void
-
execute
-
Registers a function to be executed when the scene is ready
Parameters
-
func: () => void
the function to be executed
-
-
Returns void
-
-
-
Optional checkRenderTargets: boolean
true to also check that the meshes rendered as part of a render target are ready (default: false)
Returns void
-
finalize
-
Update the scene ubo before it can be used in rendering processing
Returns UniformBuffer
the scene UniformBuffer
free
-
Clear the active meshes smart array preventing retention point in mesh dispose.
Returns void
free
-
Clear the processed materials smart array preventing retention point in material dispose.
Returns void
free
-
Clear the info related to rendering groups preventing retention points during dispose.
Returns void
freeze
-
Use this function to stop evaluating active meshes. The current list will be keep alive between frames
Parameters
-
Optional skipEvaluateActiveMeshes: boolean
defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
-
Optional onSuccess: () => void
optional success callback
-
-
Returns void
-
-
-
Optional onError: (message: string) => void
optional error callback
-
-
Parameters
-
message: string
Returns void
-
-
-
-
Optional freezeMeshes: boolean
defines if meshes should be frozen (true by default)
-
Optional keepFrustumCulling: boolean
defines if you want to keep running the frustum clipping (false by default)
Returns Scene
the current scene
-
freeze
-
Freeze all materials A frozen material will not be updatable but should be faster to render
Returns void
get
-
Gets the total number of active bones rendered per frame
Returns number
the total number of active bones rendered per frame
get
-
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
get
-
Gets the array of active meshes
Returns SmartArray<AbstractMesh>
an array of AbstractMesh
get
-
Gets the total number of active particles rendered per frame
Returns number
the total number of active particles rendered per frame
get
-
Gets all animatables associated with a given target
Parameters
-
target: any
defines the target to look animatables for
Returns Array<Animatable>
an array of Animatables
-
get
-
Gets the animatable associated with a specific target
Parameters
-
target: any
defines the target of the animatable
Returns Nullable<Animatable>
the required animatable if found
-
get
-
get an animation group using its name
Parameters
-
name: string
defines the material's name
Returns Nullable<AnimationGroup>
the animation group or null if none found.
-
get
-
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
get
-
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
-
get
get
get
get
-
Gets the bounding box renderer associated with the scene
Returns BoundingBoxRenderer
a BoundingBoxRenderer
get
get
get
-
Gets the cached visibility state (ie. the latest rendered one)
Returns Nullable<number>
the cached visibility state
get
get
get
get
get
get
get
-
Gets a string identifying the name of the class
Returns string
"Scene" string
get
-
Gets the engine associated with the scene
Returns Engine
an Engine
get
-
Get an externally attached data from its key
Type parameters
-
T
Parameters
-
key: string
the unique key that identifies the data
Returns Nullable<T>
the associated data, if present (can be null), or undefined if not present
-
get
-
Gets an unique Id for the current frame
Returns number
a number
get
-
Gets the list of geometries attached to the scene
Returns Geometry[]
an array of Geometry
get
get
get
get
-
Return a the first highlight layer of the scene with a given name.
Parameters
-
name: string
The name of the highlight layer to look for.
Returns Nullable<HighlightLayer>
The highlight layer if found otherwise null.
-
get
-
Gets the internal step used by deterministic lock step
Returns number
the internal step
get
get
get
get
get
-
Gets a the last added mesh using a given Id
Parameters
-
id: string
defines the Id to search for
Returns Nullable<AbstractMesh>
the found mesh or null if not found at all.
-
get
-
Gets a the last added mesh using a given Id
Parameters
-
id: string
defines the Id to search for
Returns Nullable<AbstractMesh>
the found mesh or null if not found at all.
-
get
get
get
-
Gets a lens flare system using its Id
Parameters
-
id: string
defines the Id to look for
Returns Nullable<LensFlareSystem>
the lens flare system or null if not found
-
get
-
Gets a lens flare system using its Id
Parameters
-
id: string
defines the Id to look for
Returns Nullable<LensFlareSystem>
the lens flare system or null if not found
-
get
-
Gets a lens flare system using its name
Parameters
-
name: string
defines the name to look for
Returns Nullable<LensFlareSystem>
the lens flare system or null if not found
-
get
get
get
get
get
get
get
get
get
get
get
get
-
Gets the first added mesh found of a given Id
Parameters
-
id: string
defines the Id to search for
Returns Nullable<AbstractMesh>
the mesh found or null if not found at all
-
get
-
Gets the first added mesh found of a given Id
Parameters
-
id: string
defines the Id to search for
Returns Nullable<AbstractMesh>
the mesh found or null if not found at all
-
get
-
Gets a mesh using a given name
Parameters
-
name: string
defines the name to search for
Returns Nullable<AbstractMesh>
the found mesh or null if not found at all.
-
get
-
Gets a mesh with its auto-generated unique Id
Parameters
-
uniqueId: number
defines the unique Id to search for
Returns Nullable<AbstractMesh>
the found mesh or null if not found at all.
-
get
-
Gets a mesh with its auto-generated unique Id
Parameters
-
uniqueId: number
defines the unique Id to search for
Returns Nullable<AbstractMesh>
the found mesh or null if not found at all.
-
get
-
Gets a list of meshes using their Id
Parameters
-
id: string
defines the Id to search for
Returns Array<AbstractMesh>
a list of meshes
-
get
-
Gets a list of meshes using their Id
Parameters
-
id: string
defines the Id to search for
Returns Array<AbstractMesh>
a list of meshes
-
get
-
Get a list of meshes by tags
Parameters
-
tagsQuery: string
defines the tags query to use
-
Optional forEach: (mesh: AbstractMesh) => void
defines a predicate used to filter results
-
-
Parameters
-
mesh: AbstractMesh
Returns void
-
-
-
Returns Mesh[]
an array of Mesh
-
get
-
Gets a morph target using a given id (if many are found, this function will pick the first one)
Parameters
-
id: string
defines the id to search for
Returns Nullable<MorphTarget>
the found morph target or null if not found at all.
-
get
-
Gets a morph target using a given name (if many are found, this function will pick the first one)
Parameters
-
name: string
defines the name to search for
Returns Nullable<MorphTarget>
the found morph target or null if not found at all.
-
get
-
Gets a morph target manager using a given id (if many are found, this function will pick the last one)
Parameters
-
id: number
defines the id to search for
Returns Nullable<MorphTargetManager>
the found morph target manager or null if not found at all.
-
get
get
get
get
-
Returns Array<Node>
all meshes, lights, cameras, transformNodes and bones
get
-
Get an externally attached data from its key, create it using a factory if it's not already present
Type parameters
-
T
Parameters
-
key: string
the unique key that identifies the data
-
factory: (k: string) => T
the factory that will be called to create the instance if and only if it doesn't exists
-
-
Parameters
-
k: string
Returns T
-
-
-
Returns T
the associated data, can be null if the factory returned null.
-
get
-
Gets the outline renderer associated with the scene
Returns OutlineRenderer
a OutlineRenderer
get
-
Gets a particle system by Id
Parameters
-
id: string
defines the particle system Id
Returns Nullable<IParticleSystem>
the corresponding system or null if none found
-
get
-
Gets a particle system by Id
Parameters
-
id: string
defines the particle system Id
Returns Nullable<IParticleSystem>
the corresponding system or null if none found
-
get
-
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.
get
-
Gets the current physics engine
Returns Nullable<IPhysicsEngine>
a IPhysicsEngine or null if none attached
get
-
Gets the mesh under the pointer
Returns Nullable<AbstractMesh>
a Mesh or null if no mesh is under the pointer
get
get
-
Gets a post process using a given name (if many are found, this function will pick the first one)
Parameters
-
name: string
defines the name to search for
Returns Nullable<PostProcess>
the found post process or null if not found at all.
-
get
-
Gets the current projection matrix
Returns Matrix
a Matrix
get
-
Gets an unique Id for the current render phase
Returns number
a number
get
-
Gets the uniform buffer used to store scene data
Returns UniformBuffer
a UniformBuffer
get
get
get
get
get
-
Gets the step Id used by deterministic lock step
Returns number
the step Id
get
-
Gets a texture using its name
Parameters
-
name: string
defines the texture's name
Returns Nullable<BaseTexture>
the texture or null if none found.
-
get
-
Get a texture using its unique id
Parameters
-
uniqueId: number
defines the texture's unique id
Returns Nullable<BaseTexture>
the texture or null if none found.
-
get
-
Get a texture using its unique id
Parameters
-
uniqueId: number
defines the texture's unique id
Returns Nullable<BaseTexture>
the texture or null if none found.
-
get
-
Gets the total number of vertices rendered per frame
Returns number
the total number of vertices rendered per frame
get
-
Gets the current transform matrix
Returns Matrix
a Matrix made of View * Projection
get
-
Gets the first added transform node found of a given Id
Parameters
-
id: string
defines the Id to search for
Returns Nullable<TransformNode>
the found transform node or null if not found at all.
-
get
-
Gets the first added transform node found of a given Id
Parameters
-
id: string
defines the Id to search for
Returns Nullable<TransformNode>
the found transform node or null if not found at all.
-
get
-
Gets a transform node using a given name
Parameters
-
name: string
defines the name to search for
Returns Nullable<TransformNode>
the found transform node or null if not found at all.
-
get
-
Gets a transform node with its auto-generated unique Id
Parameters
-
uniqueId: number
defines the unique Id to search for
Returns Nullable<TransformNode>
the found transform node or null if not found at all.
-
get
-
Gets a transform node with its auto-generated unique Id
Parameters
-
uniqueId: number
defines the unique Id to search for
Returns Nullable<TransformNode>
the found transform node or null if not found at all.
-
get
-
Gets a list of transform nodes using their Id
Parameters
-
id: string
defines the Id to search for
Returns Array<TransformNode>
a list of transform nodes
-
get
-
Gets a list of transform nodes using their Id
Parameters
-
id: string
defines the Id to search for
Returns Array<TransformNode>
a list of transform nodes
-
get
-
Get a list of transform nodes by tags
Parameters
-
tagsQuery: string
defines the tags query to use
-
Optional forEach: (transform: TransformNode) => void
defines a predicate used to filter results
-
-
Parameters
-
transform: TransformNode
Returns void
-
-
-
Returns TransformNode[]
an array of TransformNode
-
get
-
Gets an unique (relatively to the current scene) Id
Returns number
an unique number for the scene
get
-
Gets the current view matrix
Returns Matrix
a Matrix
get
-
Returns the number of items waiting to be loaded
Returns number
the number of items waiting to be loaded
get
-
Get the world extend vectors with an optional filter
Parameters
-
Optional filterPredicate: (mesh: AbstractMesh) => boolean
the predicate - which meshes should be included when calculating the world size
-
-
Parameters
-
mesh: AbstractMesh
Returns boolean
-
-
-
Returns { max: Vector3; min: Vector3 }
min and max vectors
-
increment
-
Call this function if you want to manually increment the render Id
Returns void
is
-
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
-
is
-
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
-
Optional visibility: number
defines the current visibility state
Returns boolean
true if one parameter is not cached
-
is
-
Gets a boolean indicating if there is an active physics engine
Returns boolean
a boolean indicating if there is an active physics engine
is
-
Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
Parameters
-
Optional pointerId: number
defines the pointer id to use in a multi-touch scenario (0 by default)
Returns boolean
true if the pointer was captured
-
is
-
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
-
Optional 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
-
mark
-
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
-
Optional predicate: (mat: Material) => boolean
If not null, it will be used to specify if a material has to be marked as dirty
-
-
Parameters
-
mat: Material
Returns boolean
-
-
-
Returns void
-
multi
-
Launch a ray to try to pick a mesh in the scene
Parameters
-
x: number
X position on screen
-
y: number
Y position on screen
-
Optional predicate: (mesh: AbstractMesh) => boolean
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
-
-
Parameters
-
mesh: AbstractMesh
Returns boolean
-
-
-
-
Optional camera: Camera
camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
-
Optional trianglePredicate: TrianglePickingPredicate
defines an optional predicate used to select faces when a mesh intersection is detected
Returns Nullable<PickingInfo[]>
an array of PickingInfo
-
multi
-
Launch a ray to try to pick sprites in the scene
Parameters
-
x: number
position on screen
-
y: number
position on screen
-
Optional predicate: (sprite: Sprite) => boolean
Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
-
-
Parameters
-
sprite: Sprite
Returns boolean
-
-
-
-
Optional 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 Nullable<PickingInfo[]>
a PickingInfo array
-
multi
-
Use the given ray to pick sprites in the scene
Parameters
-
ray: Ray
The ray (in world space) to use to pick meshes
-
Optional predicate: (sprite: Sprite) => boolean
Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
-
-
Parameters
-
sprite: Sprite
Returns boolean
-
-
-
-
Optional camera: Camera
camera to use. Can be set to null. In this case, the scene.activeCamera will be used
Returns Nullable<PickingInfo[]>
a PickingInfo array
-
multi
-
Launch a ray to try to pick a mesh in the scene
Parameters
-
ray: Ray
Ray to use
-
predicate: (mesh: AbstractMesh) => boolean
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
-
-
Parameters
-
mesh: AbstractMesh
Returns boolean
-
-
-
-
Optional trianglePredicate: TrianglePickingPredicate
defines an optional predicate used to select faces when a mesh intersection is detected
Returns Nullable<PickingInfo[]>
an array of PickingInfo
-
pickSearch playground for pick
-
Launch a ray to try to pick a mesh in the scene
Parameters
-
x: number
position on screen
-
y: number
position on screen
-
Optional predicate: (mesh: AbstractMesh) => boolean
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
-
-
Parameters
-
mesh: AbstractMesh
Returns boolean
-
-
-
-
Optional fastCheck: boolean
defines if the first intersection will be used (and not the closest)
-
Optional camera: Nullable<Camera>
to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
-
Optional trianglePredicate: TrianglePickingPredicate
defines an optional predicate used to select faces when a mesh intersection is detected
Returns Nullable<PickingInfo>
a PickingInfo
-
pick
-
Launch a ray to try to pick a sprite in the scene
Parameters
-
x: number
position on screen
-
y: number
position on screen
-
Optional predicate: (sprite: Sprite) => boolean
Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
-
-
Parameters
-
sprite: Sprite
Returns boolean
-
-
-
-
Optional fastCheck: boolean
defines if the first intersection will be used (and not the closest)
-
Optional 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 Nullable<PickingInfo>
a PickingInfo
-
pick
-
Use the given ray to pick a sprite in the scene
Parameters
-
ray: Ray
The ray (in world space) to use to pick meshes
-
Optional predicate: (sprite: Sprite) => boolean
Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
-
-
Parameters
-
sprite: Sprite
Returns boolean
-
-
-
-
Optional fastCheck: boolean
defines if the first intersection will be used (and not the closest)
-
Optional camera: Camera
camera to use. Can be set to null. In this case, the scene.activeCamera will be used
Returns Nullable<PickingInfo>
a PickingInfo
-
pick
-
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
-
Optional predicate: (mesh: AbstractMesh) => boolean
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
-
-
Parameters
-
mesh: AbstractMesh
Returns boolean
-
-
-
-
Optional fastCheck: boolean
defines if the first intersection will be used (and not the closest)
-
Optional camera: Nullable<Camera>
to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
Returns Nullable<PickingInfo>
a PickingInfo (Please note that some info will not be set like distance, bv, bu and everything that cannot be capture by only using bounding infos)
-
pick
-
Use the given ray to pick a mesh in the scene
Parameters
-
ray: Ray
The ray to use to pick meshes
-
Optional predicate: (mesh: AbstractMesh) => boolean
Predicate function used to determine eligible meshes. Can be set to null. In this case, a mesh must have isPickable set to true
-
-
Parameters
-
mesh: AbstractMesh
Returns boolean
-
-
-
-
Optional fastCheck: boolean
defines if the first intersection will be used (and not the closest)
-
Optional trianglePredicate: TrianglePickingPredicate
defines an optional predicate used to select faces when a mesh intersection is detected
Returns Nullable<PickingInfo>
a PickingInfo
-
push
-
Add a new geometry to this scene
Parameters
-
geometry: Geometry
defines the geometry to be added to the scene.
-
Optional 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
-
register
-
Registers a function to be called after every frame render
Parameters
-
func: () => void
defines the function to register
-
-
Returns void
-
-
Returns void
-
register
-
Registers a function to be called before every frame render
Parameters
-
func: () => void
defines the function to register
-
-
Returns void
-
-
Returns void
-
remove
-
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
-
remove
-
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
-
remove
-
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
-
remove
-
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
-
remove
-
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
-
remove
-
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
-
remove
-
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
-
remove
-
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
-
remove
-
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
-
remove
-
Removes the given material from this scene.
Parameters
-
toRemove: Material
The material to remove
Returns number
The index of the removed material
-
remove
-
Remove a mesh for the list of scene's meshes
Parameters
-
toRemove: AbstractMesh
defines the mesh to remove
-
Optional 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
-
remove
-
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
-
remove
-
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
-
remove
-
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
-
remove
-
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
-
remove
-
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
-
remove
-
Removes the given texture from this scene.
Parameters
-
toRemove: BaseTexture
The texture to remove
Returns number
The index of the removed texture
-
remove
-
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
-
renderSearch playground for render
-
Render the scene
Parameters
-
Optional updateCameras: boolean
defines a boolean indicating if cameras must update according to their inputs (true by default)
-
Optional ignoreAnimations: boolean
defines a boolean indicating if animations should not be executed (false by default)
Returns void
-
reset
-
Resets all cached information relative to material (including effect and visibility)
Returns void
reset
-
Resets the draw wrappers cache of all meshes
Parameters
-
Optional passId: number
If provided, releases only the draw wrapper corresponding to this render pass id
Returns void
-
reset
-
Resets the last animation time frame. Useful to override when animations start running when loading a scene for the first time.
Returns void
set
set
set
set
-
Sets the default candidate providers for the scene. This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates and getCollidingSubMeshCandidates to their default function
Returns void
set
-
Force the value of meshUnderPointer
Parameters
-
mesh: Nullable<AbstractMesh>
defines the mesh to use
-
Optional pointerId: number
optional pointer id when using more than one pointer
-
Optional pickResult: Nullable<PickingInfo>
optional pickingInfo data used to find mesh
Returns void
-
set
set
-
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.
-
Optional depth: boolean
Automatically clears depth between groups if true and autoClear is true.
-
Optional stencil: boolean
Automatically clears stencil between groups if true and autoClear is true.
Returns void
-
set
-
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
-
Optional opaqueSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>
The opaque queue comparison function use to sort.
-
Optional alphaTestSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>
The alpha test queue comparison function use to sort.
-
Optional transparentSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>
The transparent queue comparison function use to sort.
Returns void
-
set
-
Sets the scene ubo
Parameters
-
ubo: UniformBuffer
the ubo to set for the scene
Returns void
-
set
-
Sets the step Id used by deterministic lock step
Parameters
-
newStepId: number
defines the step Id
Returns void
-
set
-
Sets the current transform matrix
Parameters
-
viewL: Matrix
defines the View matrix to use
-
projectionL: Matrix
defines the Projection matrix to use
-
Optional viewR: Matrix
defines the right View matrix to use (if provided)
-
Optional projectionR: Matrix
defines the right Projection matrix to use (if provided)
Returns void
-
simulate
-
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
-
Optional pointerEventInit: PointerEventInit
pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
Returns Scene
the current scene
-
simulate
-
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
-
Optional pointerEventInit: PointerEventInit
pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
Returns Scene
the current scene
-
simulate
-
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
-
Optional pointerEventInit: PointerEventInit
pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
-
Optional 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
-
sort
-
Sorts the list list based on light priorities
Returns void
stop
-
Stops and removes all animations that have been applied to the scene
Returns void
stop
-
Will stop the animation of the given target
Parameters
-
target: any
the target
-
Optional animationName: string
the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
-
Optional targetMask: (target: any) => boolean
a function that determines if the animation should be stopped based on its target (all animations will be stopped if both this and animationName are empty)
-
-
Parameters
-
target: any
Returns boolean
-
-
-
Returns void
-
switch
-
Switch active camera
Parameters
-
newCamera: Camera
defines the new active camera
-
Optional attachControl: boolean
defines if attachControl must be called for the new active camera (default: true)
Returns void
-
unfreeze
-
Use this function to restart evaluating active meshes on every frame
Returns Scene
the current scene
unfreeze
-
Unfreeze all materials A frozen material will not be updatable but should be faster to render
Returns void
unregister
-
Unregisters a function called after every frame render
Parameters
-
func: () => void
defines the function to unregister
-
-
Returns void
-
-
Returns void
-
unregister
-
Unregisters a function called before every frame render
Parameters
-
func: () => void
defines the function to unregister
-
-
Returns void
-
-
Returns void
-
update
-
Update the transform matrix to update from the current active camera
Parameters
-
Optional force: boolean
defines a boolean used to force the update even if cache is up to date
Returns void
-
when
-
Returns a promise that resolves when the scene is ready
Parameters
-
Optional 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
-
Static Add
-
Adds n individual parser in the list of available ones
Parameters
-
name: string
Defines the name of the parser
-
parser: IndividualBabylonFileParser
Defines the parser to add
Returns void
-
Static Add
-
Adds a parser in the list of available ones
Parameters
-
name: string
Defines the name of the parser
-
parser: BabylonFileParser
Defines the parser to add
Returns void
-
Static Collision
-
Factory used to create the a collision coordinator.
Returns ICollisionCoordinator
The collision coordinator
Static Default
Static Get
-
Gets an individual parser from the list of available ones
Parameters
-
name: string
Defines the name of the parser
Returns Nullable<IndividualBabylonFileParser>
the requested parser or null
-
Static Get
-
Gets a general parser from the list of available ones
Parameters
-
name: string
Defines the name of the parser
Returns Nullable<BabylonFileParser>
the requested parser or null
-
Static ParseSearch playground for Parse
-
Parser json data and populate both a scene and its associated container object
Parameters
-
jsonData: any
Defines the data to parse
-
scene: Scene
Defines the scene to parse the data for
-
container: AssetContainer
Defines the container attached to the parsing sequence
-
rootUrl: string
Defines the root url of the data
Returns void
-
Represents a scene to be rendered by the engine.
https://doc.babylonjs.com/features/scene