Class OutlineRenderer
Hierarchy
- OutlineRenderer
Implements
Index
Constructors
Properties
Methods
Constructors
constructor
Instantiates a new outline renderer. (There could be only one per scene).
Parameters
scene: Scene
Defines the scene it belongs to
Returns OutlineRenderer
Properties
nameSearch playground for name
The name of the component. Each component must have a unique name.
sceneSearch playground for scene
The scene the component belongs to.
z OffsetSearch playground for zOffset
Defines a zOffset default Factor to prevent zFighting between the overlay and the mesh.
z Offset UnitsSearch playground for zOffsetUnits
Defines a zOffset default Unit to prevent zFighting between the overlay and the mesh.
Methods
disposeSearch playground for dispose
Disposes the component and the associated resources.
Returns void
is ReadySearch playground for isReady
Returns whether or not the outline renderer is ready for a given submesh. All the dependencies e.g. submeshes, texture, effect... mus be ready
Parameters
subMesh: SubMesh
Defines the submesh to check readiness for
useInstances: boolean
Defines whether wee are trying to render instances or not
Optional renderPassId: number
Render pass id to use to render the mesh
Returns boolean
true if ready otherwise false
rebuildSearch playground for rebuild
Rebuilds the elements related to this component in case of context lost for instance.
Returns void
registerSearch playground for register
Register the component to one instance of a scene.
Returns void
renderSearch playground for render
Renders the outline in the canvas.
Parameters
subMesh: SubMesh
Defines the sumesh to render
batch: _InstancesBatch
Defines the batch of meshes in case of instances
Optional useOverlay: boolean
Defines if the rendering is for the overlay or the outline
Optional renderPassId: number
Render pass id to use to render the mesh
Returns void
This class is responsible to draw the outline/overlay of meshes. It should not be used directly but through the available method on mesh.