UtilityLayerRenderer

Renders a layer on top of an existing scene

Hierarchy

  • UtilityLayerRenderer

Implements

Index

Constructors

constructor

Find examples in Playground
  • Instantiates a UtilityLayerRenderer

    Parameters

    • originalScene: Scene

      the original scene that will be rendered on top of

    • Optional handleEvents: boolean

      boolean indicating if the utility layer should handle events

    Returns UtilityLayerRenderer

Properties

mainSceneTrackerPredicate

Find examples in Playground
mainSceneTrackerPredicate: function

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

Type declaration

onPointerOutObservable

Find examples in Playground
onPointerOutObservable: Observable<number>

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

onlyCheckPointerDownEvents

Find examples in Playground
onlyCheckPointerDownEvents: boolean

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

originalScene

Find examples in Playground
originalScene: Scene

the original scene that will be rendered on top of

pickUtilitySceneFirst

Find examples in Playground
pickUtilitySceneFirst: boolean

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

processAllEvents

Find examples in Playground
processAllEvents: boolean

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

shouldRender

Find examples in Playground
shouldRender: boolean

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

utilityLayerScene

Find examples in Playground
utilityLayerScene: Scene

The scene that is rendered on top of the original scene

Static DefaultKeepDepthUtilityLayer

Find examples in Playground
DefaultKeepDepthUtilityLayer: UtilityLayerRenderer

A shared utility layer that can be used to embed objects into a scene (Depth map of the previous scene is not cleared before drawing on top of it)

Static DefaultUtilityLayer

Find examples in Playground
DefaultUtilityLayer: UtilityLayerRenderer

A shared utility layer that can be used to overlay objects into a scene (Depth map of the previous scene is cleared before drawing on top of it)

Methods

dispose

Find examples in Playground
  • dispose(): void

render

Find examples in Playground
  • render(): void
  • Renders the utility layers scene on top of the original scene

    Returns void

Generated using TypeDoc