@itwin/core-frontend
Version:
iTwin.js frontend components
40 lines • 2.06 kB
TypeScript
/** @packageDocumentation
* @module Rendering
*/
import { CanvasDecorationList } from "./CanvasDecoration";
import { GraphicList, RenderGraphic } from "./RenderGraphic";
/** A set of [[RenderGraphic]]s and [[CanvasDecoration]]s produced by [[Tool]]s and [[Decorator]]s, used to decorate the contents of a [[Viewport]].
* @public
* @extensions
*/
export declare class Decorations implements Disposable {
private _skyBox?;
private _viewBackground?;
private _normal?;
private _world?;
private _worldOverlay?;
private _viewOverlay?;
canvasDecorations?: CanvasDecorationList;
/** A view decoration created from a [[SkyBox]] rendered behind all other geometry to provide environmental context. */
get skyBox(): RenderGraphic | undefined;
set skyBox(skyBox: RenderGraphic | undefined);
/** A view decoration drawn as the background of the view. @see [[GraphicType.ViewBackground]]. */
get viewBackground(): RenderGraphic | undefined;
set viewBackground(viewBackground: RenderGraphic | undefined);
/** Decorations drawn as if they were part of the scene. @see [[GraphicType.Scene]]. */
get normal(): GraphicList | undefined;
set normal(normal: GraphicList | undefined);
/** Decorations drawn as if they were part of the world, but ignoring the view's [[ViewFlags]]. @see [[GraphicType.WorldDecoration]]. */
get world(): GraphicList | undefined;
set world(world: GraphicList | undefined);
/** Overlay decorations drawn in world coordinates. @see [[GraphicType.WorldOverlay]]. */
get worldOverlay(): GraphicList | undefined;
set worldOverlay(worldOverlay: GraphicList | undefined);
/** Overlay decorations drawn in view coordinates. @see [[GraphicType.ViewOverlay]]. */
get viewOverlay(): GraphicList | undefined;
set viewOverlay(viewOverlay: GraphicList | undefined);
[Symbol.dispose](): void;
/** @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [Symbol.dispose] instead. */
dispose(): void;
}
//# sourceMappingURL=Decorations.d.ts.map