Class HighlightLayer
Hierarchy
- EffectLayer
- HighlightLayer
Index
Constructors
Properties
- disable
Bounding Boxes From Effect Layer - inner
Glow - is
Enabled - name
- neutral
Color - on
After Blur Observable - on
After Compose Observable - on
After Render Mesh To Effect - on
Before Blur Observable - on
Before Compose Observable - on
Before Render Main Texture Observable - on
Before Render Mesh To Effect - on
Dispose Observable - on
Size Changed Observable - outer
Glow - Effect
Name - Glowing
Mesh Stencil Reference - Neutral
Color - Normal
Mesh Stencil Reference
Accessors
Methods
Constructors
constructor
Instantiates a new highlight Layer and references it to the scene..
Parameters
name: string
The name of the layer
Optional scene: Scene
The scene to use the layer in
Optional options: Partial<IHighlightLayerOptions>
Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
Returns HighlightLayer
Properties
disable
Specifies if the bounding boxes should be rendered normally or if they should undergo the effect of the layer
inner
Specifies whether or not the inner glow is ACTIVE in the layer.
is
Specifies whether the highlight layer is enabled or not.
nameSearch playground for name
The name of the layer
neutral
The clear color of the texture used to generate the glow map.
on
An event triggered when the highlight layer has been blurred.
on
An event triggered when the generated texture has been merged in the scene.
on
An event triggered after the mesh has been rendered into the effect render target.
on
An event triggered when the highlight layer is being blurred.
on
An event triggered when the generated texture is being merged in the scene.
on
An event triggered when the effect layer is about rendering the main texture with the glowy parts.
on
An event triggered when the mesh is rendered into the effect render target.
on
An event triggered when the effect layer has been disposed.
on
An event triggered when the effect layer changes its size.
outer
Specifies whether or not the outer glow is ACTIVE in the layer.
Static Readonly Effect
Effect Name of the highlight layer.
Static Glowing
Stencil value used for glowing meshes.
Static Neutral
The neutral color used during the preparation of the glow effect. This is black by default as the blend operation is a blend operation.
Static Normal
Stencil value used for the other meshes in the scene.
Accessors
blur
Gets the horizontal size of the blur.
Returns number
Specifies the horizontal size of the blur.
Parameters
value: number
Returns void
blur
Gets the vertical size of the blur.
Returns number
Specifies the vertical size of the blur.
Parameters
value: number
Returns void
camera
main
Gets the main texture where the effect is rendered
Returns RenderTargetTexture
rendering
Gets the rendering group id the layer should render in.
Returns number
Gets the rendering group id the layer should render in.
Parameters
renderingGroupId: number
Returns void
Methods
add
Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
Parameters
mesh: Mesh
The mesh to exclude from the highlight layer
Returns void
add
disposeSearch playground for dispose
Dispose the highlight layer and free resources.
Returns void
get
Gets the class name of the effect layer
Returns string
the string with the class name of the effect layer
get
Gets the intensity of the effect for a specific mesh.
Parameters
mesh: AbstractMesh
The mesh to get the effect intensity for
Returns number
The intensity of the effect for the mesh
get
Get the effect name of the layer.
Returns string
The effect name
has
Determine if a given mesh will be highlighted by the current HighlightLayer
Parameters
mesh: AbstractMesh
mesh to test
Returns boolean
true if the mesh will be highlighted by the current HighlightLayer
is
Checks for the readiness of the element composing the layer.
Parameters
subMesh: SubMesh
the mesh to check for
useInstances: boolean
specify whether or not to use instances to render the mesh
Returns boolean
true if ready otherwise, false
need
Returns whether or not the layer needs stencil enabled during the mesh rendering.
Returns boolean
remove
Remove all the meshes currently referenced in the highlight layer
Returns void
remove
Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
Parameters
mesh: Mesh
The mesh to highlight
Returns void
remove
Remove a mesh from the highlight layer in order to make it stop glowing.
Parameters
mesh: Mesh
The mesh to highlight
Returns void
renderSearch playground for render
Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
Returns void
serializeSearch playground for serialize
Serializes this Highlight layer
Returns any
a serialized Highlight layer object
set
Sets the intensity of the effect for a specific mesh.
Parameters
mesh: AbstractMesh
The mesh to set the effect intensity for
intensity: number
The intensity of the effect for the mesh
Returns void
set
Sets a specific material to be used to render a mesh/a list of meshes in the layer
Parameters
mesh: AbstractMesh | AbstractMesh[]
mesh or array of meshes
Optional material: Material
material to use by the layer when rendering the mesh(es). If undefined is passed, the specific material created by the layer will be used.
Returns void
should
Returns true if the layer contains information to display, otherwise false.
Returns boolean
Static ParseSearch playground for Parse
Creates a Highlight layer from parsed Highlight layer data
Parameters
parsedHightlightLayer: any
defines the Highlight layer data
scene: Scene
defines the current scene
rootUrl: string
defines the root URL containing the Highlight layer information
Returns HighlightLayer
a parsed Highlight layer
The highlight layer Helps adding a glow effect around a mesh.
Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove glowy meshes to your scene.
!!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!