@itwin/core-frontend 5.4.0-dev.6 → 5.4.0

package/lib/cjs/SheetViewState.js

@@ -13,18 +13,10 @@ const core_geometry_1 = require("@itwin/core-geometry");
 const core_common_1 = require("@itwin/core-common");
 const CategorySelectorState_1 = require("./CategorySelectorState");
 const DisplayStyleState_1 = require("./DisplayStyleState");
-const GraphicBranch_1 = require("./render/GraphicBranch");
 const Frustum2d_1 = require("./Frustum2d");
-const MockRender_1 = require("./internal/render/MockRender");
-const FeatureSymbology_1 = require("./render/FeatureSymbology");
-const IModelApp_1 = require("./IModelApp");
-const CoordSystem_1 = require("./CoordSystem");
-const Viewport_1 = require("./Viewport");
 const ViewState_1 = require("./ViewState");
-const internal_1 = require("./tile/internal");
-const ImageUtil_1 = require("./common/ImageUtil");
-const ViewRect_1 = require("./common/ViewRect");
 const GraphicType_1 = require("./common/render/GraphicType");
+const SheetViewAttachments_1 = require("./internal/SheetViewAttachments");
 // cSpell:ignore ovrs
 /** Describes the geometry and styling of a sheet border decoration.
  * The sheet border decoration mimics a sheet of paper with a drop shadow.
@@ -98,189 +90,6 @@ class SheetBorder {
         builder.addLineString2d(this._rect, 0);
     }
 }
-/** The information required to instantiate an ViewAttachments object to draw ViewAttachments into a sheet. The list of view attachment Ids is
- * supplied to SheetViewState via the constructor. The corresponding ViewAttachmentProps for each attachment are obtained asynchronously in
- * SheetViewState.load(). The Attachments object is created in SheetViewState.attachToViewport and disposed of in SheetViewState.detachFromViewport.
- */
-class ViewAttachmentsInfo {
-    _attachments;
-    get attachments() { return this._attachments; }
-    constructor(attachments) {
-        this._attachments = attachments;
-    }
-    get isLoaded() {
-        return 0 === this._attachments.length || "string" !== typeof this._attachments[0];
-    }
-    get viewAttachmentProps() {
-        return this.isLoaded ? this._props : [];
-    }
-    get _props() {
-        (0, core_bentley_1.assert)(this.isLoaded);
-        return this._attachments;
-    }
-    get _ids() {
-        (0, core_bentley_1.assert)(!this.isLoaded);
-        return this._attachments;
-    }
-    static fromJSON(ids = []) {
-        return new ViewAttachmentsInfo(ids);
-    }
-    toJSON() {
-        return this.isLoaded ? this._props.map((x) => (0, core_bentley_1.expectDefined)(x.id)) : [...this._ids];
-    }
-    clone(iModel) {
-        let attachments = this._attachments;
-        if (this.isLoaded) {
-            // Need to clone the attached ViewStates.
-            attachments = attachments.map((attachment) => {
-                (0, core_bentley_1.assert)(typeof attachment !== "string");
-                return {
-                    ...attachment,
-                    attachedView: attachment.attachedView.clone(iModel),
-                };
-            });
-        }
-        return new ViewAttachmentsInfo(attachments);
-    }
-    preload(options) {
-        if (this.isLoaded)
-            return;
-        options.sheetViewAttachmentIds = core_bentley_1.CompressedId64Set.sortAndCompress(this._ids);
-        options.viewStateLoadProps = {
-            displayStyle: {
-                omitScheduleScriptElementIds: !IModelApp_1.IModelApp.tileAdmin.enableFrontendScheduleScripts,
-                compressExcludedElementIds: true,
-            },
-        };
-    }
-    async postload(options, iModel) {
-        if (options.sheetViewViews === undefined)
-            return;
-        if (options.sheetViewAttachmentProps === undefined)
-            return;
-        const viewStateProps = options.sheetViewViews; // This is viewstateProps, need to turn this into ViewState
-        const promises = [];
-        for (const viewProps of viewStateProps) {
-            const loadView = async () => {
-                try {
-                    if (viewProps === undefined)
-                        return undefined;
-                    const view = await iModel.views.convertViewStatePropsToViewState(viewProps);
-                    return view;
-                }
-                catch {
-                    return undefined;
-                }
-            };
-            promises.push(loadView());
-        }
-        const views = await Promise.all(promises);
-        const attachmentProps = options.sheetViewAttachmentProps;
-        (0, core_bentley_1.assert)(views.length === attachmentProps.length);
-        const attachments = [];
-        for (let i = 0; i < views.length; i++) {
-            const view = views[i];
-            if (view && !(view instanceof SheetViewState)) {
-                const props = attachmentProps[i];
-                props.attachedView = view;
-                attachments.push(props);
-            }
-        }
-        this._attachments = attachments;
-    }
-    async load(iModel) {
-        if (this.isLoaded)
-            return;
-        const attachmentProps = await iModel.elements.getProps(this._ids);
-        const promises = [];
-        for (const attachment of attachmentProps) {
-            const loadView = async () => {
-                try {
-                    const view = await iModel.views.load(attachment.view.id);
-                    return view;
-                }
-                catch {
-                    return undefined;
-                }
-            };
-            promises.push(loadView());
-        }
-        const views = await Promise.all(promises);
-        (0, core_bentley_1.assert)(views.length === attachmentProps.length);
-        const attachments = [];
-        for (let i = 0; i < views.length; i++) {
-            const view = views[i];
-            if (view && !(view instanceof SheetViewState)) {
-                const props = attachmentProps[i];
-                props.attachedView = view;
-                attachments.push(props);
-            }
-        }
-        this._attachments = attachments;
-    }
-    createAttachments(sheetView) {
-        return this.isLoaded ? new ViewAttachments(this._props, sheetView) : undefined;
-    }
-}
-/** The set of view attachments to be displayed in a Viewport via a SheetViewState. Allocated when the view becomes attached to a Viewport;
- * disposed of when it becomes detached from the viewport.
- */
-class ViewAttachments {
-    _attachments = [];
-    maxDepth = Frustum2d_1.Frustum2d.minimumZDistance;
-    constructor(infos, sheetView) {
-        for (const info of infos) {
-            const drawAsRaster = info.jsonProperties?.displayOptions?.drawAsRaster || (info.attachedView.is3d() && info.attachedView.isCameraOn);
-            const ctor = drawAsRaster ? RasterAttachment : OrthographicAttachment;
-            const attachment = new ctor(info.attachedView, info, sheetView);
-            this._attachments.push(attachment);
-            this.maxDepth = Math.max(this.maxDepth, attachment.zDepth);
-        }
-    }
-    [Symbol.dispose]() {
-        for (const attachment of this._attachments)
-            attachment[Symbol.dispose]();
-        this._attachments.length = 0;
-    }
-    [Symbol.iterator]() {
-        return this._attachments[Symbol.iterator]();
-    }
-    /** For tests. */
-    get attachments() {
-        return this._attachments;
-    }
-    get isEmpty() {
-        return 0 === this._attachments.length;
-    }
-    areAllTileTreesLoaded(displayedExtents) {
-        return this._attachments.every((x) => {
-            const placement = core_common_1.Placement2d.fromJSON(x.viewAttachmentProps.placement);
-            const attachmentRange = placement.calculateRange();
-            if (!attachmentRange.intersectsRangeXY(displayedExtents))
-                return true;
-            return x.areAllTileTreesLoaded;
-        });
-    }
-    /** Strictly for testing purposes */
-    areAllAttachmentsLoaded() {
-        return this._attachments.every((attachment) => attachment.areAllTileTreesLoaded);
-    }
-    discloseTileTrees(trees) {
-        for (const attachment of this._attachments)
-            trees.disclose(attachment);
-    }
-    collectStatistics(stats) {
-        for (const attachment of this._attachments)
-            attachment.collectStatistics(stats);
-    }
-    addToScene(context) {
-        for (const attachment of this._attachments)
-            attachment.addToScene(context);
-    }
-    findById(attachmentId) {
-        return this._attachments.find((attachment) => attachment.viewAttachmentProps.id === attachmentId);
-    }
-}
 /** A view of a [SheetModel]($backend).
  * @public
  * @extensions
@@ -288,11 +97,13 @@ class ViewAttachments {
 class SheetViewState extends ViewState_1.ViewState2d {
     /** The width and height of the sheet in world coordinates. */
     sheetSize;
