@itwin/frontend-devtools 3.0.0-dev.72

package/lib/tools/ModelAppearanceTools.d.ts

@@ -0,0 +1,87 @@
+/** @packageDocumentation
+ * @module Tools
+ */
+import { LinePixels, RgbColorProps } from "@itwin/core-common";
+import { Tool } from "@itwin/core-frontend";
+/** Set model appearance override for transparency in display style.
+ * @beta
+ */
+export declare class SetModelTransparencyTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(transparency: number, name: string): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Set model appearance override for line weight in display style.
+ * @beta
+ */
+export declare class SetModelLineWeightTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(weight: number, name: string): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Set model appearance override for line code in display style.
+ * @beta
+ */
+export declare class SetModelLineCodeTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    static linePixels: LinePixels[];
+    run(lineCode: number, name: string): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Set model appearance override for nonLocatable in display style.
+ * @beta
+ */
+export declare class SetModelLocateTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(locate: boolean, name: string): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Set model appearance override for emphasized in display style.
+ * @beta
+ */
+export declare class SetModelEmphasizedTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(emphasized: true | undefined, name: string): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Set model appearance override for ignoreMaterials in display style.
+ * @beta
+ */
+export declare class SetModelIgnoresMaterialsTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(ignoresMaterial: true | undefined, name: string): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** Set model appearance override for color in display style.
+ * @beta
+ */
+export declare class SetModelColorTool extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(rgb: RgbColorProps, name: string): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+/** clear model appearance overrides in display style.
+ * @beta
+ */
+export declare class ClearModelAppearanceOverrides extends Tool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    run(name?: string): Promise<boolean>;
+    parseAndRun(...args: string[]): Promise<boolean>;
+}
+//# sourceMappingURL=ModelAppearanceTools.d.ts.map

package/lib/tools/ModelAppearanceTools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModelAppearanceTools.d.ts","sourceRoot":"","sources":["../../src/tools/ModelAppearanceTools.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAA6C,UAAU,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC1G,OAAO,EAA4E,IAAI,EAAY,MAAM,sBAAsB,CAAC;AAqBhI;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,IAAI;IAChD,OAAuB,MAAM,SAA8B;IAC3D,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IASzD,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAGvE;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,IAAI;IAC9C,OAAuB,MAAM,SAA4B;IACzD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IASnD,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAGvE;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,IAAI;IAC5C,OAAuB,MAAM,SAA0B;IACvD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAClD,OAAc,UAAU,eAAoJ;IAEtJ,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAYrD,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAGvE;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,IAAI;IAC1C,OAAuB,MAAM,SAAwB;IACrD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAUpD,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAIvE;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,IAAI;IAC9C,OAAuB,MAAM,SAA4B;IACzD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,UAAU,EAAE,IAAI,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IASjE,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAIvE;AAED;;GAEG;AACH,qBAAa,4BAA6B,SAAQ,IAAI;IACpD,OAAuB,MAAM,SAAkC;IAC/D,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,eAAe,EAAE,IAAI,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAStE,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAIvE;AAED;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,IAAI;IACzC,OAAuB,MAAM,SAAuB;IACpD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,GAAG,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IASvD,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAGvE;AAED;;GAEG;AACH,qBAAa,6BAA8B,SAAQ,IAAI;IACrD,OAAuB,MAAM,SAAmC;IAChE,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAE5B,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAYpC,WAAW,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAGvE"}

package/lib/tools/ModelAppearanceTools.js

