@itwin/core-backend 3.3.0-dev.9 → 3.4.0-dev.10

package/lib/cjs/Element.js

@@ -11,8 +11,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FolderLink = exports.UrlLink = exports.LinkElement = exports.GroupInformationElement = exports.SpatialLocationPartition = exports.PhysicalPartition = exports.LinkPartition = exports.InformationRecordPartition = exports.GraphicalPartition3d = exports.GroupInformationPartition = exports.DocumentPartition = exports.DefinitionPartition = exports.InformationPartitionElement = exports.TemplateRecipe2d = exports.GraphicalType2d = exports.TemplateRecipe3d = exports.SpatialLocationType = exports.PhysicalType = exports.RecipeDefinitionElement = exports.TypeDefinitionElement = exports.DefinitionGroup = exports.DefinitionContainer = exports.DefinitionSet = exports.DefinitionElement = exports.InformationRecordElement = exports.Sheet = exports.SheetTemplate = exports.SheetBorderTemplate = exports.SectionDrawing = exports.Drawing = exports.Document = exports.Subject = exports.InformationReferenceElement = exports.DriverBundleElement = exports.InformationContentElement = exports.SectionDrawingLocation = exports.VolumeElement = exports.SpatialLocationElement = exports.PhysicalElement = exports.SpatialElement = exports.TextAnnotation3d = exports.TextAnnotation2d = exports.DrawingGraphic = exports.AnnotationElement2d = exports.GraphicalElement2d = exports.GeometricElement2d = exports.GraphicalElement3d = exports.GeometricElement3d = exports.GeometricElement = exports.Element = void 0;
 exports.RenderTimeline = exports.LineStyle = exports.GeometryPart = exports.RoleElement = exports.EmbeddedFileLink = exports.RepositoryLink = void 0;
 const core_bentley_1 = require("@itwin/core-bentley");
-const core_geometry_1 = require("@itwin/core-geometry");
 const core_common_1 = require("@itwin/core-common");
+const core_geometry_1 = require("@itwin/core-geometry");
 const Entity_1 = require("./Entity");
 const Model_1 = require("./Model");
 const NavigationRelationship_1 = require("./NavigationRelationship");
@@ -28,7 +28,7 @@ const NavigationRelationship_1 = require("./NavigationRelationship");
  * uniqueness of id, code, and federationGuid.
  *
  * See:
- * * [Element Fundamentals]($docs/bis/intro/element-fundamentals.md)
+ * * [Element Fundamentals]($docs/bis/guide/fundamentals/element-fundamentals.md)
  * * [Working with schemas and elements in TypeScript]($docs/learning/backend/SchemasAndElementsInTypeScript.md)
  * * [Creating elements]($docs/learning/backend/CreateElements.md)
  * @public
@@ -225,31 +225,46 @@ class Element extends Entity_1.Entity {
             val.jsonProperties = this.jsonProperties;
         return val;
     }
-    /** Collect the Ids of this element's *predecessors* at this level of the class hierarchy.
-     * A *predecessor* is an element that had to be inserted before this element could have been inserted.
-     * This is important for cloning operations but can be useful in other situations as well.
-     * @param predecessorIds The Id64Set to populate with predecessor Ids.
-     * @note In order to clone/transform an element, all predecessor elements must have been previously cloned and remapped within the [IModelCloneContext]($backend).
-     * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces predecessors.
-     * @see getPredecessorIds
+    /** Collect the Ids of this element's *references* at this level of the class hierarchy.
+     * @deprecated use [[collectReferenceIds]] instead, the use of the term *predecessors* was confusing and became inaccurate when the transformer could handle cycles
      * @beta
      */
     collectPredecessorIds(predecessorIds) {
-        predecessorIds.add(this.model); // The modeledElement is a predecessor
+        return this.collectReferenceIds(predecessorIds);
+    }
+    /** Collect the Ids of this entity's *references* at this level of the class hierarchy.
+     * A *reference* is any entity referenced by this entity's EC Data
+     * This is important for cloning operations but can be useful in other situations as well.
+     * @param referenceIds The Id64Set to populate with reference Ids.
+     * @note In order to clone/transform an entity, all referenced elements must have been previously cloned and remapped within the [IModelCloneContext]($backend).
+     * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces references.
+     * @see getReferenceIds
+     * @beta
+     */
+    collectReferenceIds(referenceIds) {
+        referenceIds.add(this.model); // The modeledElement is a reference
         if (this.code.scope && core_bentley_1.Id64.isValidId64(this.code.scope))
-            predecessorIds.add(this.code.scope); // The element that scopes the code is a predecessor
+            referenceIds.add(this.code.scope); // The element that scopes the code is a reference
         if (this.parent)
-            predecessorIds.add(this.parent.id); // A parent element is a predecessor
+            referenceIds.add(this.parent.id); // A parent element is a reference
     }
-    /** Get the Ids of this element's *predecessors*. A *predecessor* is an element that had to be inserted before this element could have been inserted.
+    /** Get the Ids of this element's *references*. A *reference* is any element whose id is stored in the EC data of this element
      * This is important for cloning operations but can be useful in other situations as well.
-     * @see collectPredecessorIds
      * @beta
+     * @deprecated use [[getReferenceIds]] instead, the use of the term *predecessors* was confusing and became inaccurate when the transformer could handle cycles
      */
     getPredecessorIds() {
-        const predecessorIds = new Set();
-        this.collectPredecessorIds(predecessorIds);
-        return predecessorIds;
+        return this.getReferenceIds();
+    }
+    /** Get the Ids of this element's *references*. A *reference* is an element that this element references.
+     * This is important for cloning operations but can be useful in other situations as well.
+     * @see collectReferenceIds
+     * @beta
+     */
+    getReferenceIds() {
+        const referenceIds = new Set();
+        this.collectReferenceIds(referenceIds);
+        return referenceIds;
     }
     /** Get the class metadata for this element. */
     getClassMetaData() { return this.iModel.classMetaDataRegistry.find(this.classFullName); }