-    _attachmentsInfo;
-    _attachments;
+    _viewAttachments;
     _viewedExtents;
+    _onViewAttachmentsReloaded = () => undefined;
+    /** Strictly for tests. */
+    onViewAttachmentsReloaded = new core_bentley_1.BeEvent();
     get attachmentIds() {
-        return this._attachmentsInfo.toJSON();
+        return this._viewAttachments.attachmentIds;
     }
     static get className() { return "SheetViewDefinition"; }
     static createFromProps(viewStateData, iModel) {
@@ -303,7 +114,7 @@ class SheetViewState extends ViewState_1.ViewState2d {
     }
     toProps() {
         const props = super.toProps();
-        props.sheetAttachments = this._attachmentsInfo.toJSON();
+        props.sheetAttachments = [...this.attachmentIds];
         // For sheetProps all that is actually used is the size, so just null out everything else.
         const codeProps = { spec: "", scope: "", value: "" };
         props.sheetProps = {
@@ -318,20 +129,15 @@ class SheetViewState extends ViewState_1.ViewState2d {
     }
     /** Strictly for testing. @internal */
     get viewAttachmentProps() {
-        return this._attachmentsInfo.viewAttachmentProps.map((x) => {
-            return {
-                ...x,
-                attachedView: undefined,
-            };
-        });
+        return this._viewAttachments.attachmentProps;
     }
     /** Strictly for testing. @internal */
     get viewAttachmentInfos() {
-        return this._attachmentsInfo.attachments;
+        return this._viewAttachments.attachmentInfos;
     }
     /** Strictly for testing. @internal */
     get attachments() {
-        return this._attachments?.attachments;
+        return this._viewAttachments.attachments;
     }
     isDrawingView() { return false; }
     isSheetView() { return true; }
@@ -340,41 +146,53 @@ class SheetViewState extends ViewState_1.ViewState2d {
         if (categories instanceof SheetViewState) {
             // we are coming from clone...
             this.sheetSize = categories.sheetSize.clone();
-            this._attachmentsInfo = categories._attachmentsInfo.clone(iModel);
+            this._viewAttachments = categories._viewAttachments.clone(iModel);
             this._viewedExtents = categories._viewedExtents.clone();
         }
         else {
             this.sheetSize = core_geometry_1.Point2d.create(sheetProps.width, sheetProps.height);
-            this._attachmentsInfo = ViewAttachmentsInfo.fromJSON(attachments);
+            this._viewAttachments = SheetViewAttachments_1.SheetViewAttachments.create(attachments);
             const extents = new core_geometry_1.Range3d(0, 0, 0, this.sheetSize.x, this.sheetSize.y, 0);
             const margin = 1.1;
             extents.scaleAboutCenterInPlace(margin);
             this._viewedExtents = extents;
         }
+        if (iModel.isBriefcaseConnection()) {
+            iModel.txns.onElementsChanged.addListener(async (changes) => {
+                let reload = false;
+                for (const change of changes.filter({ includeMetadata: (meta) => meta.is("BisCore:ViewAttachment") })) {
+                    if (change.type === "inserted" || this._viewAttachments.attachmentIds.includes(change.id)) {
+                        reload = true;
+                        break;
+                    }
+                }
+                if (reload) {
+                    await this._viewAttachments.reload(this.baseModelId, iModel);
+                    this._onViewAttachmentsReloaded();
+                    this.onViewAttachmentsReloaded.raiseEvent();
+                }
+            });
+        }
     }
     getOrigin() {
         const origin = super.getOrigin();
-        if (this._attachments)
-            origin.z = -this._attachments.maxDepth;
+        origin.z = -this._viewAttachments.maxDepth;
         return origin;
     }
     getExtents() {
         const extents = super.getExtents();
-        if (this._attachments)
-            extents.z = this._attachments.maxDepth + Frustum2d_1.Frustum2d.minimumZDistance;
+        extents.z = this._viewAttachments.maxDepth + Frustum2d_1.Frustum2d.minimumZDistance;
         return extents;
     }
     /** Overrides [[ViewState.discloseTileTrees]] to include tile trees associated with [ViewAttachment]($backend)s displayed on this sheet. */
     discloseTileTrees(trees) {
         super.discloseTileTrees(trees);
-        if (this._attachments)
-            trees.disclose(this._attachments);
+        trees.disclose(this._viewAttachments);
     }
     /** @internal */
     collectNonTileTreeStatistics(stats) {
         super.collectNonTileTreeStatistics(stats);
-        if (this._attachments)
-            this._attachments.collectStatistics(stats);
+        this._viewAttachments.collectStatistics(stats);
     }
     get defaultExtentLimits() {
         return { min: core_geometry_1.Constant.oneMillimeter, max: this.sheetSize.magnitude() * 10 };
@@ -385,36 +203,23 @@ class SheetViewState extends ViewState_1.ViewState2d {
     /** @internal */
     preload(hydrateRequest) {
         super.preload(hydrateRequest);
-        this._attachmentsInfo.preload(hydrateRequest);
+        this._viewAttachments.preload(hydrateRequest);
     }
     /** @internal */
     async postload(hydrateResponse) {
         const promises = [];
         promises.push(super.postload(hydrateResponse));
-        promises.push(this._attachmentsInfo.postload(hydrateResponse, this.iModel));
+        promises.push(this._viewAttachments.postload(hydrateResponse, this.iModel));
         await Promise.all(promises);
     }
     /** @internal */
     createScene(context) {
         super.createScene(context);
-        if (this._attachments)
-            this._attachments.addToScene(context);
+        this._viewAttachments.addToScene(context);
     }
     /** @internal */
     get secondaryViewports() {
-        if (this._attachments === undefined)
-            return super.secondaryViewports;
-        const attachments = this._attachments;
-        function* iterator() {
-            for (const attachment of attachments) {
-                const vp = attachment.viewport;
-                if (vp)
-                    yield vp;
-            }
-        }
-        return {
-            [Symbol.iterator]: () => iterator(),
-        };
+        return this._viewAttachments.getSecondaryViewports();
     }
     /** @internal */
     async queryAttachmentIds() {
@@ -427,34 +232,38 @@ class SheetViewState extends ViewState_1.ViewState2d {
     async changeViewedModel(modelId) {
         await super.changeViewedModel(modelId);
         const attachmentIds = await this.queryAttachmentIds();
-        this._attachmentsInfo = ViewAttachmentsInfo.fromJSON(attachmentIds);
-        (0, core_bentley_1.assert)(undefined === this._attachments);
+        (0, core_bentley_1.dispose)(this._viewAttachments);
+        this._viewAttachments = SheetViewAttachments_1.SheetViewAttachments.create(attachmentIds);
     }
     /** See [[ViewState.attachToViewport]]. */
     attachToViewport(args) {
         super.attachToViewport(args);
-        (0, core_bentley_1.assert)(undefined === this._attachments);
-        this._attachments = this._attachmentsInfo.createAttachments(this);
+        this._viewAttachments.attachToViewport({
+            backgroundColor: this.displayStyle.backgroundColor,
+            sheetModelId: this.baseModelId,
+        });
+        this._onViewAttachmentsReloaded = () => args.invalidateController();
     }
     /** See [[ViewState.detachFromViewport]]. */
     detachFromViewport() {
         super.detachFromViewport();
-        this._attachments = (0, core_bentley_1.dispose)(this._attachments);
+        this._viewAttachments.detachFromViewport();
+        this._onViewAttachmentsReloaded = () => undefined;
     }
     get areAllTileTreesLoaded() {
+        if (!super.areAllTileTreesLoaded) {
+            return false;
+        }
         let displayedExtents = this._viewedExtents;
         const frustum = this.calculateFrustum();
         if (frustum) {
             displayedExtents = frustum.toRange();
         }
-        return super.areAllTileTreesLoaded && (!this._attachments || this._attachments.areAllTileTreesLoaded(displayedExtents));
+        return this._viewAttachments.areAllTileTreesLoaded(displayedExtents);
     }
     /** @internal Strictly for testing */
     areAllAttachmentsLoaded() {
-        if (this._attachments) {
-            return this._attachments.areAllAttachmentsLoaded();
-        }
-        return true;
+        return this._viewAttachments.areAllAttachmentsLoaded();
     }
     /** Create a sheet border decoration graphic. */
     createBorder(width, height, context) {
@@ -479,454 +288,14 @@ class SheetViewState extends ViewState_1.ViewState2d {
     }
     /** @internal */
     getAttachmentViewport(args) {
-        const attachment = args.viewAttachmentId ? this._attachments?.findById(args.viewAttachmentId) : undefined;
-        if (!attachment) {
-            return undefined;
-        }
-        return args.inSectionDrawingAttachment ? attachment.viewport?.view.getAttachmentViewport({ inSectionDrawingAttachment: true }) : attachment.viewport;
+        return this._viewAttachments.getAttachmentViewport(args);
     }
     /** @beta */
     computeDisplayTransform(args) {
         // ###TODO we're currently ignoring model and element Id in args, assuming irrelevant for sheets.
         // Should probably call super or have super call us.
-        const attachment = undefined !== args.viewAttachmentId ? this._attachments?.findById(args.viewAttachmentId) : undefined;
-        if (!attachment || !(attachment instanceof OrthographicAttachment)) {
-            return undefined;
-        }
-        const sheetTransform = attachment.toSheet;
-        const sectionTransform = args.inSectionDrawingAttachment ? attachment.view.computeDisplayTransform(args) : undefined;
-        if (!sectionTransform) {
-            return sheetTransform.clone(args.output);
-        }
-        return sheetTransform.multiplyTransformTransform(sectionTransform, args.output);
+        return this._viewAttachments.computeDisplayTransform(args);
     }
 }
 exports.SheetViewState = SheetViewState;
-/** A mostly no-op RenderTarget for an Attachment.
- * its Scene and symbology overrides.
- */
-class AttachmentTarget extends MockRender_1.MockRender.OffScreenTarget {
-    _attachment;
-    constructor(attachment) {
-        // The dimensions don't matter - we're not drawing anything.
-        const rect = new ViewRect_1.ViewRect(1, 1);
-        super(IModelApp_1.IModelApp.renderSystem, rect);
-        this._attachment = attachment;
-    }
-    changeScene(scene) {
-        this._attachment.scene = scene;
-    }
-    overrideFeatureSymbology(ovrs) {
-        this._attachment.symbologyOverrides = ovrs;
-    }
-}
-/** Draws the contents a 2d or orthographic 3d view directly into a sheet view.
- * We select tiles for the view in the context of a light-weight offscreen viewport with a no-op RenderTarget, then
- * collect the resultant graphics and add them to the sheet view's scene.
- */
-class OrthographicAttachment {
-    _viewport;
-    _props;
-    _sheetModelId;
-    _viewFlagOverrides;
-    _toSheet;
-    _fromSheet;
-    _sizeInMeters;
-    _range;
-    _viewRect = new ViewRect_1.ViewRect(0, 0, 1, 1);
-    _originalFrustum = new core_common_1.Frustum();
-    _clipVolume;
-    _hiddenLineSettings;
-    _scale;
-    _debugFeatureTable;
-    scene;
-    symbologyOverrides;
-    zDepth;
-    get view() {
-        return this._viewport.view;
-    }
-    get viewAttachmentProps() {
-        return this._props;
-    }
-    get viewport() {
-        return this._viewport;
-    }
-    constructor(view, props, sheetView) {
-        this.symbologyOverrides = new FeatureSymbology_1.FeatureSymbology.Overrides(view);
-        const target = new AttachmentTarget(this);
-        this._viewport = Viewport_1.OffScreenViewport.createViewport(view, target, true);
-        this._props = props;
-        this._sheetModelId = sheetView.baseModelId;
-        const applyClip = true; // set to false for debugging
-        this._viewFlagOverrides = {
-            ...view.viewFlags,
-            clipVolume: applyClip,
-            lighting: false,
-            shadows: false,
-        };
-        const placement = core_common_1.Placement2d.fromJSON(props.placement);
-        const range = placement.calculateRange();
-        this._range = range;
-        this._sizeInMeters = new core_geometry_1.Point2d(range.xLength(), range.yLength());
-        // Compute transform from attached view's world coordinates to sheet's world coordinates.
-        // NB: We obtain the extents and origin from the *viewport* not the *view* - they may have been adjusted by the viewport.
-        const applySkew = true; // set to false for debugging
-        const skew = applySkew ? view.getAspectRatioSkew() : 1;
-        const extents = this._viewport.viewingSpace.viewDelta.clone();
-        const zDepth = Math.abs(extents.z);
-        const scaleX = this._sizeInMeters.x / Math.abs(extents.x);
-        const scaleY = skew * this._sizeInMeters.y / Math.abs(extents.y);
-        this._scale = { x: 1 / scaleX, y: 1 / scaleY };
-        const zBias = Frustum2d_1.Frustum2d.depthFromDisplayPriority(props.jsonProperties?.displayPriority ?? 0);
-        this.zDepth = 1.01 * (zDepth - zBias); // give a little padding so that geometry right up against far plane doesn't get clipped.
-        // View origin is at the *back* of the view. Align *front* of view based on display priority.
-        const viewRot = view.getRotation();
-        const viewOrg = viewRot.multiplyVector(this._viewport.viewingSpace.viewOrigin);
-        viewOrg.z += zDepth;
-        viewRot.multiplyTransposeVectorInPlace(viewOrg);
-        const matrix = core_geometry_1.Matrix3d.createScale(scaleX, scaleY, 1);
-        matrix.multiplyMatrixMatrix(viewRot, matrix);
-        const origin = core_geometry_1.Matrix3d.xyzMinusMatrixTimesXYZ(viewOrg, matrix, viewOrg);
-        const attachmentOrigin = core_geometry_1.Point3d.createFrom(placement.origin);
-        attachmentOrigin.z = zBias;
-        const viewOrgToAttachment = attachmentOrigin.minus(viewOrg);
-        origin.addInPlace(viewOrgToAttachment);
-        this._toSheet = core_geometry_1.Transform.createRefs(origin, matrix);
-        this._fromSheet = (0, core_bentley_1.expectDefined)(this._toSheet.inverse());
-        // If the attached view is a section drawing, it may itself have an attached spatial view with a clip.
-        // The clip needs to be transformed into sheet space.
-        if (view.isDrawingView())
-            this._viewport.drawingToSheetTransform = this._toSheet;
-        // ###TODO? If we also apply the attachment's clip to the attached view, we may get additional culling during tile selection.
-        // However the attached view's frustum is already clipped by intersection with sheet view's frustum, and additional clipping planes
-        // introduce additional computation, so possibly not worth it.
-        // Transform the view's clip (if any) to sheet space
-        let viewClip = view.viewFlags.clipVolume ? view.getViewClip()?.clone() : undefined;
-        if (viewClip)
-            viewClip.transformInPlace(this._toSheet);
-        else
-            viewClip = core_geometry_1.ClipVector.createEmpty();
-        let sheetClip;
-        if (undefined !== props.jsonProperties?.clip)
-            sheetClip = core_geometry_1.ClipVector.fromJSON(props.jsonProperties?.clip);
-        if (sheetClip && sheetClip.isValid) {
-            // Clip to view attachment's clip. NB: clip is in sheet coordinate space.
-            for (const clip of sheetClip.clips)
-                viewClip.clips.push(clip);
-        }
-        else {
-            // Clip to view attachment's bounding box
-            viewClip.appendShape([
-                core_geometry_1.Point3d.create(this._range.low.x, this._range.low.y),
-                core_geometry_1.Point3d.create(this._range.high.x, this._range.low.y),
-                core_geometry_1.Point3d.create(this._range.high.x, this._range.high.y),
-                core_geometry_1.Point3d.create(this._range.low.x, this._range.high.y),
-            ]);
-        }
-        this._clipVolume = IModelApp_1.IModelApp.renderSystem.createClipVolume(viewClip);
-        // Save off the original frustum (potentially adjusted by viewport).
-        this._viewport.setupFromView();
-        this._viewport.viewingSpace.getFrustum(CoordSystem_1.CoordSystem.World, true, this._originalFrustum);
-        const applyHiddenLineSettings = true; // for debugging edge display, set to false...
-        const style = view.displayStyle;
-        if (style.is3d() && applyHiddenLineSettings)
-            this._hiddenLineSettings = style.settings.hiddenLineSettings;
-    }
-    [Symbol.dispose]() {
-        this._viewport[Symbol.dispose]();
-    }
-    discloseTileTrees(trees) {
-        trees.disclose(this._viewport);
-    }
-    addToScene(context) {
-        if (context.viewport.freezeScene)
-            return;
-        if (!context.viewport.view.viewsCategory(this._props.category))
-            return;
-        const wantBounds = context.viewport.wantViewAttachmentBoundaries;
-        const wantClipShapes = context.viewport.wantViewAttachmentClipShapes;
-        if (wantBounds || wantClipShapes) {
-            const builder = context.createSceneGraphicBuilder();
-            if (wantBounds) {
-                builder.setSymbology(core_common_1.ColorDef.red, core_common_1.ColorDef.red, 2);
-                builder.addRangeBox(this._range);
-            }
-            if (wantClipShapes && this._clipVolume) {
-                builder.setSymbology(core_common_1.ColorDef.blue, core_common_1.ColorDef.blue, 2);
-                for (const prim of this._clipVolume.clipVector.clips) {
-                    if (!(prim instanceof core_geometry_1.ClipShape))
-                        continue; // ###TODO handle non-shape primitives, if any such ever encountered
-                    const pts = [];
-                    const tf = prim.transformFromClip;
-                    for (const pt of prim.polygon) {
-                        const tfPt = tf ? tf.multiplyPoint3d(pt) : pt;
-                        pts.push(new core_geometry_1.Point2d(tfPt.x, tfPt.y));
-                    }
-                    builder.addLineString2d(pts, 0);
-                }
-            }
-            // Put into a Batch so that we can see tooltip with attachment Id on mouseover.
-            const batch = context.target.renderSystem.createBatch(builder.finish(), this.getDebugFeatureTable(), this._range);
-            context.outputGraphic(batch);
-        }
-        if (!context.viewport.wantViewAttachments)
-            return;
-        // Pixel size used to compute size of ViewRect so that tiles of appropriate LOD are selected.
-        const pixelSize = context.viewport.getPixelSizeAtPoint();
-        if (0 === pixelSize)
-            return;
-        // Adjust attached view frustum based on intersection with sheet view frustum.
-        const attachFrustum = this._originalFrustum.transformBy(this._toSheet);
-        const attachFrustumRange = attachFrustum.toRange();
-        const sheetFrustum = context.viewport.getWorldFrustum();
-        const sheetFrustumRange = sheetFrustum.toRange();
-        const intersect = attachFrustumRange.intersect(sheetFrustumRange);
-        if (intersect.isNull)
-            return;
-        attachFrustum.initFromRange(intersect);
-        attachFrustum.transformBy(this._fromSheet, attachFrustum);
-        this._viewport.setupViewFromFrustum(attachFrustum);
-        // Adjust view rect based on size of attachment on screen so that tiles of appropriate LOD are selected.
-        const width = this._sizeInMeters.x * intersect.xLength() / attachFrustumRange.xLength();
-        const height = this._sizeInMeters.y * intersect.yLength() / attachFrustumRange.yLength();
-        this._viewRect.width = Math.max(1, Math.round(width / pixelSize));
-        this._viewRect.height = Math.max(1, Math.round(height / pixelSize));
-        this._viewport.setRect(this._viewRect);
-        // Propagate settings from on-screen viewport.
-        this._viewport.debugBoundingBoxes = context.viewport.debugBoundingBoxes;
-        this._viewport.setTileSizeModifier(context.viewport.tileSizeModifier);
-        // Create the scene.
-        this._viewport.renderFrame();
-        const scene = this.scene;
-        if (!scene)
-            return;
-        // Extract scene graphics and insert into on-screen scene context.
-        const options = {
-            viewAttachmentId: this._props.id,
-            clipVolume: this._clipVolume,
-            hline: this._hiddenLineSettings,
-            frustum: {
-                is3d: this.view.is3d(),
-                scale: this._scale,
-            },
-        };
-        const outputGraphics = (source) => {
-            if (0 === source.length)
-                return;
-            const graphics = new GraphicBranch_1.GraphicBranch();
-            graphics.setViewFlagOverrides(this._viewFlagOverrides);
-            graphics.symbologyOverrides = this.symbologyOverrides;
-            for (const graphic of source)
-                graphics.entries.push(graphic);
-            const branch = context.createGraphicBranch(graphics, this._toSheet, options);
-            context.outputGraphic(branch);
-        };
-        outputGraphics(scene.foreground);
-        context.withGraphicType(internal_1.TileGraphicType.BackgroundMap, () => outputGraphics(scene.background));
-        context.withGraphicType(internal_1.TileGraphicType.Overlay, () => outputGraphics(scene.overlay));
-        // Report tile statistics to sheet view's viewport.
-        const tileAdmin = IModelApp_1.IModelApp.tileAdmin;
-        const selectedAndReady = tileAdmin.getTilesForUser(this._viewport);
-        const requested = tileAdmin.getRequestsForUser(this._viewport);
-        tileAdmin.addExternalTilesForUser(context.viewport, {
-            requested: requested?.size ?? 0,
-            selected: selectedAndReady?.selected.size ?? 0,
-            ready: selectedAndReady?.ready.size ?? 0,
-        });
-    }
-    getDebugFeatureTable() {
-        if (this._debugFeatureTable)
-            return this._debugFeatureTable;
-        const featureTable = new core_common_1.FeatureTable(1, this._sheetModelId);
-        featureTable.insert(new core_common_1.Feature(this._props.id));
-        this._debugFeatureTable = core_common_1.PackedFeatureTable.pack(featureTable);
-        return this._debugFeatureTable;
-    }
-    get areAllTileTreesLoaded() {
-        return this.view.areAllTileTreesLoaded;
-    }
-    collectStatistics(_stats) {
-        // Handled by discloseTileTrees()
-    }
-    get toSheet() {
-        return this._toSheet;
-    }
-}
-function createRasterAttachmentViewport(_view, _rect, _attachment) {
-    class RasterAttachmentViewport extends Viewport_1.OffScreenViewport {
-        _sceneContext;
-        _isSceneReady = false;
-        _attachment;
-        constructor(view, rect, attachment) {
-            super(IModelApp_1.IModelApp.renderSystem.createOffscreenTarget(rect));
-            this._attachment = attachment;
-            this._isAspectRatioLocked = true;
-            this.changeView(view);
-        }
-        createSceneContext() {
-            (0, core_bentley_1.assert)(!this._isSceneReady);
-            this._sceneContext = super.createSceneContext();
-            return this._sceneContext;
-        }
-        renderFrame() {
-            (0, core_bentley_1.assert)(!this._isSceneReady);
-            this.clearSceneContext();
-            super.renderFrame();
-            if (undefined !== this._sceneContext) {
-                this._isSceneReady = !this._sceneContext.hasMissingTiles && this.view.areAllTileTreesLoaded;
-                if (this._isSceneReady)
-                    this._attachment.produceGraphics(this._sceneContext);
-                this._sceneContext = undefined;
-            }
-        }
-        clearSceneContext() {
-            this._sceneContext = undefined;
-        }
-        addDecorations(_decorations) {
-            // ###TODO: skybox, ground plane, possibly grid. DecorateContext requires a ScreenViewport...
-        }
-    }
-    return new RasterAttachmentViewport(_view, _rect, _attachment);
-}
-/** Draws a 3d view with camera enabled into a sheet view by producing an image of the view's contents offscreen. */
-class RasterAttachment {
-    _props;
-    _placement;
-    _transform;
-    zDepth;
-    _viewport;
-    _graphics;
-    constructor(view, props, sheetView) {
-        // Render to a 2048x2048 view rect. Scale in Y to preserve aspect ratio.
-        const maxSize = 2048;
-        const rect = new ViewRect_1.ViewRect(0, 0, maxSize, maxSize);
-        const height = maxSize * view.getAspectRatio() * view.getAspectRatioSkew();
-        const skew = maxSize / height;
-        view.setAspectRatioSkew(skew);
-        if (true !== props.jsonProperties?.displayOptions?.preserveBackground) {
-            // Make background color 100% transparent so that Viewport.readImageBuffer() will discard transparent pixels.
-            const bgColor = sheetView.displayStyle.backgroundColor.withAlpha(0);
-            view.displayStyle.backgroundColor = bgColor;
-        }
-        this._viewport = createRasterAttachmentViewport(view, rect, this);
-        this._props = props;
-        this._placement = core_common_1.Placement2d.fromJSON(props.placement);
-        this._transform = this._placement.transform;
-        this.zDepth = Frustum2d_1.Frustum2d.depthFromDisplayPriority(props.jsonProperties?.displayPriority ?? 0);
-    }
-    [Symbol.dispose]() {
-        this._viewport?.[Symbol.dispose]();
-    }
-    get viewAttachmentProps() {
-        return this._props;
-    }
-    get viewport() {
-        return this._viewport;
-    }
-    get areAllTileTreesLoaded() {
-        return this._viewport?.areAllTileTreesLoaded ?? true;
-    }
-    addToScene(context) {
-        // ###TODO: check viewport.wantViewAttachmentClipShapes
-        if (!context.viewport.view.viewsCategory(this._props.category))
-            return;
-        if (context.viewport.wantViewAttachmentBoundaries) {
-            const builder = context.createSceneGraphicBuilder(this._transform);
-            builder.setSymbology(core_common_1.ColorDef.red, core_common_1.ColorDef.red, 2);
-            builder.addRangeBox(core_geometry_1.Range3d.createRange2d(this._placement.bbox));
-            context.outputGraphic(builder.finish());
-        }
-        if (!context.viewport.wantViewAttachments)
-            return;
-        if (this._graphics) {
-            context.outputGraphic(this._graphics);
-            return;
-        }
-        if (undefined === this._viewport)
-            return;
-        this._viewport.debugBoundingBoxes = context.viewport.debugBoundingBoxes;
-        this._viewport.setTileSizeModifier(context.viewport.tileSizeModifier);
-        this._viewport.renderFrame();
-        if (this._graphics)
-            context.outputGraphic(this._graphics);
-    }
-    discloseTileTrees(trees) {
-        if (this._viewport)
-            trees.disclose(this._viewport);
-    }
-    produceGraphics(context) {
-        (0, core_bentley_1.assert)(context.viewport === this._viewport);
-        this._graphics = this.createGraphics(this._viewport);
-        this._viewport = (0, core_bentley_1.dispose)(this._viewport);
-        if (undefined !== this._graphics)
-            context.outputGraphic(this._graphics);
-    }
-    createGraphics(vp) {
-        // Create a texture from the contents of the view.
-        const image = vp.readImageBuffer({ upsideDown: true });
-        if (undefined === image)
-            return undefined;
-        const debugImage = false; // set to true to open a window displaying the captured image.
-        if (debugImage) {
-            const url = (0, ImageUtil_1.imageBufferToPngDataUrl)(image, false);
-            if (url)
-                (0, ImageUtil_1.openImageDataUrlInNewWindow)(url, "Attachment");
-        }
-        const texture = IModelApp_1.IModelApp.renderSystem.createTexture({
-            image: { source: image, transparency: core_common_1.TextureTransparency.Opaque },
-        });
-        if (!texture)
-            return undefined;
-        // Create a material for the texture
-        const graphicParams = new core_common_1.GraphicParams();
-        graphicParams.material = IModelApp_1.IModelApp.renderSystem.createRenderMaterial({ textureMapping: { texture } });
-        // Apply the texture to a rectangular polyface.
-        const depth = this.zDepth;
-        const east = this._placement.bbox.low.x;
-        const west = this._placement.bbox.high.x;
-        const north = this._placement.bbox.low.y;
-        const south = this._placement.bbox.high.y;
-        const corners = [
-            core_geometry_1.Point3d.create(east, north, depth),
-            core_geometry_1.Point3d.create(west, north, depth),
-            core_geometry_1.Point3d.create(west, south, depth),
-            core_geometry_1.Point3d.create(east, south, depth),
-        ];
-        const params = [
-            core_geometry_1.Point2d.create(0, 0),
-            core_geometry_1.Point2d.create(1, 0),
-            core_geometry_1.Point2d.create(1, 1),
-            core_geometry_1.Point2d.create(0, 1),
-        ];
-        const strokeOptions = new core_geometry_1.StrokeOptions();
-        strokeOptions.needParams = strokeOptions.shouldTriangulate = true;
-        const polyfaceBuilder = core_geometry_1.PolyfaceBuilder.create(strokeOptions);
-        polyfaceBuilder.addQuadFacet(corners, params);
-        const polyface = polyfaceBuilder.claimPolyface();
-        const graphicBuilder = IModelApp_1.IModelApp.renderSystem.createGraphicBuilder(core_geometry_1.Transform.createIdentity(), GraphicType_1.GraphicType.Scene, vp, this._props.id);
-        graphicBuilder.activateGraphicParams(graphicParams);
-        graphicBuilder.addPolyface(polyface, false);
-        const graphic = graphicBuilder.finish();
-        // Wrap the polyface in a GraphicBranch.
-        const branch = new GraphicBranch_1.GraphicBranch(true);
-        const vfOvrs = (0, internal_1.createDefaultViewFlagOverrides)({ clipVolume: true, shadows: false, lighting: false, thematic: false });
-        // Disable transparency - background pixels are 100% transparent so they will be discarded anyway. Other pixels are 100% opaque.
-        vfOvrs.transparency = false;
-        branch.setViewFlagOverrides(vfOvrs);
-        branch.symbologyOverrides = new FeatureSymbology_1.FeatureSymbology.Overrides();
-        branch.entries.push(graphic);
-        // Apply the attachment's clip, if any.
-        let clipVolume;
-        if (this._props.jsonProperties?.clip) {
-            const clipVector = core_geometry_1.ClipVector.fromJSON(this._props.jsonProperties?.clip);
-            if (clipVector.isValid)
-                clipVolume = IModelApp_1.IModelApp.renderSystem.createClipVolume(clipVector);
-        }
-        return IModelApp_1.IModelApp.renderSystem.createGraphicBranch(branch, this._transform, { clipVolume });
-    }
-    collectStatistics(stats) {
-        if (this._graphics)
-            this._graphics.collectStatistics(stats);
-    }
-}
 //# sourceMappingURL=SheetViewState.js.map