API
API|
@babylonjs/core|
UtilityLayerRenderer

Class UtilityLayerRenderer

Renders a layer on top of an existing scene

Implements

Index
constructor
handleEvents mainSceneTrackerPredicate onlyCheckPointerDownEvents onPointerOutObservable originalScene pickingEnabled pickUtilitySceneFirst processAllEvents shouldRender utilityLayerScene
DefaultKeepDepthUtilityLayer DefaultUtilityLayer
dispose getRenderCamera render setRenderCamera
handleEvents: boolean = true

boolean indicating if the utility layer should handle events

mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean

Gets or sets a predicate that will be used to indicate utility meshes present in the main scene

onlyCheckPointerDownEvents: boolean = true

If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene

onPointerOutObservable: Observable<number> = ...

Observable raised when the pointer moves from the utility layer scene to the main scene

originalScene: Scene

the original scene that will be rendered on top of

pickingEnabled: boolean = true

Set to false to disable picking

pickUtilitySceneFirst: boolean = true

If the picking should be done on the utility layer prior to the actual scene (Default: true)

processAllEvents: boolean = false

If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)

shouldRender: boolean = true

If the utility layer should automatically be rendered on top of existing scene

utilityLayerScene: Scene

The scene that is rendered on top of the original scene

  • Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)

    Parameters

    • OptionalgetRigParentIfPossible: boolean

      if the current active camera is a rig camera, should its parent camera be returned

    Returns Camera

    the camera that is used when rendering the utility layer