@@ -0,0 +1,184 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClearModelAppearanceOverrides = exports.SetModelColorTool = exports.SetModelIgnoresMaterialsTool = exports.SetModelEmphasizedTool = exports.SetModelLocateTool = exports.SetModelLineCodeTool = exports.SetModelLineWeightTool = exports.SetModelTransparencyTool = void 0;
+/** @packageDocumentation
+ * @module Tools
+ */
+const core_common_1 = require("@itwin/core-common");
+const core_frontend_1 = require("@itwin/core-frontend");
+const parseBoolean_1 = require("./parseBoolean");
+function changeModelAppearanceOverrides(vp, overrides, name) {
+    let changed = false;
+    if (vp !== undefined && vp.view instanceof core_frontend_1.SpatialViewState)
+        vp.view.forEachModel((model) => {
+            if (name === undefined || model.name === name) {
+                changed = true;
+                const existingOverrides = vp.displayStyle.settings.getModelAppearanceOverride(model.id);
+                vp.overrideModelAppearance(model.id, existingOverrides ? existingOverrides.clone(overrides) : core_common_1.FeatureAppearance.fromJSON(overrides));
+            }
+        });
+    return changed;
+}
+function modelChangedString(name) {
+    return name === undefined ? `All Models` : `Model: ${name}`;
+}
+/** Set model appearance override for transparency in display style.
+ * @beta
+ */
+class SetModelTransparencyTool extends core_frontend_1.Tool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 2; }
+    async run(transparency, name) {
+        const changed = changeModelAppearanceOverrides(core_frontend_1.IModelApp.viewManager.selectedView, { transparency }, name);
+        if (changed)
+            core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Info, `${modelChangedString(name)} set to transparency: ${transparency}`));
+        return changed;
+    }
+    async parseAndRun(...args) {
+        return this.run(parseFloat(args[0]), args[1]);
+    }
+}
+exports.SetModelTransparencyTool = SetModelTransparencyTool;
+SetModelTransparencyTool.toolId = "SetModelTransparencyTool";
+/** Set model appearance override for line weight in display style.
+ * @beta
+ */
+class SetModelLineWeightTool extends core_frontend_1.Tool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 2; }
+    async run(weight, name) {
+        const changed = changeModelAppearanceOverrides(core_frontend_1.IModelApp.viewManager.selectedView, { weight }, name);
+        if (changed)
+            core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Info, `${modelChangedString(name)} set to line weight: ${weight}`));
+        return changed;
+    }
+    async parseAndRun(...args) {
+        return this.run(parseFloat(args[0]), args[1]);
+    }
+}
+exports.SetModelLineWeightTool = SetModelLineWeightTool;
+SetModelLineWeightTool.toolId = "SetModelLineWeightTool";
+/** Set model appearance override for line code in display style.
+ * @beta
+ */
+class SetModelLineCodeTool extends core_frontend_1.Tool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 2; }
+    async run(lineCode, name) {
+        if (lineCode < 0 || lineCode >= SetModelLineCodeTool.linePixels.length)
+            return false;
+        const changed = changeModelAppearanceOverrides(core_frontend_1.IModelApp.viewManager.selectedView, { linePixels: SetModelLineCodeTool.linePixels[lineCode] }, name);
+        if (changed)
+            core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Info, `${modelChangedString(name)} set to line code: ${lineCode}`));
+        return changed;
+    }
+    async parseAndRun(...args) {
+        return this.run(parseFloat(args[0]), args[1]);
+    }
+}
+exports.SetModelLineCodeTool = SetModelLineCodeTool;
+SetModelLineCodeTool.toolId = "SetModelLineCodeTool";
+SetModelLineCodeTool.linePixels = [core_common_1.LinePixels.Code0, core_common_1.LinePixels.Code1, core_common_1.LinePixels.Code2, core_common_1.LinePixels.Code3, core_common_1.LinePixels.Code4, core_common_1.LinePixels.Code5, core_common_1.LinePixels.Code6, core_common_1.LinePixels.Code7];
+/** Set model appearance override for nonLocatable in display style.
+ * @beta
+ */
+class SetModelLocateTool extends core_frontend_1.Tool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 2; }
+    async run(locate, name) {
+        const nonLocatable = locate ? undefined : true;
+        const changed = changeModelAppearanceOverrides(core_frontend_1.IModelApp.viewManager.selectedView, { nonLocatable }, name);
+        if (changed)
+            core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Info, `${modelChangedString(name)} set to locate: ${locate}`));
+        return changed;
+    }
+    async parseAndRun(...args) {
+        const locate = (0, parseBoolean_1.parseBoolean)(args[0]);
+        return locate === undefined ? false : this.run(locate, args[1]);
+    }
+}
+exports.SetModelLocateTool = SetModelLocateTool;
+SetModelLocateTool.toolId = "SetModelLocateTool";
+/** Set model appearance override for emphasized in display style.
+ * @beta
+ */
+class SetModelEmphasizedTool extends core_frontend_1.Tool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 2; }
+    async run(emphasized, name) {
+        const changed = changeModelAppearanceOverrides(core_frontend_1.IModelApp.viewManager.selectedView, { emphasized }, name);
+        if (changed)
+            core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Info, `Mode: ${name} set to emphasized: ${emphasized}`));
+        return changed;
+    }
+    async parseAndRun(...args) {
+        const emphasized = (0, parseBoolean_1.parseBoolean)(args[0]);
+        return emphasized === undefined ? false : this.run(emphasized ? true : undefined, args[1]);
+    }
+}
+exports.SetModelEmphasizedTool = SetModelEmphasizedTool;
+SetModelEmphasizedTool.toolId = "SetModelEmphasizedTool";
+/** Set model appearance override for ignoreMaterials in display style.
+ * @beta
+ */
+class SetModelIgnoresMaterialsTool extends core_frontend_1.Tool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 2; }
+    async run(ignoresMaterial, name) {
+        const changed = changeModelAppearanceOverrides(core_frontend_1.IModelApp.viewManager.selectedView, { ignoresMaterial }, name);
+        if (changed)
+            core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Info, `Mode: ${name} set to ignore Materials: ${ignoresMaterial}`));
+        return changed;
+    }
+    async parseAndRun(...args) {
+        const ignoresMaterial = (0, parseBoolean_1.parseBoolean)(args[0]);
+        return ignoresMaterial === undefined ? false : this.run(ignoresMaterial ? true : undefined, args[1]);
+    }
+}
+exports.SetModelIgnoresMaterialsTool = SetModelIgnoresMaterialsTool;
+SetModelIgnoresMaterialsTool.toolId = "SetModelIgnoresMaterialsTool";
+/** Set model appearance override for color in display style.
+ * @beta
+ */
+class SetModelColorTool extends core_frontend_1.Tool {
+    static get minArgs() { return 3; }
+    static get maxArgs() { return 4; }
+    async run(rgb, name) {
+        const changed = changeModelAppearanceOverrides(core_frontend_1.IModelApp.viewManager.selectedView, { rgb }, name);
+        if (changed)
+            core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Info, `${modelChangedString(name)} set to RGB color: (${rgb.r}, ${rgb.g}, ${rgb.b})`));
+        return true;
+    }
+    async parseAndRun(...args) {
+        return this.run({ r: parseFloat(args[0]), g: parseFloat(args[1]), b: parseFloat(args[2]) }, args[3]);
+    }
+}
+exports.SetModelColorTool = SetModelColorTool;
+SetModelColorTool.toolId = "SetModelColorTool";
+/** clear model appearance overrides in display style.
+ * @beta
+ */
+class ClearModelAppearanceOverrides extends core_frontend_1.Tool {
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    async run(name) {
+        const vp = core_frontend_1.IModelApp.viewManager.selectedView;
+        if (vp !== undefined && vp.view instanceof core_frontend_1.SpatialViewState) {
+            vp.view.forEachModel((model) => {
+                if (name === undefined || model.name === name)
+                    vp.dropModelAppearanceOverride(model.id);
+            });
+        }
+        return true;
+    }
+    async parseAndRun(...args) {
+        return this.run(args[0]);
+    }
+}
+exports.ClearModelAppearanceOverrides = ClearModelAppearanceOverrides;
+ClearModelAppearanceOverrides.toolId = "ClearModelAppearanceOverrides";
+//# sourceMappingURL=ModelAppearanceTools.js.map

