Autodesk.Viewing
RenderLayerManager
Manages render layers for adding custom content that renders alongside the main scene.
Render layers allow extra content to render at specific points in the pipeline:
- Main target (
renderTarget: 'main'): Layers render during the main pass. UserenderOrder < 0to render before the main scene,renderOrder > 0to render after. - Overlay target (
renderTarget: 'overlay'): Layers render during the overlay pass, after all main content has been rendered.
new RenderLayerManager()
Methods
create(id, options)
Creates a new render layer with the specified options.
Parameters
| id* string | Unique identifier for the layer |
| options | Layer configuration options |
* Required
Returns
| type | description |
|---|---|
| boolean | True if the layer was created, false if it already exists or no id was provided |
Examples
// Create an overlay layer
viewer.getRenderLayers().create('annotations', {
renderTarget: 'overlay',
renderOrder: 10
});
// Create a layer that renders before the main scene
viewer.getRenderLayers().create('background', {
renderTarget: 'main',
renderOrder: -5
});
remove(id)
Removes a render layer and all its contents.
Parameters
| id* string | The layer identifier |
* Required
Returns
| type | description |
|---|---|
| boolean | True if the layer was removed, false if it doesn’t exist or no id was provided |
has(id)
Checks whether a render layer exists.
Parameters
| id* string | The layer identifier |
* Required
Returns
| type | description |
|---|---|
| boolean | True if the layer exists |
addModel(model, layerId)
Adds a Model to a render layer. A layer can contain multiple models.
Parameters
| model* | The model to add |
| layerId* string | The layer identifier |
* Required
Returns
| type | description |
|---|---|
| boolean | True if the model was added successfully |
removeModel(model, layerId)
Removes a Model from a render layer.
Parameters
| model* | The model to remove |
| layerId* string | The layer identifier |
* Required
Returns
| type | description |
|---|---|
| boolean | True if the model was removed successfully |
getModels(layerId)
Gets all models from a render layer.
Parameters
| layerId* string | The layer identifier |
* Required
Returns
| type | description |
|---|---|
| Array.<Model> | Array of models in the layer, or empty array if layer doesn’t exist |
clear(layerId)
Clears all content (scene and models) from a render layer. The layer itself is not removed.
Parameters
| layerId* string | The layer identifier |
* Required
Returns
| type | description |
|---|---|
| boolean | True if the layer was cleared successfully |
setLayerOptions(layerId, options)
Updates the options for a render layer.
Parameters
| layerId* string | The layer identifier |
| options* | Options to update |
* Required
Returns
| type | description |
|---|---|
| boolean | True if the options were updated successfully |
getLayerOptions(layerId)
Gets the current options for a render layer.
Parameters
| layerId* string | The layer identifier |
* Required
Returns
| type | description |
|---|---|
| RenderLayerOptions, null | The layer options, or null if layer doesn’t exist |
getOverlayRenderLayers()
Gets render layers for the overlay pass.
Returns
| type | description |
|---|---|
| Array | Array of visible overlay render layers |
getMainPassRenderLayers()
Gets render layers for the main pass, split by renderOrder.
Returns
| type | description |
|---|---|
| Object | Layers before and after main scene |