Decorations Class
A set of RenderGraphics and CanvasDecorations produced by Tools and Decorators, used to decorate the contents of a Viewport.
Implements
Methods
| Name | Description | |
|---|---|---|
| constructor(): Decorations | ||
| dispose(): void | Disposes of any resources owned by this object. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| canvasDecorations | CanvasDecorationList | undefined | ||
| normal Accessor | undefined | GraphicList | Decorations drawn as if they were part of the scene. | |
| normal Setter | normal(normal: GraphicList): void | ||
| skyBox Accessor | undefined | RenderGraphic | A view decoration created from a SkyBox rendered behind all other geometry to provide environmental context. | |
| skyBox Setter | skyBox(skyBox: RenderGraphic): void | ||
| viewBackground Accessor | undefined | RenderGraphic | A view decoration drawn as the background of the view. | |
| viewBackground Setter | viewBackground(viewBackground: RenderGraphic): void | ||
| viewOverlay Accessor | undefined | GraphicList | Overlay decorations drawn in view coordinates. | |
| viewOverlay Setter | viewOverlay(viewOverlay: GraphicList): void | ||
| world Accessor | undefined | GraphicList | Decorations drawn as if they were part of the world, but ignoring the view's ViewFlags. | |
| world Setter | world(world: GraphicList): void | ||
| worldOverlay Accessor | undefined | GraphicList | Overlay decorations drawn in world coordinates. | |
| worldOverlay Setter | worldOverlay(worldOverlay: GraphicList): void |
Defined in
Last Updated: 29 April, 2025
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.