package/lib/tools/ModelAppearanceTools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModelAppearanceTools.js","sourceRoot":"","sources":["../../src/tools/ModelAppearanceTools.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,oDAA0G;AAC1G,wDAAgI;AAChI,iDAA8C;AAE9C,SAAS,8BAA8B,CAAC,EAAwB,EAAE,SAAiC,EAAE,IAAY;IAC/G,IAAI,OAAO,GAAG,KAAK,CAAC;IACpB,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,CAAC,IAAI,YAAY,gCAAgB;QACzD,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE,EAAE;YAC7B,IAAI,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE;gBAC7C,OAAO,GAAG,IAAI,CAAC;gBACf,MAAM,iBAAiB,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,0BAA0B,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACxF,EAAE,CAAC,uBAAuB,CAAC,KAAK,CAAC,EAAE,EAAE,iBAAiB,CAAC,CAAC,CAAC,iBAAiB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,+BAAiB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;aACtI;QACH,CAAC,CAAC,CAAC;IAEL,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAY;IACtC,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,UAAU,IAAI,EAAE,CAAC;AAC9D,CAAC;AAED;;GAEG;AACH,MAAa,wBAAyB,SAAQ,oBAAI;IAEzC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,YAAoB,EAAE,IAAY;QAC1D,MAAM,OAAO,GAAG,8BAA8B,CAAC,yBAAS,CAAC,WAAW,CAAC,YAAY,EAAE,EAAE,YAAY,EAAE,EAAE,IAAI,CAAC,CAAC;QAE3G,IAAI,OAAO;YACT,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,IAAI,EAAE,GAAG,kBAAkB,CAAC,IAAI,CAAC,yBAAyB,YAAY,EAAE,CAAC,CAAC,CAAC;QAElK,OAAO,OAAO,CAAC;IACjB,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,CAAC;;AAhBH,4DAiBC;AAhBwB,+BAAM,GAAG,0BAA0B,CAAC;AAkB7D;;GAEG;AACH,MAAa,sBAAuB,SAAQ,oBAAI;IAEvC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,MAAc,EAAE,IAAY;QACpD,MAAM,OAAO,GAAG,8BAA8B,CAAC,yBAAS,CAAC,WAAW,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,CAAC,CAAC;QAErG,IAAI,OAAO;YACT,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,IAAI,EAAE,GAAG,kBAAkB,CAAC,IAAI,CAAC,wBAAwB,MAAM,EAAE,CAAC,CAAC,CAAC;QAE3J,OAAO,OAAO,CAAC;IACjB,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,CAAC;;AAhBH,wDAiBC;AAhBwB,6BAAM,GAAG,wBAAwB,CAAC;AAkB3D;;GAEG;AACH,MAAa,oBAAqB,SAAQ,oBAAI;IAErC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAGlC,KAAK,CAAC,GAAG,CAAC,QAAgB,EAAE,IAAY;QACtD,IAAI,QAAQ,GAAG,CAAC,IAAI,QAAQ,IAAI,oBAAoB,CAAC,UAAU,CAAC,MAAM;YACpE,OAAO,KAAK,CAAC;QAEf,MAAM,OAAO,GAAG,8BAA8B,CAAC,yBAAS,CAAC,WAAW,CAAC,YAAY,EAAE,EAAE,UAAU,EAAE,oBAAoB,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAEpJ,IAAI,OAAO;YACT,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,IAAI,EAAE,GAAG,kBAAkB,CAAC,IAAI,CAAC,sBAAsB,QAAQ,EAAE,CAAC,CAAC,CAAC;QAE3J,OAAO,OAAO,CAAC;IACjB,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,CAAC;;AApBH,oDAqBC;AApBwB,2BAAM,GAAG,sBAAsB,CAAC;AAGzC,+BAAU,GAAG,CAAC,wBAAU,CAAC,KAAK,EAAE,wBAAU,CAAC,KAAK,EAAE,wBAAU,CAAC,KAAK,EAAE,wBAAU,CAAC,KAAK,EAAE,wBAAU,CAAC,KAAK,EAAE,wBAAU,CAAC,KAAK,EAAE,wBAAU,CAAC,KAAK,EAAE,wBAAU,CAAC,KAAK,CAAC,CAAC;AAmB9K;;GAEG;AACH,MAAa,kBAAmB,SAAQ,oBAAI;IAEnC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,MAAe,EAAE,IAAY;QACrD,MAAM,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;QAC/C,MAAM,OAAO,GAAG,8BAA8B,CAAC,yBAAS,CAAC,WAAW,CAAC,YAAY,EAAE,EAAE,YAAY,EAAE,EAAE,IAAI,CAAC,CAAC;QAE3G,IAAI,OAAO;YACT,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,IAAI,EAAE,GAAG,kBAAkB,CAAC,IAAI,CAAC,mBAAmB,MAAM,EAAE,CAAC,CAAC,CAAC;QAEtJ,OAAO,OAAO,CAAC;IACjB,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,MAAM,GAAG,IAAA,2BAAY,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAClE,CAAC;;AAlBH,gDAmBC;AAlBwB,yBAAM,GAAG,oBAAoB,CAAC;AAoBvD;;GAEG;AACH,MAAa,sBAAuB,SAAQ,oBAAI;IAEvC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,UAA4B,EAAE,IAAY;QAClE,MAAM,OAAO,GAAG,8BAA8B,CAAC,yBAAS,CAAC,WAAW,CAAC,YAAY,EAAE,EAAE,UAAU,EAAE,EAAE,IAAI,CAAC,CAAC;QAEzG,IAAI,OAAO;YACT,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,IAAI,EAAE,SAAS,IAAI,uBAAuB,UAAU,EAAE,CAAC,CAAC,CAAC;QAEhJ,OAAO,OAAO,CAAC;IACjB,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,UAAU,GAAG,IAAA,2BAAY,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,OAAO,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7F,CAAC;;AAjBH,wDAkBC;AAjBwB,6BAAM,GAAG,wBAAwB,CAAC;AAmB3D;;GAEG;AACH,MAAa,4BAA6B,SAAQ,oBAAI;IAE7C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,eAAiC,EAAE,IAAY;QACvE,MAAM,OAAO,GAAG,8BAA8B,CAAC,yBAAS,CAAC,WAAW,CAAC,YAAY,EAAE,EAAE,eAAe,EAAE,EAAE,IAAI,CAAC,CAAC;QAE9G,IAAI,OAAO;YACT,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,IAAI,EAAE,SAAS,IAAI,6BAA6B,eAAe,EAAE,CAAC,CAAC,CAAC;QAE3J,OAAO,OAAO,CAAC;IACjB,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,eAAe,GAAG,IAAA,2BAAY,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9C,OAAO,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACvG,CAAC;;AAjBH,oEAkBC;AAjBwB,mCAAM,GAAG,8BAA8B,CAAC;AAmBjE;;GAEG;AACH,MAAa,iBAAkB,SAAQ,oBAAI;IAElC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,GAAkB,EAAE,IAAY;QACxD,MAAM,OAAO,GAAG,8BAA8B,CAAC,yBAAS,CAAC,WAAW,CAAC,YAAY,EAAE,EAAE,GAAG,EAAE,EAAE,IAAI,CAAC,CAAC;QAElG,IAAI,OAAO;YACT,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,IAAI,EAAE,GAAG,kBAAkB,CAAC,IAAI,CAAC,uBAAuB,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAE9K,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACvG,CAAC;;AAhBH,8CAiBC;AAhBwB,wBAAM,GAAG,mBAAmB,CAAC;AAkBtD;;GAEG;AACH,MAAa,6BAA8B,SAAQ,oBAAI;IAE9C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,IAAa;QACrC,MAAM,EAAE,GAAG,yBAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,CAAC,IAAI,YAAY,gCAAgB,EAAE;YAC3D,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC7B,IAAI,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI;oBAC3C,EAAE,CAAC,2BAA2B,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC7C,CAAC,CAAC,CAAC;SACJ;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;;AAnBH,sEAoBC;AAnBwB,oCAAM,GAAG,+BAA+B,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\n/** @packageDocumentation\r\n * @module Tools\r\n */\r\n\r\nimport { FeatureAppearance, FeatureAppearanceProps, LinePixels, RgbColorProps } from \"@itwin/core-common\";\r\nimport { IModelApp, NotifyMessageDetails, OutputMessagePriority, SpatialViewState, Tool, Viewport } from \"@itwin/core-frontend\";\r\nimport { parseBoolean } from \"./parseBoolean\";\r\n\r\nfunction changeModelAppearanceOverrides(vp: Viewport | undefined, overrides: FeatureAppearanceProps, name: string): boolean {\r\n  let changed = false;\r\n  if (vp !== undefined && vp.view instanceof SpatialViewState)\r\n    vp.view.forEachModel((model) => {\r\n      if (name === undefined || model.name === name) {\r\n        changed = true;\r\n        const existingOverrides = vp.displayStyle.settings.getModelAppearanceOverride(model.id);\r\n        vp.overrideModelAppearance(model.id, existingOverrides ? existingOverrides.clone(overrides) : FeatureAppearance.fromJSON(overrides));\r\n      }\r\n    });\r\n\r\n  return changed;\r\n}\r\n\r\nfunction modelChangedString(name: string) {\r\n  return name === undefined ? `All Models` : `Model: ${name}`;\r\n}\r\n\r\n/** Set model appearance override for transparency in display style.\r\n * @beta\r\n */\r\nexport class SetModelTransparencyTool extends Tool {\r\n  public static override toolId = \"SetModelTransparencyTool\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 2; }\r\n\r\n  public override async run(transparency: number, name: string): Promise<boolean> {\r\n    const changed = changeModelAppearanceOverrides(IModelApp.viewManager.selectedView, { transparency }, name);\r\n\r\n    if (changed)\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, `${modelChangedString(name)} set to transparency: ${transparency}`));\r\n\r\n    return changed;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    return this.run(parseFloat(args[0]), args[1]);\r\n  }\r\n}\r\n\r\n/** Set model appearance override for line weight in display style.\r\n * @beta\r\n */\r\nexport class SetModelLineWeightTool extends Tool {\r\n  public static override toolId = \"SetModelLineWeightTool\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 2; }\r\n\r\n  public override async run(weight: number, name: string): Promise<boolean> {\r\n    const changed = changeModelAppearanceOverrides(IModelApp.viewManager.selectedView, { weight }, name);\r\n\r\n    if (changed)\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, `${modelChangedString(name)} set to line weight: ${weight}`));\r\n\r\n    return changed;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    return this.run(parseFloat(args[0]), args[1]);\r\n  }\r\n}\r\n\r\n/** Set model appearance override for line code in display style.\r\n * @beta\r\n */\r\nexport class SetModelLineCodeTool extends Tool {\r\n  public static override toolId = \"SetModelLineCodeTool\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 2; }\r\n  public static linePixels = [LinePixels.Code0, LinePixels.Code1, LinePixels.Code2, LinePixels.Code3, LinePixels.Code4, LinePixels.Code5, LinePixels.Code6, LinePixels.Code7];\r\n\r\n  public override async run(lineCode: number, name: string): Promise<boolean> {\r\n    if (lineCode < 0 || lineCode >= SetModelLineCodeTool.linePixels.length)\r\n      return false;\r\n\r\n    const changed = changeModelAppearanceOverrides(IModelApp.viewManager.selectedView, { linePixels: SetModelLineCodeTool.linePixels[lineCode] }, name);\r\n\r\n    if (changed)\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, `${modelChangedString(name)} set to line code: ${lineCode}`));\r\n\r\n    return changed;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    return this.run(parseFloat(args[0]), args[1]);\r\n  }\r\n}\r\n\r\n/** Set model appearance override for nonLocatable in display style.\r\n * @beta\r\n */\r\nexport class SetModelLocateTool extends Tool {\r\n  public static override toolId = \"SetModelLocateTool\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 2; }\r\n\r\n  public override async run(locate: boolean, name: string): Promise<boolean> {\r\n    const nonLocatable = locate ? undefined : true;\r\n    const changed = changeModelAppearanceOverrides(IModelApp.viewManager.selectedView, { nonLocatable }, name);\r\n\r\n    if (changed)\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, `${modelChangedString(name)} set to locate: ${locate}`));\r\n\r\n    return changed;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const locate = parseBoolean(args[0]);\r\n    return locate === undefined ? false : this.run(locate, args[1]);\r\n  }\r\n}\r\n\r\n/** Set model appearance override for emphasized in display style.\r\n * @beta\r\n */\r\nexport class SetModelEmphasizedTool extends Tool {\r\n  public static override toolId = \"SetModelEmphasizedTool\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 2; }\r\n\r\n  public override async run(emphasized: true | undefined, name: string): Promise<boolean> {\r\n    const changed = changeModelAppearanceOverrides(IModelApp.viewManager.selectedView, { emphasized }, name);\r\n\r\n    if (changed)\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, `Mode: ${name} set to emphasized: ${emphasized}`));\r\n\r\n    return changed;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const emphasized = parseBoolean(args[0]);\r\n    return emphasized === undefined ? false : this.run(emphasized ? true : undefined, args[1]);\r\n  }\r\n}\r\n\r\n/** Set model appearance override for ignoreMaterials in display style.\r\n * @beta\r\n */\r\nexport class SetModelIgnoresMaterialsTool extends Tool {\r\n  public static override toolId = \"SetModelIgnoresMaterialsTool\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 2; }\r\n\r\n  public override async run(ignoresMaterial: true | undefined, name: string): Promise<boolean> {\r\n    const changed = changeModelAppearanceOverrides(IModelApp.viewManager.selectedView, { ignoresMaterial }, name);\r\n\r\n    if (changed)\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, `Mode: ${name} set to ignore Materials: ${ignoresMaterial}`));\r\n\r\n    return changed;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const ignoresMaterial = parseBoolean(args[0]);\r\n    return ignoresMaterial === undefined ? false : this.run(ignoresMaterial ? true : undefined, args[1]);\r\n  }\r\n}\r\n\r\n/** Set model appearance override for color in display style.\r\n * @beta\r\n */\r\nexport class SetModelColorTool extends Tool {\r\n  public static override toolId = \"SetModelColorTool\";\r\n  public static override get minArgs() { return 3; }\r\n  public static override get maxArgs() { return 4; }\r\n\r\n  public override async run(rgb: RgbColorProps, name: string): Promise<boolean> {\r\n    const changed = changeModelAppearanceOverrides(IModelApp.viewManager.selectedView, { rgb }, name);\r\n\r\n    if (changed)\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, `${modelChangedString(name)} set to RGB color: (${rgb.r}, ${rgb.g}, ${rgb.b})`));\r\n\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    return this.run({ r: parseFloat(args[0]), g: parseFloat(args[1]), b: parseFloat(args[2]) }, args[3]);\r\n  }\r\n}\r\n\r\n/** clear model appearance overrides in display style.\r\n * @beta\r\n */\r\nexport class ClearModelAppearanceOverrides extends Tool {\r\n  public static override toolId = \"ClearModelAppearanceOverrides\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  public override async run(name?: string): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (vp !== undefined && vp.view instanceof SpatialViewState) {\r\n      vp.view.forEachModel((model) => {\r\n        if (name === undefined || model.name === name)\r\n          vp.dropModelAppearanceOverride(model.id);\r\n      });\r\n    }\r\n\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    return this.run(args[0]);\r\n  }\r\n}\r\n"]}