@@ -290,7 +305,7 @@ exports.Element = Element;
 /** A *required reference* is an element that had to be inserted before this element could have been inserted.
  * This is the list of property keys on this element that store references to those elements
  * @note This should be overridden (with `super` called) at each level the class hierarchy that introduces required references.
- * @note any property listed here must be added to the predecessor ids in [[collectPredecessorIds]]
+ * @note any property listed here must be added to the reference ids in [[collectReferenceIds]]
  * @beta
  */
 Element.requiredReferenceKeys = ["parent", "model"];
@@ -322,9 +337,9 @@ class GeometricElement extends (_b = Element) {
         return val;
     }
     /** @internal */
-    collectPredecessorIds(predecessorIds) {
-        super.collectPredecessorIds(predecessorIds);
-        predecessorIds.add(this.category);
+    collectReferenceIds(referenceIds) {
+        super.collectReferenceIds(referenceIds);
+        referenceIds.add(this.category);
         // TODO: GeometryPartIds?
     }
 }
@@ -356,10 +371,10 @@ class GeometricElement3d extends GeometricElement {
         return val;
     }
     /** @internal */
-    collectPredecessorIds(predecessorIds) {
-        super.collectPredecessorIds(predecessorIds);
+    collectReferenceIds(referenceIds) {
+        super.collectReferenceIds(referenceIds);
         if (undefined !== this.typeDefinition) {
-            predecessorIds.add(this.typeDefinition.id);
+            referenceIds.add(this.typeDefinition.id);
         }
     }
 }
@@ -397,10 +412,10 @@ class GeometricElement2d extends GeometricElement {
         return val;
     }
     /** @internal */
-    collectPredecessorIds(predecessorIds) {
-        super.collectPredecessorIds(predecessorIds);
+    collectReferenceIds(referenceIds) {
+        super.collectReferenceIds(referenceIds);
         if (undefined !== this.typeDefinition) {
-            predecessorIds.add(this.typeDefinition.id);
+            referenceIds.add(this.typeDefinition.id);
         }
     }
 }
@@ -729,10 +744,10 @@ class SheetTemplate extends Document {
     /** @internal */
     static get className() { return "SheetTemplate"; }
     /** @internal */
-    collectPredecessorIds(predecessorIds) {
-        super.collectPredecessorIds(predecessorIds);
+    collectReferenceIds(referenceIds) {
+        super.collectReferenceIds(referenceIds);
         if (undefined !== this.border) {
-            predecessorIds.add(this.border);
+            referenceIds.add(this.border);
         }
     }
 }
@@ -752,10 +767,10 @@ class Sheet extends Document {
     /** @internal */
     static get className() { return "Sheet"; }
     /** @internal */
-    collectPredecessorIds(predecessorIds) {
-        super.collectPredecessorIds(predecessorIds);
+    collectReferenceIds(referenceIds) {
+        super.collectReferenceIds(referenceIds);
         if (undefined !== this.sheetTemplate) {
-            predecessorIds.add(this.sheetTemplate);
+            referenceIds.add(this.sheetTemplate);
         }
     }
     /** Create a Code for a Sheet given a name that is meant to be unique within the scope of the specified DocumentListModel.
@@ -888,10 +903,10 @@ class TypeDefinitionElement extends DefinitionElement {
     /** @internal */
     static get className() { return "TypeDefinitionElement"; }
     /** @internal */
-    collectPredecessorIds(predecessorIds) {
-        super.collectPredecessorIds(predecessorIds);
+    collectReferenceIds(referenceIds) {
+        super.collectReferenceIds(referenceIds);
         if (undefined !== this.recipe) {
-            predecessorIds.add(this.recipe.id);
+            referenceIds.add(this.recipe.id);
         }
     }
 }
@@ -1081,7 +1096,7 @@ class TemplateRecipe2d extends RecipeDefinitionElement {
 exports.TemplateRecipe2d = TemplateRecipe2d;
 /** An abstract base class for elements that establishes a particular modeling perspective for its parent Subject.
  * Instances are always sub-modeled by a specialization of Model of the appropriate modeling perspective.
- * @see [iModel Information Hierarchy]($docs/bis/intro/top-of-the-world), [[Subject]], [[Model]]
+ * @see [iModel Information Hierarchy]($docs/bis/guide/data-organization/top-of-the-world), [[Subject]], [[Model]]
  * @public
  */
 class InformationPartitionElement extends InformationContentElement {
@@ -1361,8 +1376,8 @@ class RenderTimeline extends InformationRecordElement {
         }
     }
     /** @alpha */
-    collectPredecessorIds(ids) {
-        super.collectPredecessorIds(ids);
+    collectReferenceIds(ids) {
+        super.collectReferenceIds(ids);
         const script = core_common_1.RenderSchedule.Script.fromJSON(this.scriptProps);
         script === null || script === void 0 ? void 0 : script.discloseIds(ids);
     }