Scene class

class Scene

Inheritance
Implemented types
Annotations
  • @JS()

Constructors

Scene(Engine engine, [SceneOptions options])

Properties

actionManager AbstractActionManager
getter/setter pair
activeBonesPerfCounter PerfCounter
no setter
activeCamera Camera
getter/setter pair
activeCameras List<Camera>
getter/setter pair
activeParticlesPerfCounter PerfCounter
no setter
afterCameraRender ← void Function()
no getter
afterRender ← void Function()
no getter
ambientColor Color3
getter/setter pair
animatables List<Animatable>
no setter
animationGroups List<AnimationGroup>
getter/setter pairinherited
animationPropertiesOverride AnimationPropertiesOverride
getter/setter pair
animations List<Animation>
getter/setter pairinherited
animationsEnabled bool
getter/setter pair
animationTimeScale num
getter/setter pair
audioEnabled bool
getter/setter pair
audioListenerPositionProvider Vector3 Function()
getter/setter pair
audioPositioningRefreshRate num
getter/setter pair
autoClear bool
getter/setter pair
autoClearDepthAndStencil bool
getter/setter pair
beforeCameraRender ← void Function()
no getter
beforeRender ← void Function()
no getter
blockfreeActiveMeshesAndRenderingGroups bool
getter/setter pair
blockMaterialDirtyMechanism bool
getter/setter pair
cameras List<Camera>
getter/setter pairinherited
cameraToUseForPointers Camera
getter/setter pair
clearColor Color4
getter/setter pair
clipPlane Plane
getter/setter pairoverride
clipPlane2 Plane
getter/setter pairoverride
clipPlane3 Plane
getter/setter pairoverride
clipPlane4 Plane
getter/setter pairoverride
clipPlane5 Plane
getter/setter pairoverride
clipPlane6 Plane
getter/setter pairoverride
collisionCoordinator ICollisionCoordinator
no setter
collisionsEnabled bool
getter/setter pair
constantlyUpdateMeshUnderPointer bool
getter/setter pair
customLODSelector AbstractMesh Function(AbstractMesh mesh, Camera camera)
getter/setter pair
customRenderTargets List<RenderTargetTexture>
getter/setter pair
debugLayer DebugLayer
getter/setter pair
defaultCursor String
getter/setter pair
defaultMaterial Material
getter/setter pair
deltaTime num
getter/setter pair
disableOfflineSupportExceptionRules List<RegExp>
getter/setter pair
dispatchAllSubMeshesOfActiveMeshes bool
getter/setter pair
doNotHandleCursors bool
getter/setter pair
DoubleClickDelay num
getter/setter pair
DragMovementThreshold num
getter/setter pair
dumpNextRenderTargets bool
getter/setter pair
effectLayers List<EffectLayer>
getter/setter pairinherited
environmentBRDFTexture BaseTexture
getter/setter pair
environmentIntensity num
getter/setter pair
environmentTexture BaseTexture
getter/setter pairoverride
ExclusiveDoubleClickMode bool
getter/setter pair
fogColor Color3
getter/setter pair
fogDensity num
getter/setter pair
fogEnabled bool
getter/setter pair
fogEnd num
getter/setter pair
fogMode num
getter/setter pair
fogStart num
getter/setter pair
forcePointsCloud bool
getter/setter pair
forceShowBoundingBoxes bool
getter/setter pair
forceWireframe bool
getter/setter pair
frustumPlanes List<Plane>
no setter
gamepadManager GamepadManager
getter/setter pair
geometries List<Geometry>
getter/setter pairinherited
geometriesByUniqueId ↔ dynamic
getter/setter pair
geometryBufferRenderer GeometryBufferRenderer
getter/setter pair
getActiveMeshCandidates ISmartArrayLike<AbstractMesh> Function()
getter/setter pair
getActiveSubMeshCandidates ISmartArrayLike<SubMesh> Function(AbstractMesh mesh)
getter/setter pair
getCollidingSubMeshCandidates ISmartArrayLike<SubMesh> Function(AbstractMesh mesh, Collider collider)
getter/setter pair
getDeterministicFrameTime num Function()
getter/setter pair
getIntersectingSubMeshCandidates ISmartArrayLike<SubMesh> Function(AbstractMesh mesh, Ray localRay)
getter/setter pair
gravity Vector3
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
headphone bool
getter/setter pair
hoverCursor String
getter/setter pair
imageProcessingConfiguration ImageProcessingConfiguration
no setter
importedMeshesFiles List<String>
getter/setter pair
isDisposed bool
no setter
isLoading bool
no setter
layers List<Layer>
getter/setter pairinherited
lensFlaresEnabled bool
getter/setter pair
lensFlareSystems List<LensFlareSystem>
getter/setter pairinherited
lights List<Light>
getter/setter pairinherited
lightsEnabled bool
getter/setter pair
loadingPluginName String
getter/setter pair
LongPressDelay num
getter/setter pair
mainSoundTrack SoundTrack
getter/setter pair
materials List<Material>
getter/setter pairinherited
meshes List<AbstractMesh>
getter/setter pairinherited
meshUnderPointer AbstractMesh
no setter
metadata ↔ dynamic
getter/setter pair
multiMaterials List<MultiMaterial>
getter/setter pairinherited
offlineProvider IOfflineProvider
getter/setter pair
onActiveCameraChanged Observable<Scene>
getter/setter pair
onAfterActiveMeshesEvaluationObservable Observable<Scene>
getter/setter pair
onAfterAnimationsObservable Observable<Scene>
getter/setter pair
onAfterCameraRenderObservable Observable<Camera>
getter/setter pair
onAfterDrawPhaseObservable Observable<Scene>
getter/setter pair
onAfterParticlesRenderingObservable Observable<Scene>
getter/setter pair
onAfterPhysicsObservable Observable<Scene>
getter/setter pair
onAfterRenderCameraObservable Observable<Camera>
getter/setter pair
onAfterRenderingGroupObservable Observable<RenderingGroupInfo>
getter/setter pair
onAfterRenderObservable Observable<Scene>
getter/setter pair
onAfterRenderTargetsRenderObservable Observable<Scene>
getter/setter pair
onAfterSpritesRenderingObservable Observable<Scene>
getter/setter pair
onAfterStepObservable Observable<Scene>
getter/setter pair
onAnimationFileImportedObservable Observable<Scene>
getter/setter pair
onBeforeActiveMeshesEvaluationObservable Observable<Scene>
getter/setter pair
onBeforeAnimationsObservable Observable<Scene>
getter/setter pair
onBeforeCameraRenderObservable Observable<Camera>
getter/setter pair
onBeforeDrawPhaseObservable Observable<Scene>
getter/setter pair
onBeforeParticlesRenderingObservable Observable<Scene>
getter/setter pair
onBeforePhysicsObservable Observable<Scene>
getter/setter pair
onBeforeRenderingGroupObservable Observable<RenderingGroupInfo>
getter/setter pair
onBeforeRenderObservable Observable<Scene>
getter/setter pair
onBeforeRenderTargetsRenderObservable Observable<Scene>
getter/setter pair
onBeforeSpritesRenderingObservable Observable<Scene>
getter/setter pair
onBeforeStepObservable Observable<Scene>
getter/setter pair
onCameraRemovedObservable Observable<Camera>
getter/setter pair
onDataLoadedObservable Observable<Scene>
getter/setter pair
onDispose ← void Function()
no getter
onDisposeObservable Observable<Scene>
getter/setter pair
onGeometryRemovedObservable Observable<Geometry>
getter/setter pair
onKeyboardObservable Observable<KeyboardInfo>
getter/setter pair
onLightRemovedObservable Observable<Light>
getter/setter pair
onMaterialRemovedObservable Observable<Material>
getter/setter pair
onMeshImportedObservable Observable<AbstractMesh>
getter/setter pair
onMeshRemovedObservable Observable<AbstractMesh>
getter/setter pair
onMultiMaterialRemovedObservable Observable<MultiMaterial>
getter/setter pair
onNewCameraAddedObservable Observable<Camera>
getter/setter pair
onNewGeometryAddedObservable Observable<Geometry>
getter/setter pair
onNewLightAddedObservable Observable<Light>
getter/setter pair
onNewMaterialAddedObservable Observable<Material>
getter/setter pair
onNewMeshAddedObservable Observable<AbstractMesh>
getter/setter pair
onNewMultiMaterialAddedObservable Observable<MultiMaterial>
getter/setter pair
onNewSkeletonAddedObservable Observable<Skeleton>
getter/setter pair
onNewTextureAddedObservable Observable<BaseTexture>
getter/setter pair
onNewTransformNodeAddedObservable Observable<TransformNode>
getter/setter pair
onPointerDown ↔ void Function(PointerEvent evt, PickingInfo pickInfo, PointerEventTypes type)
getter/setter pair
onPointerMove ↔ void Function(PointerEvent evt, PickingInfo pickInfo, PointerEventTypes type)
getter/setter pair
onPointerObservable Observable<PointerInfo>
getter/setter pair
onPointerPick ↔ void Function(PointerEvent evt, PickingInfo pickInfo)
getter/setter pair
onPointerUp ↔ void Function(PointerEvent evt, PickingInfo pickInfo, PointerEventTypes type)
getter/setter pair
onPreKeyboardObservable Observable<KeyboardInfoPre>
getter/setter pair
onPrePointerObservable Observable<PointerInfoPre>
getter/setter pair
onReadyObservable Observable<Scene>
getter/setter pair
onSkeletonRemovedObservable Observable<Skeleton>
getter/setter pair
onTextureRemovedObservable Observable<BaseTexture>
getter/setter pair
onTransformNodeRemovedObservable Observable<TransformNode>
getter/setter pair
particlesEnabled bool
getter/setter pair
particleSystems List<IParticleSystem>
getter/setter pairinherited
physicsEnabled bool
getter/setter pair
pointerDownPredicate bool Function(AbstractMesh Mesh)
getter/setter pair
pointerMovePredicate bool Function(AbstractMesh Mesh)
getter/setter pair
pointerUpPredicate bool Function(AbstractMesh Mesh)
getter/setter pair
pointerX num
getter/setter pair
pointerY num
getter/setter pair
postProcesses List<PostProcess>
getter/setter pairinherited
postProcessesEnabled bool
getter/setter pair
postProcessManager PostProcessManager
getter/setter pair
postProcessRenderPipelineManager PostProcessRenderPipelineManager
getter/setter pair
prePass bool
getter/setter pair
prePassRenderer PrePassRenderer
getter/setter pairinherited
preventDefaultOnPointerDown bool
getter/setter pair
preventDefaultOnPointerUp bool
getter/setter pair
probesEnabled bool
getter/setter pair
proceduralTexturesEnabled bool
getter/setter pair
reflectionProbes List<ReflectionProbe>
getter/setter pairinherited
renderTargetsEnabled bool
getter/setter pair
requireLightSorting bool
getter/setter pair
reservedDataStore ↔ dynamic
getter/setter pair
rootNodes List<Node>
getter/setter pairinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
selectionOctree Octree<AbstractMesh>
getter/setter pair
shadowsEnabled bool
getter/setter pair
simplificationQueue SimplificationQueue
getter/setter pair
skeletons List<Skeleton>
getter/setter pairinherited
skeletonsEnabled bool
getter/setter pair
skipFrustumClipping bool
getter/setter pair
soundTracks List<SoundTrack>
getter/setter pair
spriteManagers List<ISpriteManager>
getter/setter pair
spritesEnabled bool
getter/setter pair
subSurfaceConfiguration SubSurfaceConfiguration
getter/setter pairinherited
textures List<BaseTexture>
getter/setter pairinherited
texturesEnabled bool
getter/setter pair
totalActiveIndicesPerfCounter PerfCounter
no setter
totalVerticesPerfCounter PerfCounter
no setter
transformNodes List<TransformNode>
getter/setter pairinherited
uid String
no setter
unTranslatedPointer Vector2
no setter
useClonedMeshMap bool
no setter
useConstantAnimationDeltaTime bool
getter/setter pair
useDelayedTextureLoading bool
getter/setter pair
useMaterialMeshMap bool
no setter
useRightHandedSystem bool
getter/setter pair