package/lib/tools/PlanProjectionTools.d.ts

@@ -0,0 +1,41 @@
+import { Viewport } from "@itwin/core-frontend";
+import { DisplayStyleTool } from "./DisplayStyleTools";
+/** Dumps a JSON representation of the plan projection settings for the current viewport.
+ * @beta
+ */
+export declare class DumpPlanProjectionSettingsTool extends DisplayStyleTool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    private _copyToClipboard;
+    protected get require3d(): boolean;
+    protected parse(args: string[]): boolean;
+    protected execute(vp: Viewport): boolean;
+}
+/** Changes subcategory display priority.
+ * @beta
+ */
+export declare abstract class OverrideSubCategoryPriorityTool extends DisplayStyleTool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    private readonly _subcatIds;
+    private _priority?;
+    protected execute(vp: Viewport): boolean;
+    protected parse(args: string[]): boolean;
+}
+/** Changes plan projection settings for one or more models.
+ * @beta
+ */
+export declare abstract class ChangePlanProjectionSettingsTool extends DisplayStyleTool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    private readonly _modelIds;
+    private _settings?;
+    protected get require3d(): boolean;
+    protected execute(vp: Viewport): boolean;
+    protected parse(inputArgs: string[]): boolean;
+    private parseModels;
+}
+//# sourceMappingURL=PlanProjectionTools.d.ts.map

