Class UtilityLayerRenderer
Hierarchy
- UtilityLayerRenderer
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
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
main Scene Tracker PredicateSearch playground for mainSceneTrackerPredicate
Gets or sets a predicate that will be used to indicate utility meshes present in the main scene
Type declaration
-
-
Parameters
-
mesh: Nullable<AbstractMesh>
Returns boolean
-
-
on Pointer Out ObservableSearch playground for onPointerOutObservable
Observable raised when the pointer move from the utility layer scene to the main scene
only Check Pointer Down EventsSearch playground for onlyCheckPointerDownEvents
If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
original SceneSearch playground for originalScene
the original scene that will be rendered on top of
pick Utility Scene FirstSearch playground for pickUtilitySceneFirst
If the picking should be done on the utility layer prior to the actual scene (Default: true)
process All EventsSearch playground for processAllEvents
If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
should RenderSearch playground for shouldRender
If the utility layer should automatically be rendered on top of existing scene
utility Layer SceneSearch playground for utilityLayerScene
The scene that is rendered on top of the original scene
Accessors
Static Default Keep Depth Utility Layer
-
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)
Returns UtilityLayerRenderer
Static Default Utility Layer
-
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)
Returns UtilityLayerRenderer
Methods
disposeSearch playground for dispose
-
Disposes of the renderer
Returns void
get Render CameraSearch playground for getRenderCamera
-
Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
Parameters
-
Optional getRigParentIfPossible: 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
-
renderSearch playground for render
-
Renders the utility layers scene on top of the original scene
Returns void
Renders a layer on top of an existing scene