Methods

addActionManager(AbstractActionManager newActionManager) → void
addAnimation(Animation newAnimation) → void
addAnimationGroup(AnimationGroup newAnimationGroup) → void
addCamera(Camera newCamera) → void
addEffectLayer(EffectLayer newEffectLayer) → void
inherited
addGeometry(Geometry newGeometry) → void
addLensFlareSystem(LensFlareSystem newLensFlareSystem) → void
inherited
addLight(Light newLight) → void
addMaterial(Material newMaterial) → void
addMesh(AbstractMesh newMesh, [bool recursive]) → void
addMorphTargetManager(MorphTargetManager newMorphTargetManager) → void
addMultiMaterial(MultiMaterial newMultiMaterial) → void
addParticleSystem(IParticleSystem newParticleSystem) → void
addReflectionProbe(ReflectionProbe newReflectionProbe) → void
inherited
addSkeleton(Skeleton newSkeleton) → void
addTexture(BaseTexture newTexture) → void
addTransformNode(TransformNode newTransformNode) → void
animate() → void
attachControl([bool attachUp, bool attachDown, bool attachMove]) → void
beginAnimation(dynamic target, num from, num to, [bool loop, num speedRatio, void onAnimationEnd(), Animatable animatable, bool stopCurrent, bool targetMask(dynamic target), void onAnimationLoop(), bool isAdditive]) Animatable
beginDirectAnimation(dynamic target, List<Animation> animations, num from, num to, [bool loop, num speedRatio, void onAnimationEnd(), void onAnimationLoop(), bool isAdditive]) Animatable
beginDirectHierarchyAnimation(Node target, bool directDescendantsOnly, List<Animation> animations, num from, num to, [bool loop, num speedRatio, void onAnimationEnd(), void onAnimationLoop(), bool isAdditive]) List<Animatable>
beginHierarchyAnimation(dynamic target, bool directDescendantsOnly, num from, num to, [bool loop, num speedRatio, void onAnimationEnd(), Animatable animatable, bool stopCurrent, bool targetMask(dynamic target), void onAnimationLoop(), bool isAdditive]) List<Animatable>
beginWeightedAnimation(dynamic target, num from, num to, num weight, [bool loop, num speedRatio, void onAnimationEnd(), Animatable animatable, bool targetMask(dynamic target), void onAnimationLoop(), bool isAdditive]) Animatable
cleanCachedTextureBuffer() → void
clearCachedVertexData() → void
createDefaultCamera([bool createArcRotateCamera, bool replace, bool attachCameraControls]) → void
createDefaultCameraOrLight([bool createArcRotateCamera, bool replace, bool attachCameraControls]) → void
createDefaultEnvironment([IEnvironmentHelperOptions options]) EnvironmentHelper
createDefaultLight([bool replace]) → void
createDefaultSkybox([BaseTexture environmentTexture, bool pbr, num scale, num blur, bool setGlobalEnvTexture]) Mesh
createDefaultVRExperience([VRExperienceHelperOptions webVROptions]) VRExperienceHelper
createDefaultXRExperienceAsync(WebXRDefaultExperienceOptions options) Promise<WebXRDefaultExperience>
createOrUpdateSelectionOctree([num maxCapacity, num maxDepth]) Octree<AbstractMesh>
createPickingRay(num x, num y, Matrix world, Camera camera, [bool cameraViewSpace]) Ray
createPickingRayInCameraSpace(num x, num y, [Camera camera]) Ray
createPickingRayInCameraSpaceToRef(num x, num y, Ray result, [Camera camera]) Scene
createPickingRayToRef(num x, num y, Matrix world, Ray result, Camera camera, [bool cameraViewSpace]) Scene
deleteCompoundImpostor(dynamic compound) → void
detachControl() → void
disableDepthRenderer([Camera camera]) → void
disableGeometryBufferRenderer() → void
disablePhysicsEngine() → void
disablePrePassRenderer() → void
inherited
disableSubSurfaceForPrePass() → void
inherited
dispose() → void
enableDepthRenderer([Camera camera, bool storeNonLinearDepth, bool force32bitsFloat]) DepthRenderer
enableGeometryBufferRenderer([num ratio]) GeometryBufferRenderer
enablePhysics(Vector3 gravity, [IPhysicsEnginePlugin plugin]) bool
enablePrePassRenderer() PrePassRenderer
inherited
enableSubSurfaceForPrePass() SubSurfaceConfiguration
inherited
executeOnceBeforeRender(void func(), [num timeout]) → void
executeWhenReady(void func()) → void
freeActiveMeshes() → void
freeProcessedMaterials() → void
freeRenderingGroups() → void
freezeActiveMeshes([bool skipEvaluateActiveMeshes, void onSuccess(), void onError(String message)]) Scene
freezeMaterials() → void
getActiveBones() num
getActiveIndices() num
getActiveMeshes() SmartArray<AbstractMesh>
getActiveParticles() num
getAllAnimatablesByTarget(dynamic target) List<Animatable>
getAnimatableByTarget(dynamic target) Animatable
getAnimationGroupByName(String name) AnimationGroup
getAnimationRatio() num
getAutoClearDepthStencilSetup(num index) IRenderingManagerAutoClearSetup
getBoneByID(String id) Bone
getBoneByName(String name) Bone
getBoundingBoxRenderer() BoundingBoxRenderer
getCachedEffect() Effect
getCachedMaterial() Material
getCachedVisibility() num
getCameraByID(String id) Camera
getCameraByName(String name) Camera
getCameraByUniqueID(num uniqueId) Camera
getCamerasByTags(String tagsQuery, [void forEach(Camera camera)]) List<Camera>
getClassName() String
getEngine() Engine
getFrameId() num
getGeometries() List<Geometry>
getGeometryByID(String id) Geometry
getGlowLayerByName(String name) GlowLayer
inherited
getHighlightLayerByName(String name) HighlightLayer
inherited
getInternalStep() num
getLastEntryByID(String id) Node
getLastMaterialByID(String id) Material
getLastMeshByID(String id) AbstractMesh
getLastSkeletonByID(String id) Skeleton
getLensFlareSystemByID(String id) LensFlareSystem
inherited
getLensFlareSystemByName(String name) LensFlareSystem
inherited
getLightByID(String id) Light
getLightByName(String name) Light
getLightByUniqueID(num uniqueId) Light
getLightsByTags(String tagsQuery, [void forEach(Light light)]) List<Light>
getMaterialByID(String id) Material
getMaterialByName(String name) Material
getMaterialByTags(String tagsQuery, [void forEach(Material material)]) List<Material>
getMaterialByUniqueID(num uniqueId) Material
getMeshByID(String id) AbstractMesh
getMeshByName(String name) AbstractMesh
getMeshByUniqueID(num uniqueId) AbstractMesh
getMeshesByID(String id) List<AbstractMesh>
getMeshesByTags(String tagsQuery, [void forEach(AbstractMesh mesh)]) List<Mesh>
getMorphTargetById(String id) MorphTarget
getMorphTargetByName(String name) MorphTarget
getMorphTargetManagerById(num id) MorphTargetManager
getNodeByID(String id) Node
getNodeByName(String name) Node
getNodes() List<Node>
inherited
getOutlineRenderer() OutlineRenderer
getParticleSystemByID(String id) IParticleSystem
getPhysicsEngine() IPhysicsEngine
getPointerOverMesh() AbstractMesh
getPointerOverSprite() Sprite
getPostProcessByName(String name) PostProcess
getProjectionMatrix() Matrix
getRenderId() num
getSceneUniformBuffer() UniformBuffer
getSkeletonById(String id) Skeleton
getSkeletonByName(String name) Skeleton
getSkeletonByUniqueId(num uniqueId) Skeleton
getSoundByName(String name) Sound
getStepId() num
getTextureByUniqueID(num uniqueId) BaseTexture
getTotalVertices() num
getTransformMatrix() Matrix
getTransformNodeByID(String id) TransformNode
getTransformNodeByName(String name) TransformNode
getTransformNodeByUniqueID(num uniqueId) TransformNode
getTransformNodesByID(String id) List<TransformNode>
getTransformNodesByTags(String tagsQuery, [void forEach(TransformNode transform)]) List<TransformNode>
getUniqueId() num
getViewMatrix() Matrix
getWaitingItemsCount() num
incrementRenderId() → void
isActiveMesh(AbstractMesh mesh) bool
isCachedMaterialInvalid(Material material, Effect effect, [num visibility]) bool
isPhysicsEnabled() bool
isPointerCaptured([num pointerId]) bool
isReady() bool
markAllMaterialsAsDirty(num flag, [bool predicate(Material mat)]) → void
multiPickSprite(num x, num y, [bool predicate(Sprite sprite), Camera camera]) List<PickingInfo>
multiPickSpriteWithRay(Ray ray, [bool predicate(Sprite sprite), Camera camera]) List<PickingInfo>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pick(num x, num y, [bool predicate(AbstractMesh mesh), bool fastCheck, Camera camera, TrianglePickingPredicate trianglePredicate]) PickingInfo
pickSprite(num x, num y, [bool predicate(Sprite sprite), bool fastCheck, Camera camera]) PickingInfo
pickSpriteWithRay(Ray ray, [bool predicate(Sprite sprite), bool fastCheck, Camera camera]) PickingInfo
pickWithBoundingInfo(num x, num y, [bool predicate(AbstractMesh mesh), bool fastCheck, Camera camera]) PickingInfo
pickWithRay(Ray ray, [bool predicate(AbstractMesh mesh), bool fastCheck, TrianglePickingPredicate trianglePredicate]) PickingInfo
pushGeometry(Geometry geometry, [bool force]) bool
registerAfterRender(void func()) → void
registerBeforeRender(void func()) → void
removeActionManager(AbstractActionManager toRemove) num
removeAnimation(Animation toRemove) num
removeAnimationGroup(AnimationGroup toRemove) num
removeCamera(Camera toRemove) num
removeEffectLayer(EffectLayer toRemove) num
inherited
removeExternalData(String key) bool
removeGeometry(Geometry geometry) bool
removeLensFlareSystem(LensFlareSystem toRemove) num
inherited
removeLight(Light toRemove) num
removeMaterial(Material toRemove) num
removeMesh(AbstractMesh toRemove, [bool recursive]) num
removeMorphTargetManager(MorphTargetManager toRemove) num
removeMultiMaterial(MultiMaterial toRemove) num
removeParticleSystem(IParticleSystem toRemove) num
removeReflectionProbe(ReflectionProbe toRemove) num
inherited
removeSkeleton(Skeleton toRemove) num
removeTexture(BaseTexture toRemove) num
removeTransformNode(TransformNode toRemove) num
render([bool updateCameras, bool ignoreAnimations]) → void
resetCachedMaterial() → void
resetLastAnimationTimeFrame() → void
setActiveCameraByID(String id) Camera
setActiveCameraByName(String name) Camera
setDefaultCandidateProviders() → void
setPointerOverMesh(AbstractMesh mesh, [num pointerId]) → void
setPointerOverSprite(Sprite sprite) → void
setRenderingAutoClearDepthStencil(num renderingGroupId, bool autoClearDepthStencil, [bool depth, bool stencil]) → void
setRenderingOrder(num renderingGroupId, [num opaqueSortCompareFn(SubMesh a, SubMesh b), num alphaTestSortCompareFn(SubMesh a, SubMesh b), num transparentSortCompareFn(SubMesh a, SubMesh b)]) → void
setStepId(num newStepId) → void
setTransformMatrix(Matrix viewL, Matrix projectionL, [Matrix viewR, Matrix projectionR]) → void
simulatePointerDown(PickingInfo pickResult, [dynamic pointerEventInit]) Scene
simulatePointerMove(PickingInfo pickResult, [dynamic pointerEventInit]) Scene
simulatePointerUp(PickingInfo pickResult, [dynamic pointerEventInit, bool doubleTap]) Scene
sortLightsByPriority() → void
stopAllAnimations() → void
stopAnimation(dynamic target, [String animationName, bool targetMask(dynamic target)]) → void
switchActiveCamera(Camera newCamera, [bool attachControl]) → void
toString() String
A string representation of this object.
inherited
unfreezeActiveMeshes() Scene
unfreezeMaterials() → void
unregisterAfterRender(void func()) → void
unregisterBeforeRender(void func()) → void
updateTransformMatrix([bool force]) → void
whenReadyAsync() Promise<void>

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

FOGMODE_EXP num
no setter
FOGMODE_EXP2 num
no setter
FOGMODE_LINEAR num
no setter
FOGMODE_NONE num
no setter
MaxDeltaTime num
getter/setter pair
MinDeltaTime num
getter/setter pair