package/lib/tools/PlanProjectionTools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlanProjectionTools.d.ts","sourceRoot":"","sources":["../../src/tools/PlanProjectionTools.ts"],"names":[],"mappings":"AAUA,OAAO,EAA2F,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEzI,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAGvD;;GAEG;AACH,qBAAa,8BAA+B,SAAQ,gBAAgB;IAClE,OAAuB,MAAM,SAAuB;IACpD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD,OAAO,CAAC,gBAAgB,CAAS;IAEjC,cAAuB,SAAS,YAAmB;IAEnD,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE;IAO9B,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO;CAoBzC;AAED;;GAEG;AACH,8BAAsB,+BAAgC,SAAQ,gBAAgB;IAC5E,OAAuB,MAAM,SAAiC;IAC9D,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAqB;IAChD,OAAO,CAAC,SAAS,CAAC,CAAS;IAE3B,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO;IAiBxC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE;CAU/B;AAED;;GAEG;AACH,8BAAsB,gCAAiC,SAAQ,gBAAgB;IAC7E,OAAuB,MAAM,SAAyB;IACtD,WAA2B,OAAO,WAAgB;IAClD,WAA2B,OAAO,WAAgB;IAElD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAqB;IAC/C,OAAO,CAAC,SAAS,CAAC,CAAyB;IAE3C,cAAuB,SAAS,YAAmB;IAEnD,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO;IAQxC,SAAS,CAAC,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE;IAgBnC,OAAO,CAAC,WAAW;CAmCpB"}

