Support for AccuDraw shortcuts to apply and create named ACS.

common/api/core-frontend.api.md

@@ -884,8 +884,7 @@ export class AccuDrawShortcuts {
     static defineACSByElement(): Promise<boolean>;
     // (undocumented)
     static defineACSByPoints(): Promise<boolean>;
-    // (undocumented)
-    static getACS(acsName: string | undefined, useOrigin: boolean, useRotation: boolean): BentleyStatus;
+    static getACS(acsName: string | undefined, useOrigin: boolean, useRotation: boolean): Promise<AuxCoordSystemState | undefined>;
     // (undocumented)
     static itemFieldAcceptInput(index: ItemField, str: string): Promise<void>;
     // (undocumented)
@@ -939,8 +938,7 @@ export class AccuDrawShortcuts {
     static suspendToggle(): void;
     // (undocumented)
     static updateACSByPoints(acs: AuxCoordSystemState, vp: Viewport, points: Point3d[], isDynamics: boolean): boolean;
-    // (undocumented)
-    static writeACS(_acsName: string): BentleyStatus;
+    static writeACS(acsName: string | undefined): Promise<AuxCoordSystemState | undefined>;
 }
 
 // @beta
@@ -1416,7 +1414,7 @@ export abstract class AuxCoordSystemState extends ElementState implements AuxCoo
     constructor(props: AuxCoordSystemProps, iModel: IModelConnection);
     // (undocumented)
     static get className(): string;
-    static createNew(acsName: string, iModel: IModelConnection): AuxCoordSystemState;
+    static createNew(_acsName: string, iModel: IModelConnection): AuxCoordSystemState;
     // (undocumented)
     description?: string;
     // (undocumented)

common/changes/@itwin/core-frontend/accudraw-named-acs-support_2026-07-23-13-45-55.json

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

core/frontend/src/AuxCoordSys.ts

@@ -9,7 +9,7 @@
 import { JsonUtils } from "@itwin/core-bentley";
 import { Angle, AngleSweep, Arc3d, Matrix3d, Point2d, Point3d, Transform, Vector3d, XAndY, XYAndZ, YawPitchRollAngles } from "@itwin/core-geometry";
 import {
-  AuxCoordSystem2dProps, AuxCoordSystem3dProps, AuxCoordSystemProps, BisCodeSpec, Code, ColorDef, IModel, LinePixels, Npc,
+  AuxCoordSystem2dProps, AuxCoordSystem3dProps, AuxCoordSystemProps, Code, ColorDef, IModel, LinePixels, Npc,
 } from "@itwin/core-common";
 import { ElementState } from "./EntityState";
 import { IModelConnection } from "./IModelConnection";
@@ -79,13 +79,19 @@ export abstract class AuxCoordSystemState extends ElementState implements AuxCoo
   }
 
   /** Create a new AuxCoordSystemState.
-   * @param acsName the name for the new AuxCoordSystem
-   * @param iModel the iModel for which the ACS applies.
-   * @note call this method with the appropriate subclass (e.g. AuxCoordSystemSpatialState, AuxCoordSystem2dState, etc), not on AuxCoordSystemState directly
+   * @param _acsName unused, this method creates an empty code as it lacks sufficient information to do otherwise.
+   * @param iModel the iModel for which the ACS applies
+   * @note Inserting a new named ACS element requires creating a CodeProps for the type of view and the view's definition model.
+   * This method doesn't have the information to do this so it creates and empty code.
+   * @example
+   * ```typescript
+   * const codeSpecName = vp.view.isSpatialView() ? BisCodeSpec.auxCoordSystemSpatial : (vp.view.is3d() ? BisCodeSpec.auxCoordSystem3d : BisCodeSpec.auxCoordSystem2d);
+   * const codeSpec = await vp.iModel.codeSpecs.getByName(codeSpecName);
+   * const code = new Code({ spec: codeSpec.id, scope: vp.view.model, value: acsName });
+   * ```
    */
