The highlight layer Helps adding a glow effect around a mesh.
Once instantiated in a scene, simply use the pushMesh or removeMesh method to add or remove glowy meshes to your scene.
!!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
Instantiates a new highlight Layer and references it to the scene..
The name of the layer
The scene to use the layer in
Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
Gets the horizontal size of the blur.
Gets the vertical size of the blur.
Gets the camera attached to the layer.
Specifies whether or not the inner glow is ACTIVE in the layer.
Specifies wether the highlight layer is enabled or not.
The clear color of the texture used to generate the glow map.
An event triggered when the highlight layer has been blurred.
An event triggered when the generated texture has been merged in the scene.
An event triggered when the highlight layer is being blurred.
An event triggered when the generated texture is being merged in the scene.
An event triggered when the effect layer is about rendering the main texture with the glowy parts.
An event triggered when the effect layer has been disposed.
An event triggered when the efffect layer changes its size.
Specifies whether or not the outer glow is ACTIVE in the layer.
Gets the rendering group id the layer should render in.
Effect Name of the highlight layer.
Stencil value used for glowing meshes.
The neutral color used during the preparation of the glow effect. This is black by default as the blend operation is a blend operation.
Stencil value used for the other meshes in the scene.
Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
The mesh to exclude from the highlight layer
Dispose the highlight layer and free resources.
Free any resources and references associated to a mesh. Internal use
The mesh to free.
Gets the class name of the effect layer
the string with the class name of the effect layer
Get the effect name of the layer.
The effect name
Determine if a given mesh will be highlighted by the current HighlightLayer
mesh to test
true if the mesh will be highlighted by the current HighlightLayer
Checks for the readiness of the element composing the layer.
the mesh to check for
specify wether or not to use instances to render the mesh
true if ready otherwise, false
Returns wether or nood the layer needs stencil enabled during the mesh rendering.
Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
The mesh to highlight
Remove a mesh from the highlight layer in order to make it stop glowing.
The mesh to highlight
Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
Serializes this Highlight layer
a serialized Highlight layer object
Returns true if the layer contains information to display, otherwise false.
Generated using TypeDoc