Add disableClipStyle to BranchState (backport #7109) [release/4.9.x]

common/api/core-frontend.api.md

@@ -4529,6 +4529,7 @@ export interface GraphicBranchOptions {
     // @internal (undocumented)
     classifierOrDrape?: RenderPlanarClassifier | RenderTextureDrape;
     clipVolume?: RenderClipVolume;
+    disableClipStyle?: true;
     // @internal (undocumented)
     frustum?: GraphicBranchFrustum;
     hline?: HiddenLine.Settings;
@@ -8925,6 +8926,8 @@ export interface RealityMeshGraphicParams {
     // (undocumented)
     readonly baseTransparent: boolean;
     // (undocumented)
+    readonly disableClipStyle?: true;
+    // (undocumented)
     readonly featureTable: PackedFeatureTable;
     // (undocumented)
     readonly layerClassifiers?: MapLayerClassifiers;
@@ -9842,7 +9845,7 @@ export abstract class RenderSystem implements IDisposable {
     // @internal (undocumented)
     createBackgroundMapDrape(_drapedTree: TileTreeReference, _mapTree: MapTileTreeReference): RenderTextureDrape | undefined;
     abstract createBatch(graphic: RenderGraphic, features: RenderFeatureTable, range: ElementAlignedBox3d, options?: BatchOptions): RenderGraphic;
-    createBranch(branch: GraphicBranch, transform: Transform): RenderGraphic;
+    createBranch(branch: GraphicBranch, transform: Transform, options?: GraphicBranchOptions): RenderGraphic;
     createClipVolume(_clipVector: ClipVector): RenderClipVolume | undefined;
     abstract createGraphic(options: CustomGraphicBuilderOptions | ViewportGraphicBuilderOptions): GraphicBuilder;
     abstract createGraphicBranch(branch: GraphicBranch, transform: Transform, options?: GraphicBranchOptions): RenderGraphic;

common/changes/@itwin/core-frontend/andremig-clipstyle-bug_2024-08-26-17-00.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/core-frontend",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/core-frontend"
+}

core/frontend/src/render/GraphicBranch.ts

@@ -155,6 +155,10 @@ export interface GraphicBranchOptions {
    * @internal
    */
   viewAttachmentId?: Id64String;
+  /** If true, the view's [DisplayStyleSettings.clipStyle]($common) will be disabled for this branch.
+   * No [ClipStyle.insideColor]($common), [ClipStyle.outsideColor]($common), or [ClipStyle.intersectionStyle]($common) will be applied.
+   */
+  disableClipStyle?: true;
 }
 
 /** Clip/Transform for a branch that are varied over time.

core/frontend/src/render/RealityMeshGraphicParams.ts

@@ -21,4 +21,5 @@ export interface RealityMeshGraphicParams {
   readonly baseTransparent: boolean;
   readonly textures?: TerrainTexture[];
   readonly layerClassifiers?: MapLayerClassifiers;
+  readonly disableClipStyle?: true;
 }

core/frontend/src/render/RenderSystem.ts

@@ -537,8 +537,8 @@ export abstract class RenderSystem implements IDisposable {
   public abstract createGraphicList(primitives: RenderGraphic[]): RenderGraphic;
 
   /** Create a RenderGraphic consisting of a list of Graphics, with optional transform and symbology overrides applied to the list */
-  public createBranch(branch: GraphicBranch, transform: Transform): RenderGraphic {
-    return this.createGraphicBranch(branch, transform);
+  public createBranch(branch: GraphicBranch, transform: Transform, options?: GraphicBranchOptions): RenderGraphic {
+    return this.createGraphicBranch(branch, transform, options);
   }
 
   /** Create a graphic from a [[GraphicBranch]]. */

core/frontend/src/render/webgl/BranchState.ts

@@ -45,6 +45,10 @@ export interface BranchStateOptions {
   forceViewCoords?: boolean;
   readonly viewAttachmentId?: Id64String;
   groupNodeId?: number;
+  /** If true, the view's [DisplayStyleSettings.clipStyle]($common) will be disabled for this branch.
+   * No [ClipStyle.insideColor]($common), [ClipStyle.outsideColor]($common), or [ClipStyle.intersectionStyle]($common) will be applied.
+   */
+  disableClipStyle?: true;
 }
 
 /**
@@ -71,6 +75,7 @@ export class BranchState {
   public get realityModelDisplaySettings() { return this._opts.realityModelDisplaySettings; }
   public get viewAttachmentId() { return this._opts.viewAttachmentId; }
   public get groupNodeId() { return this._opts.groupNodeId; }
+  public get disableClipStyle() { return this._opts.disableClipStyle;}
 
   public get symbologyOverrides() {
     return this._opts.symbologyOverrides;
@@ -105,6 +110,7 @@ export class BranchState {
       realityModelDisplaySettings: branch.branch.realityModelDisplaySettings ?? prev.realityModelDisplaySettings,
       viewAttachmentId: branch.viewAttachmentId ?? prev.viewAttachmentId,
       groupNodeId: branch.branch.groupNodeId ?? prev.groupNodeId,
+      disableClipStyle: branch.disableClipStyle ?? prev.disableClipStyle,
     });
   }
 

core/frontend/src/render/webgl/BranchUniforms.ts

@@ -21,6 +21,7 @@ import { RenderCommands } from "./RenderCommands";
 import { desync, sync, SyncToken } from "./Sync";
 import { Target } from "./Target";
 import { ClipStack } from "./ClipStack";
+import { IModelApp } from "../../IModelApp";
 
 function equalXYZs(a: XYZ | undefined, b: XYZ | undefined): boolean {
   if (a === b)
@@ -103,6 +104,9 @@ export class BranchUniforms {
   public pushBranch(branch: Branch): void {
     desync(this);
     this._stack.pushBranch(branch);
+
+    this.setClipStyle(this.top.disableClipStyle);
+
     if (this.top.clipVolume)
       this.clipStack.push(this.top.clipVolume);
 
@@ -126,6 +130,7 @@ export class BranchUniforms {
       this.clipStack.pop();
 
     this._stack.pop();
+    this.setClipStyle(this.top.disableClipStyle);
   }
 
   public pushViewClip(): void {
@@ -251,4 +256,15 @@ export class BranchUniforms {
 
     return true;
   }
+
+  // set the clip style based on disableClipStyle
+  private setClipStyle(disableClipStyle: true | undefined) {
+    const vp = IModelApp.viewManager.selectedView;
+    if (vp) {
+      const style = vp.view.displayStyle.settings.clipStyle;
+      this.clipStack.insideColor.alpha = disableClipStyle ? 0 : (style.insideColor ? 1 : 0);
+      this.clipStack.outsideColor.alpha = disableClipStyle ? 0 : (style.outsideColor ? 1 : 0);
+      this.clipStack.intersectionStyle.alpha = disableClipStyle ? 0 : (style.intersectionStyle ? style.intersectionStyle.width : 0);
+    }
+  }
 }

core/frontend/src/render/webgl/Graphic.ts

@@ -311,6 +311,7 @@ export class Branch extends Graphic {
   public readonly appearanceProvider?: FeatureAppearanceProvider;
   public readonly secondaryClassifiers?: PlanarClassifier[];
   public readonly viewAttachmentId?: Id64String;
+  public disableClipStyle?: true;
 
   public constructor(branch: GraphicBranch, localToWorld: Transform, viewFlags?: ViewFlags, opts?: GraphicBranchOptions) {
     super();
@@ -328,6 +329,7 @@ export class Branch extends Graphic {
     this.iModel = opts.iModel;
     this.frustum = opts.frustum;
     this.viewAttachmentId = opts.viewAttachmentId;
+    this.disableClipStyle = opts.disableClipStyle;
 
     if (opts.hline)
       this.edgeSettings = EdgeSettings.create(opts.hline);

core/frontend/src/render/webgl/RealityMesh.ts

@@ -376,7 +376,7 @@ export class RealityMeshGeometry extends IndexedGeometry implements IDisposable,
       branch.add(system.createBatch(primitive!, featureTable, mesh.getRange(), { tileId }));
     }
 
-    return system.createBranch(branch, realityMesh._transform ? realityMesh._transform : Transform.createIdentity());
+    return system.createBranch(branch, realityMesh._transform ? realityMesh._transform : Transform.createIdentity(), {disableClipStyle: params.disableClipStyle});
   }
 
   public collectStatistics(stats: RenderMemory.Statistics): void {