package/lib/tools/PlanProjectionTools.js

@@ -0,0 +1,150 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChangePlanProjectionSettingsTool = exports.OverrideSubCategoryPriorityTool = exports.DumpPlanProjectionSettingsTool = void 0;
+/** @packageDocumentation
+ * @module Tools
+ */
+const core_common_1 = require("@itwin/core-common");
+const core_frontend_1 = require("@itwin/core-frontend");
+const ClipboardUtilities_1 = require("../ClipboardUtilities");
+const DisplayStyleTools_1 = require("./DisplayStyleTools");
+const parseArgs_1 = require("./parseArgs");
+/** Dumps a JSON representation of the plan projection settings for the current viewport.
+ * @beta
+ */
+class DumpPlanProjectionSettingsTool extends DisplayStyleTools_1.DisplayStyleTool {
+    constructor() {
+        super(...arguments);
+        this._copyToClipboard = false;
+    }
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    get require3d() { return true; }
+    parse(args) {
+        if (1 === args.length)
+            this._copyToClipboard = "c" === args[0].toLowerCase();
+        return true;
+    }
+    execute(vp) {
+        const settings = vp.displayStyle.settings.planProjectionSettings;
+        if (undefined === settings) {
+            core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Info, "No plan projection settings defined"));
+            return false;
+        }
+        const props = [];
+        for (const [modelId, value] of settings)
+            props.push({ modelId, settings: value.toJSON() });
+        const json = JSON.stringify(props);
+        if (this._copyToClipboard)
+            (0, ClipboardUtilities_1.copyStringToClipboard)(json);
+        const messageDetails = new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Info, "Dumped plan projection settings", json);
+        core_frontend_1.IModelApp.notifications.outputMessage(messageDetails);
+        return false;
+    }
+}
+exports.DumpPlanProjectionSettingsTool = DumpPlanProjectionSettingsTool;
+DumpPlanProjectionSettingsTool.toolId = "DumpLayerSettings";
+/** Changes subcategory display priority.
+ * @beta
+ */
+class OverrideSubCategoryPriorityTool extends DisplayStyleTools_1.DisplayStyleTool {
+    constructor() {
+        super(...arguments);
+        this._subcatIds = new Set();
+    }
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 2; }
+    execute(vp) {
+        const style = vp.displayStyle;
+        for (const id of this._subcatIds) {
+            const ovr = style.getSubCategoryOverride(id);
+            if (undefined === ovr) {
+                if (undefined !== this._priority)
+                    style.overrideSubCategory(id, core_common_1.SubCategoryOverride.fromJSON({ priority: this._priority }));
+            }
+            else {
+                const props = ovr.toJSON();
+                props.priority = this._priority;
+                style.overrideSubCategory(id, core_common_1.SubCategoryOverride.fromJSON(props));
+            }
+        }
+        return true;
+    }
+    parse(args) {
+        for (const id of args[0].split(","))
+            this._subcatIds.add(id);
+        const priority = parseInt(args[1], 10);
+        if (!Number.isNaN(priority))
+            this._priority = priority;
+        return true;
+    }
+}
+exports.OverrideSubCategoryPriorityTool = OverrideSubCategoryPriorityTool;
+OverrideSubCategoryPriorityTool.toolId = "OverrideSubCategoryPriority";
+/** Changes plan projection settings for one or more models.
+ * @beta
+ */
+class ChangePlanProjectionSettingsTool extends DisplayStyleTools_1.DisplayStyleTool {
+    constructor() {
+        super(...arguments);
+        this._modelIds = new Set();
+    }
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 5; }
+    get require3d() { return true; }
+    execute(vp) {
+        const settings = vp.displayStyle.settings;
+        for (const modelId of this._modelIds)
+            settings.setPlanProjectionSettings(modelId, this._settings);
+        return true;
+    }
+    parse(inputArgs) {
+        if (!this.parseModels(inputArgs[0]))
+            return false;
+        const args = (0, parseArgs_1.parseArgs)(inputArgs.slice(1));
+        const props = {};
+        props.transparency = args.getFloat("t");
+        props.overlay = args.getBoolean("o");
+        props.enforceDisplayPriority = args.getBoolean("p");
+        props.elevation = args.getFloat("e");
+        this._settings = core_common_1.PlanProjectionSettings.fromJSON(props);
+        return true;
+    }
+    parseModels(models) {
+        const vp = core_frontend_1.IModelApp.viewManager.selectedView; // already validated by super.parseAndRun
+        models = models.toLowerCase();
+        const isPlanProjection = (modelId) => {
+            const model = vp.iModel.models.getLoaded(modelId);
+            return undefined !== model && isPlanProjectionModel(model);
+        };
+        const isPlanProjectionModel = (model) => {
+            const model3d = model.asGeometricModel3d;
+            return undefined !== model3d && model3d.isPlanProjection;
+        };
+        switch (models[0]) {
+            case "a": // all models in selector
+                vp.view.forEachModel((model) => {
+                    if (isPlanProjectionModel(model))
+                        this._modelIds.add(model.id);
+                });
+                break;
+            case "0": // comma-separated list of Ids
+                for (const modelId of models.split(","))
+                    if (isPlanProjection(modelId))
+                        this._modelIds.add(modelId);
+                break;
+        }
+        if (this._modelIds.size === 0) {
+            core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Error, "No plan projection models"));
+            return false;
+        }
+        return true;
+    }
+}
+exports.ChangePlanProjectionSettingsTool = ChangePlanProjectionSettingsTool;
+ChangePlanProjectionSettingsTool.toolId = "ChangeLayerSettings";
+//# sourceMappingURL=PlanProjectionTools.js.map