-  public static createNew(acsName: string, iModel: IModelConnection): AuxCoordSystemState {
-    const myCode = new Code({ spec: BisCodeSpec.auxCoordSystemSpatial, scope: IModel.dictionaryId.toString(), value: acsName });
-    return new AuxCoordSystemSpatialState({ model: IModel.dictionaryId, code: myCode, classFullName: this.classFullName }, iModel);
+  public static createNew(_acsName: string, iModel: IModelConnection): AuxCoordSystemState {
+    return new AuxCoordSystemSpatialState({ model: IModel.dictionaryId, code: Code.createEmpty(), classFullName: this.classFullName }, iModel);
   }
 
   public constructor(props: AuxCoordSystemProps, iModel: IModelConnection) {

core/frontend/src/EntityState.ts

@@ -109,7 +109,7 @@ export class ElementState extends EntityState implements ElementProps {
   public override toJSON(): ElementProps {
     const val = super.toJSON() as ElementProps;
     if (Id64.isValid(this.code.spec))
-      val.code = this.code;
+      val.code = this.code.toJSON(); // Ensure _value with get accessor is serialized...
 
     val.model = this.model;
     val.parent = this.parent;

core/frontend/src/tools/AccuDrawTool.ts

@@ -6,11 +6,11 @@
  * @module Tools
  */
 
-import { BentleyStatus } from "@itwin/core-bentley";
+import { AuxCoordSystemProps, BisCodeSpec, Code } from "@itwin/core-common";
 import { AxisOrder, Geometry, Matrix3d, Plane3dByOriginAndUnitNormal, Point3d, Transform, Vector3d } from "@itwin/core-geometry";
 import { AccuDraw, AccuDrawFlags, CompassMode, ContextMode, ItemField, KeyinStatus, LockedStates, RotationMode, ThreeAxes } from "../AccuDraw";
 import { TentativeOrAccuSnap } from "../AccuSnap";
-import { ACSDisplayOptions, AuxCoordSystemState } from "../AuxCoordSys";
+import { ACSDisplayOptions, ACSType, AuxCoordSystemState } from "../AuxCoordSys";
 import { SnapDetail } from "../HitDetail";
 import { IModelApp } from "../IModelApp";
 import { DecorateContext } from "../ViewContext";
@@ -871,56 +871,89 @@ export class AccuDrawShortcuts {
     return IModelApp.tools.run("AccuDraw.DefineACSByPoints");
   }
 
-  public static getACS(acsName: string | undefined, useOrigin: boolean, useRotation: boolean): BentleyStatus {
-    const accudraw = IModelApp.accuDraw;
-    if (!accudraw.isEnabled)
-      return BentleyStatus.ERROR;
+  private static async getACSCode(vp: Viewport, acsName: string): Promise<Code | undefined> {
+    try {
+      const codeSpecName = vp.view.isSpatialView() ? BisCodeSpec.auxCoordSystemSpatial : (vp.view.is3d() ? BisCodeSpec.auxCoordSystem3d : BisCodeSpec.auxCoordSystem2d);
+      const codeSpec = await vp.iModel.codeSpecs.getByName(codeSpecName);
+      return new Code({ spec: codeSpec.id, scope: vp.view.model, value: acsName });
+    } catch {
+      return undefined;
+    }
+  }
 
-    const vp = accudraw.currentView;
-    if (!vp)
-      return BentleyStatus.ERROR;
+  private static async getNamedACS(vp: Viewport, acsName: string): Promise<AuxCoordSystemState | undefined> {
+    try {
+      const acsCode = await this.getACSCode(vp, acsName);
+      if (!acsCode)
+        return undefined;
 
-    let currRotation = 0, currBaseRotation = 0;
-    const axes = new ThreeAxes();
+      const acsProps = await vp.iModel.elements.loadProps(acsCode);
+      if (!acsProps)
+        return undefined;
 
-    if (!useRotation) {
-      // Save current rotation, event listener on ACS change will orient AccuDraw to ACS...
-      currRotation = accudraw.rotationMode;
-      currBaseRotation = accudraw.flags.baseRotation;
-      axes.setFrom(accudraw.axes);
+      const namedAcs = AuxCoordSystemState.fromProps(acsProps, vp.iModel);
+      return namedAcs.isValidForView(vp.view) ? namedAcs : undefined;
+    } catch {
+      return undefined;
     }
+  }
 
-    if (acsName && "" !== acsName) {
-      //   // See if this ACS already exists...
-      //   DgnCode acsCode = AuxCoordSystem:: CreateCode(vp -> GetViewControllerR().GetViewDefinition(), acsName);
-      //   DgnElementId acsId = vp -> GetViewController().GetDgnDb().Elements().QueryElementIdByCode(acsCode);
+  private static async createNewACS(vp: Viewport, acsName: string): Promise<AuxCoordSystemState | undefined> {
+    // Want a CodeProps to support insert so ViewState.createAuxCoordSystem(acsName) is not called.
+    try {
+      const acsCode = await this.getACSCode(vp, acsName);
+      if (!acsCode)
+        return undefined;
 
-      //   if (!acsId.IsValid())
-      //     return ERROR;
+      // Determine the class name based on view type
+      let classFullName: string;
+      if (vp.view.isSpatialView())
+        classFullName = "BisCore:AuxCoordSystemSpatial";
+      else if (vp.view.is3d())
+        classFullName = "BisCore:AuxCoordSystem3d";
+      else
+        classFullName = "BisCore:AuxCoordSystem2d";
 
-      //   AuxCoordSystemCPtr auxElm = vp -> GetViewController().GetDgnDb().Elements().Get<AuxCoordSystem>(acsId);
+      const acsProps: AuxCoordSystemProps = { model: acsCode.scope, code: acsCode.toJSON(), classFullName, type: ACSType.None };
+      const acs = AuxCoordSystemState.fromProps(acsProps, vp.iModel);
+      return acs;
+    } catch {
+      return undefined;
+    }
+  }
 
-      //   if (!auxElm.IsValid())
-      //     return ERROR;
+  /**
+   * Set the AuxiliaryCoordinateSystem for the current AccuDraw viewport by name.
+   * Optionally updates the AccuDraw origin and rotation to match the ACS.
+   * @note When no name is specified, AccuDraw is updated using the view's current ACS.
+   * @returns AuxCoordSystemState or undefined if name does not exist or is invalid for the view.
+   */
+  public static async getACS(acsName: string | undefined, useOrigin: boolean, useRotation: boolean): Promise<AuxCoordSystemState | undefined> {
+    const accudraw = IModelApp.accuDraw;
+    if (!accudraw.isEnabled)
+      return undefined;
 
-      //   AuxCoordSystemPtr acsPtr = auxElm -> MakeCopy<AuxCoordSystem>();
+    const vp = accudraw.currentView;
+    if (!vp)
+      return undefined;
 
-      //   if (!acsPtr.IsValid())
-      //     return ERROR;
+    let currentACS = vp.view.auxiliaryCoordinateSystem;
 
-      //   AuxCoordSystemCR oldACS = vp -> GetViewController().GetAuxCoordinateSystem();
+    if (acsName && "" !== acsName) {
+      const namedAcs = await this.getNamedACS(vp, acsName);
+      if (!namedAcs)
+        return undefined;
 
-      //   if (!useOrigin)
-      //     acsPtr -> SetOrigin(oldACS.GetOrigin());
+      if (!useOrigin)
+        namedAcs.setOrigin(currentACS.getOrigin());
 
-      //   if (!useRotation)
-      //     acsPtr -> SetRotation(oldACS.GetRotation());
+      if (!useRotation)
+        namedAcs.setRotation(currentACS.getRotation());
 
-      //   AccuDraw:: UpdateAuxCoordinateSystem(* acsPtr, * vp);
+      AccuDraw.updateAuxCoordinateSystem(namedAcs, vp); // Sets AccuDrawFlags.OrientACS hint to orient AccuDraw to ACS...
+      currentACS = namedAcs;
     }
 
-    const currentACS = vp.view.auxiliaryCoordinateSystem;
-
     if (useOrigin) {
       accudraw.origin.setFrom(currentACS.getOrigin());
       accudraw.point.setFrom(accudraw.origin);
@@ -933,57 +966,55 @@ export class AccuDrawShortcuts {
     } else {
       this.itemFieldUnlockAll();
 
-      accudraw.setRotationMode(currRotation);
-      accudraw.flags.baseRotation = currBaseRotation;
-      accudraw.axes.setFrom(axes);
-
       if (RotationMode.ACS === accudraw.flags.baseRotation) {
         const acs = currentACS.clone();
 
-        const rMatrix = accudraw.getRotation();
-        acs.setRotation(rMatrix);
-
+        acs.setRotation(accudraw.getRotation());
         AccuDraw.updateAuxCoordinateSystem(acs, vp);
       }
 
       accudraw.published.flags &= ~AccuDrawFlags.OrientACS;
     }
 
-    return BentleyStatus.SUCCESS;
+    return currentACS;
   }
 
-  public static writeACS(_acsName: string): BentleyStatus {
+  /**
+   * Create a new AuxiliaryCoordinateSystem for the current AccuDraw viewport using the compass origin, orientation, and mode.
+   * @note When no name is specified, the view's current ACS is updated from AccuDraw. Caller can choose to create
+   * an EditCommand to insert/update as a named ACS element using the returned AuxCoordSystemState.
+   * @returns AuxCoordSystemState or undefined if ACS could not be created.
+   */
+  public static async writeACS(acsName: string | undefined): Promise<AuxCoordSystemState | undefined> {
     const accudraw = IModelApp.accuDraw;
     if (!accudraw.isEnabled)
-      return BentleyStatus.ERROR;
+      return undefined;
 
     const vp = accudraw.currentView;
     if (!vp)
-      return BentleyStatus.ERROR;
-
-    // const origin = accudraw.origin;
-    // const rMatrix = accudraw.getRotation();
-    // AuxCoordSystemPtr acsPtr = AuxCoordSystem:: CreateFrom(vp -> GetViewController().GetAuxCoordinateSystem());
-    // acsPtr -> SetOrigin(origin);
-    // acsPtr -> SetRotation(rMatrix);
-    // acsPtr -> SetType(CompassMode.Polar == accudraw.getCompassMode() ? ACSType :: Cylindrical : ACSType:: Rectangular);
-    // acsPtr -> SetCode(AuxCoordSystem:: CreateCode(vp -> GetViewControllerR().GetViewDefinition(), nullptr != acsName ? acsName : ""));
-    // acsPtr -> SetDescription("");
+      return undefined;
 
-    // if (acsName && '\0' != acsName[0]) {
-    //   DgnDbStatus status;
-    //   acsPtr -> Insert(& status);
+    let acs;
+    if (acsName && "" !== acsName) {
+      const namedAcs = await this.getNamedACS(vp, acsName);
+      acs = namedAcs ?? await this.createNewACS(vp, acsName);
+    } else {
+      acs = vp.view.auxiliaryCoordinateSystem.clone();
+      acs.description = "";
+    }
 
-    //   if (DgnDbStatus:: Success != status)
-    //   return BentleyStatus.ERROR;
-    // }
+    if (undefined === acs)
+      return undefined;
 
-    // AccuDraw:: UpdateAuxCoordinateSystem(* acsPtr, * vp);
+    acs.setOrigin(accudraw.origin);
+    acs.setRotation(accudraw.getRotation());
+    acs.type = CompassMode.Polar === accudraw.compassMode ? ACSType.Cylindrical : ACSType.Rectangular;
 
-    // accudraw.flags.baseRotation = RotationMode.ACS;
-    // accudraw.SetRotationMode(RotationMode.ACS);
+    AccuDraw.updateAuxCoordinateSystem(acs, vp);
+    accudraw.flags.baseRotation = RotationMode.ACS;
+    accudraw.setRotationMode(RotationMode.ACS);
 
-    return BentleyStatus.SUCCESS;
+    return acs;
   }
 
   public static itemFieldUnlockAll(): void {

full-stack-tests/core/src/frontend/standalone/ViewState.test.ts

@@ -87,7 +87,6 @@ describe("ViewState", () => {
     assert.notDeepEqual(v2, viewState);
 
     const acs = v2.createAuxCoordSystem("test");
-    assert.equal(acs.code.value, "test");
     assert.instanceOf(acs, AuxCoordSystemSpatialState);
     acs.setOrigin({ x: 1, y: 1 });
     assert.isTrue(acs.getOrigin().isExactEqual({ x: 1, y: 1, z: 0 }));