Promote ElementSetTool from @Alpha to @public for editing application…

…s. (iTwin#6924)
won21kr · Jul 2, 2024 · fb8ffe9 · fb8ffe9
1 parent dda32b7
commit fb8ffe9
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 13 deletions.
diff --git a/common/api/core-frontend.api.md b/common/api/core-frontend.api.md
@@ -3241,7 +3241,7 @@ export namespace EditManipulator {
 // @internal (undocumented)
 export const ELEMENT_MARKED_FOR_REMOVAL: unique symbol;
 
-// @alpha
+// @public
 export class ElementAgenda {
     constructor(iModel: IModelConnection);
     add(arg: Id64Arg): boolean;
@@ -3327,7 +3327,7 @@ export class ElementPicker {
     viewport?: Viewport;
 }
 
-// @alpha
+// @public
 export abstract class ElementSetTool extends PrimitiveTool {
     protected get agenda(): ElementAgenda;
     protected get allowDragSelect(): boolean;
@@ -5735,7 +5735,7 @@ export interface GroundPlaneDecorations {
     readonly belowParams: GraphicParams;
 }
 
-// @alpha (undocumented)
+// @public
 export interface GroupMark {
     // (undocumented)
     source: ModifyElementSource;
@@ -9791,7 +9791,7 @@ export class ModelState extends EntityState implements ModelProps {
 // @public
 export type ModelSubCategoryHiliteMode = "union" | "intersection";
 
-// @alpha (undocumented)
+// @public
 export enum ModifyElementSource {
     DragSelect = 3,
     Selected = 1,

diff --git a/common/api/summary/core-frontend.exports.csv b/common/api/summary/core-frontend.exports.csv
@@ -201,10 +201,10 @@ internal;EdgeTableInfo
 internal;EditCommandHandler
 public;EditManipulator
 internal;ELEMENT_MARKED_FOR_REMOVAL: unique symbol
-alpha;ElementAgenda
+public;ElementAgenda
 public;ElementLocateManager
 public;ElementPicker
-alpha;class ElementSetTool 
+public;class ElementSetTool 
 public;ElementState 
 public;EllipsoidTerrainProvider 
 public;EmphasizeElements 
@@ -370,7 +370,7 @@ public;GraphicShape2d
 public;GraphicSolidPrimitive
 public;GraphicType
 internal;GroundPlaneDecorations
-alpha;GroupMark
+public;GroupMark
 internal;headersIncludeAuthMethod(headers: Headers, query: string[]): boolean
 internal;Hilites
 public;HiliteSet
@@ -589,7 +589,7 @@ internal;ModelMapLayerTileTreeReference
 public;ModelSelectorState 
 public;ModelState 
 public;ModelSubCategoryHiliteMode = "union" | "intersection"
-alpha;ModifyElementSource
+public;ModifyElementSource
 public;MutableChangeFlags 
 public;NativeApp
 internal;NativeAppLogger

diff --git a/common/changes/@itwin/core-bentley/element-set-tool_2024-07-02-16-43.json b/common/changes/@itwin/core-bentley/element-set-tool_2024-07-02-16-43.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/core-bentley",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/core-bentley"
+}
diff --git a/common/changes/@itwin/core-frontend/element-set-tool_2024-07-02-15-51.json b/common/changes/@itwin/core-frontend/element-set-tool_2024-07-02-15-51.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/core-frontend",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/core-frontend"
+}
diff --git a/core/bentley/src/CompressedId64Set.ts b/core/bentley/src/CompressedId64Set.ts
@@ -55,7 +55,7 @@ export namespace CompressedId64Set { // eslint-disable-line @typescript-eslint/n
   }
 
   /** Create a sorted array from `ids`, then return a compact string representation of those Ids.
-   * @see [[compressIds]] if `ids` is known to already be sorted.
+   * @see [[CompressedId64Set.compressIds]] if `ids` is known to already be sorted.
    */
   export function sortAndCompress(ids: Iterable<Id64String>): CompressedId64Set {
     // `string` is an Iterable<string>. In that case assume caller passed a single Id64String.

diff --git a/core/frontend/src/tools/ElementSetTool.ts b/core/frontend/src/tools/ElementSetTool.ts
@@ -25,7 +25,9 @@ import { SelectionMethod } from "./SelectTool";
 import { BeButton, BeButtonEvent, BeModifierKeys, CoreTools, EventHandled } from "./Tool";
 import { ToolAssistance, ToolAssistanceImage, ToolAssistanceInputMethod, ToolAssistanceInstruction, ToolAssistanceSection } from "./ToolAssistance";
 
-/** @alpha */
+/** Identifies the source of the elements in the agenda.
+ * @public
+ */
 export enum ModifyElementSource {
   /** The source for the element is unknown - not caused by a modification command. */
   Unknown = 0,
@@ -37,7 +39,9 @@ export enum ModifyElementSource {
   DragSelect = 3,
 }
 
-/** @alpha */
+/** Identifies groups of elements added to agenda along with the source.
+ * @public
+ */
 export interface GroupMark {
   start: number;
   source: ModifyElementSource;
@@ -46,7 +50,7 @@ export interface GroupMark {
 /** The ElementAgenda class is used by [[ElementSetTool]] to hold the collection of elements it will operate on
  * and to manage their hilite state.
  * @see [[ElementSetTool]]
- * @alpha
+ * @public
 */
 export class ElementAgenda {
   /** The IDs of the elements in this agenda.
@@ -280,7 +284,7 @@ export class ElementAgenda {
  * - Immediately apply operation.
  * - Restart.
  * Sub-classes are required to opt-in to additional element sources, dynamics, AccuSnap, additional input, etc.
- * @alpha
+ * @public
  */
 export abstract class ElementSetTool extends PrimitiveTool {
   private _agenda?: ElementAgenda;