package/lib/tools/PlanProjectionTools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlanProjectionTools.js","sourceRoot":"","sources":["../../src/tools/PlanProjectionTools.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,oDAA8G;AAC9G,wDAAyI;AACzI,8DAA8D;AAC9D,2DAAuD;AACvD,2CAAwC;AAExC;;GAEG;AACH,MAAa,8BAA+B,SAAQ,oCAAgB;IAApE;;QAKU,qBAAgB,GAAG,KAAK,CAAC;IA+BnC,CAAC;IAlCQ,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAIlD,IAAuB,SAAS,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAEzC,KAAK,CAAC,IAAc;QAC5B,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM;YACnB,IAAI,CAAC,gBAAgB,GAAG,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;QAExD,OAAO,IAAI,CAAC;IACd,CAAC;IAES,OAAO,CAAC,EAAY;QAC5B,MAAM,QAAQ,GAAI,EAAE,CAAC,YAAoC,CAAC,QAAQ,CAAC,sBAAsB,CAAC;QAC1F,IAAI,SAAS,KAAK,QAAQ,EAAE;YAC1B,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,IAAI,EAAE,qCAAqC,CAAC,CAAC,CAAC;YACnI,OAAO,KAAK,CAAC;SACd;QAED,MAAM,KAAK,GAAG,EAAE,CAAC;QACjB,KAAK,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,QAAQ;YACrC,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAEpD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACnC,IAAI,IAAI,CAAC,gBAAgB;YACvB,IAAA,0CAAqB,EAAC,IAAI,CAAC,CAAC;QAE9B,MAAM,cAAc,GAAG,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,IAAI,EAAE,iCAAiC,EAAE,IAAI,CAAC,CAAC;QACrH,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QAEtD,OAAO,KAAK,CAAC;IACf,CAAC;;AAnCH,wEAoCC;AAnCwB,qCAAM,GAAG,mBAAmB,CAAC;AAqCtD;;GAEG;AACH,MAAsB,+BAAgC,SAAQ,oCAAgB;IAA9E;;QAKmB,eAAU,GAAG,IAAI,GAAG,EAAU,CAAC;IA8BlD,CAAC;IAjCQ,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAKxC,OAAO,CAAC,EAAY;QAC5B,MAAM,KAAK,GAAG,EAAE,CAAC,YAAY,CAAC;QAC9B,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,UAAU,EAAE;YAChC,MAAM,GAAG,GAAG,KAAK,CAAC,sBAAsB,CAAC,EAAE,CAAC,CAAC;YAC7C,IAAI,SAAS,KAAK,GAAG,EAAE;gBACrB,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;oBAC9B,KAAK,CAAC,mBAAmB,CAAC,EAAE,EAAE,iCAAmB,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;aAC7F;iBAAM;gBACL,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC;gBAC3B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;gBAChC,KAAK,CAAC,mBAAmB,CAAC,EAAE,EAAE,iCAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;aACpE;SACF;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAES,KAAK,CAAC,IAAc;QAC5B,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC;YACjC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAE1B,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACvC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC;YACzB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAE5B,OAAO,IAAI,CAAC;IACd,CAAC;;AAlCH,0EAmCC;AAlCwB,sCAAM,GAAG,6BAA6B,CAAC;AAoChE;;GAEG;AACH,MAAsB,gCAAiC,SAAQ,oCAAgB;IAA/E;;QAKmB,cAAS,GAAG,IAAI,GAAG,EAAU,CAAC;IAgEjD,CAAC;IAnEQ,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAKlD,IAAuB,SAAS,KAAK,OAAO,IAAI,CAAC,CAAC,CAAC;IAEzC,OAAO,CAAC,EAAY;QAC5B,MAAM,QAAQ,GAAI,EAAE,CAAC,YAAoC,CAAC,QAAQ,CAAC;QACnE,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS;YAClC,QAAQ,CAAC,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAE9D,OAAO,IAAI,CAAC;IACd,CAAC;IAES,KAAK,CAAC,SAAmB;QACjC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACjC,OAAO,KAAK,CAAC;QAEf,MAAM,IAAI,GAAG,IAAA,qBAAS,EAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,MAAM,KAAK,GAAgC,EAAE,CAAC;QAE9C,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACxC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACrC,KAAK,CAAC,sBAAsB,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACpD,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAErC,IAAI,CAAC,SAAS,GAAG,oCAAsB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,WAAW,CAAC,MAAc;QAChC,MAAM,EAAE,GAAG,yBAAS,CAAC,WAAW,CAAC,YAAa,CAAC,CAAC,yCAAyC;QACzF,MAAM,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;QAE9B,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAE,EAAE;YAC3C,MAAM,KAAK,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YAClD,OAAO,SAAS,KAAK,KAAK,IAAI,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAC7D,CAAC,CAAC;QACF,MAAM,qBAAqB,GAAG,CAAC,KAAiB,EAAE,EAAE;YAClD,MAAM,OAAO,GAAG,KAAK,CAAC,kBAAkB,CAAC;YACzC,OAAO,SAAS,KAAK,OAAO,IAAI,OAAO,CAAC,gBAAgB,CAAC;QAC3D,CAAC,CAAC;QAEF,QAAQ,MAAM,CAAC,CAAC,CAAC,EAAE;YACjB,KAAK,GAAG,EAAE,yBAAyB;gBACjC,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE,EAAE;oBAC7B,IAAI,qBAAqB,CAAC,KAAK,CAAC;wBAC9B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACjC,CAAC,CAAC,CAAC;gBACH,MAAM;YACR,KAAK,GAAG,EAAE,8BAA8B;gBACtC,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC;oBACrC,IAAI,gBAAgB,CAAC,OAAO,CAAC;wBAC3B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAEhC,MAAM;SACT;QAED,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,EAAE;YAC7B,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,KAAK,EAAE,2BAA2B,CAAC,CAAC,CAAC;YAC1H,OAAO,KAAK,CAAC;SACd;QAED,OAAO,IAAI,CAAC;IACd,CAAC;;AApEH,4EAqEC;AApEwB,uCAAM,GAAG,qBAAqB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\n/** @packageDocumentation\r\n * @module Tools\r\n */\r\n\r\nimport { PlanProjectionSettings, PlanProjectionSettingsProps, SubCategoryOverride } from \"@itwin/core-common\";\r\nimport { DisplayStyle3dState, IModelApp, ModelState, NotifyMessageDetails, OutputMessagePriority, Viewport } from \"@itwin/core-frontend\";\r\nimport { copyStringToClipboard } from \"../ClipboardUtilities\";\r\nimport { DisplayStyleTool } from \"./DisplayStyleTools\";\r\nimport { parseArgs } from \"./parseArgs\";\r\n\r\n/** Dumps a JSON representation of the plan projection settings for the current viewport.\r\n * @beta\r\n */\r\nexport class DumpPlanProjectionSettingsTool extends DisplayStyleTool {\r\n  public static override toolId = \"DumpLayerSettings\";\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  private _copyToClipboard = false;\r\n\r\n  protected override get require3d() { return true; }\r\n\r\n  protected parse(args: string[]) {\r\n    if (1 === args.length)\r\n      this._copyToClipboard = \"c\" === args[0].toLowerCase();\r\n\r\n    return true;\r\n  }\r\n\r\n  protected execute(vp: Viewport): boolean {\r\n    const settings = (vp.displayStyle as DisplayStyle3dState).settings.planProjectionSettings;\r\n    if (undefined === settings) {\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, \"No plan projection settings defined\"));\r\n      return false;\r\n    }\r\n\r\n    const props = [];\r\n    for (const [modelId, value] of settings)\r\n      props.push({ modelId, settings: value.toJSON() });\r\n\r\n    const json = JSON.stringify(props);\r\n    if (this._copyToClipboard)\r\n      copyStringToClipboard(json);\r\n\r\n    const messageDetails = new NotifyMessageDetails(OutputMessagePriority.Info, \"Dumped plan projection settings\", json);\r\n    IModelApp.notifications.outputMessage(messageDetails);\r\n\r\n    return false;\r\n  }\r\n}\r\n\r\n/** Changes subcategory display priority.\r\n * @beta\r\n */\r\nexport abstract class OverrideSubCategoryPriorityTool extends DisplayStyleTool {\r\n  public static override toolId = \"OverrideSubCategoryPriority\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 2; }\r\n\r\n  private readonly _subcatIds = new Set<string>();\r\n  private _priority?: number;\r\n\r\n  protected execute(vp: Viewport): boolean {\r\n    const style = vp.displayStyle;\r\n    for (const id of this._subcatIds) {\r\n      const ovr = style.getSubCategoryOverride(id);\r\n      if (undefined === ovr) {\r\n        if (undefined !== this._priority)\r\n          style.overrideSubCategory(id, SubCategoryOverride.fromJSON({ priority: this._priority }));\r\n      } else {\r\n        const props = ovr.toJSON();\r\n        props.priority = this._priority;\r\n        style.overrideSubCategory(id, SubCategoryOverride.fromJSON(props));\r\n      }\r\n    }\r\n\r\n    return true;\r\n  }\r\n\r\n  protected parse(args: string[]) {\r\n    for (const id of args[0].split(\",\"))\r\n      this._subcatIds.add(id);\r\n\r\n    const priority = parseInt(args[1], 10);\r\n    if (!Number.isNaN(priority))\r\n      this._priority = priority;\r\n\r\n    return true;\r\n  }\r\n}\r\n\r\n/** Changes plan projection settings for one or more models.\r\n * @beta\r\n */\r\nexport abstract class ChangePlanProjectionSettingsTool extends DisplayStyleTool {\r\n  public static override toolId = \"ChangeLayerSettings\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 5; }\r\n\r\n  private readonly _modelIds = new Set<string>();\r\n  private _settings?: PlanProjectionSettings;\r\n\r\n  protected override get require3d() { return true; }\r\n\r\n  protected execute(vp: Viewport): boolean {\r\n    const settings = (vp.displayStyle as DisplayStyle3dState).settings;\r\n    for (const modelId of this._modelIds)\r\n      settings.setPlanProjectionSettings(modelId, this._settings);\r\n\r\n    return true;\r\n  }\r\n\r\n  protected parse(inputArgs: string[]) {\r\n    if (!this.parseModels(inputArgs[0]))\r\n      return false;\r\n\r\n    const args = parseArgs(inputArgs.slice(1));\r\n    const props: PlanProjectionSettingsProps = {};\r\n\r\n    props.transparency = args.getFloat(\"t\");\r\n    props.overlay = args.getBoolean(\"o\");\r\n    props.enforceDisplayPriority = args.getBoolean(\"p\");\r\n    props.elevation = args.getFloat(\"e\");\r\n\r\n    this._settings = PlanProjectionSettings.fromJSON(props);\r\n    return true;\r\n  }\r\n\r\n  private parseModels(models: string) {\r\n    const vp = IModelApp.viewManager.selectedView!; // already validated by super.parseAndRun\r\n    models = models.toLowerCase();\r\n\r\n    const isPlanProjection = (modelId: string) => {\r\n      const model = vp.iModel.models.getLoaded(modelId);\r\n      return undefined !== model && isPlanProjectionModel(model);\r\n    };\r\n    const isPlanProjectionModel = (model: ModelState) => {\r\n      const model3d = model.asGeometricModel3d;\r\n      return undefined !== model3d && model3d.isPlanProjection;\r\n    };\r\n\r\n    switch (models[0]) {\r\n      case \"a\": // all models in selector\r\n        vp.view.forEachModel((model) => {\r\n          if (isPlanProjectionModel(model))\r\n            this._modelIds.add(model.id);\r\n        });\r\n        break;\r\n      case \"0\": // comma-separated list of Ids\r\n        for (const modelId of models.split(\",\"))\r\n          if (isPlanProjection(modelId))\r\n            this._modelIds.add(modelId);\r\n\r\n        break;\r\n    }\r\n\r\n    if (this._modelIds.size === 0) {\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, \"No plan projection models\"));\r\n      return false;\r\n    }\r\n\r\n    return true;\r\n  }\r\n}\r\n"]}