@mlightcad/data-model 1.10.6 → 1.11.0

package/lib/object/AcDbLayerFilter.js

@@ -0,0 +1,250 @@
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+import { AcDbFilter } from './AcDbFilter';
+/**
+ * Layer filter object used with the AutoCAD **index/filter** scheme
+ * (`INDEXCTL` / block regeneration), not the Layer Properties Manager tree.
+ *
+ * An {@link AcDbLayerFilter} stores a flat list of layer names that participate
+ * in a layer-based query against a block. It is the counterpart to
+ * {@link AcDbLayerIndex}; {@link AcDbLayerFilter.indexClass} returns the layer
+ * index class name.
+ *
+ * @remarks
+ * Mirrors the ObjectARX `AcDbLayerFilter` class. For the Layer Manager
+ * property/group filter **tree**, see {@link AcLyLayerFilter} /
+ * {@link AcLyLayerGroup} under the ObjectARX `AcLy*` classes.
+ *
+ * In DXF this object is written as type `LAYER_FILTER` with subclass markers
+ * `AcDbFilter` and `AcDbLayerFilter`, and repeated group code 8 entries for
+ * layer names.
+ *
+ * @see https://help.autodesk.com/view/OARX/2024/ENU/?guid=OARX-RefGuide-AcDbLayerFilter
+ *
+ * @example
+ * ```typescript
+ * const filter = new AcDbLayerFilter();
+ * filter.add('Walls');
+ * filter.add('Doors');
+ * console.log(filter.layerCount()); // 2
+ * console.log(filter.getAt(0)); // 'Walls'
+ * ```
+ */
+var AcDbLayerFilter = /** @class */ (function (_super) {
+    __extends(AcDbLayerFilter, _super);
+    /**
+     * Creates a new {@link AcDbLayerFilter} instance.
+     *
+     * @example
+     * ```typescript
+     * const filter = new AcDbLayerFilter();
+     * ```
+     */
+    function AcDbLayerFilter() {
+        var _this = _super.call(this) || this;
+        _this._layerNames = [];
+        return _this;
+    }
+    Object.defineProperty(AcDbLayerFilter.prototype, "layerNames", {
+        /**
+         * Gets a copy of the layer names stored in this filter.
+         *
+         * @returns An array of layer names.
+         */
+        get: function () {
+            return this._layerNames;
+        },
+        /**
+         * Replaces the layer names stored in this filter.
+         *
+         * @param value - The new list of layer names.
+         */
+        set: function (value) {
+            this._layerNames = __spreadArray([], __read(value), false);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Adds a layer name to this filter.
+     *
+     * @remarks
+     * Mirrors ObjectARX `AcDbLayerFilter::add`. Duplicate names are ignored.
+     *
+     * @param layerName - Layer name to include in the filter.
+     * @returns `true` if the name was added; `false` if it was empty or already present.
+     *
+     * @example
+     * ```typescript
+     * filter.add('0');
+     * ```
+     */
+    AcDbLayerFilter.prototype.add = function (layerName) {
+        var name = layerName === null || layerName === void 0 ? void 0 : layerName.trim();
+        if (!name)
+            return false;
+        if (this._layerNames.includes(name))
+            return false;
+        this._layerNames.push(name);
+        return true;
+    };
+    /**
+     * Gets the layer name at the specified index.
+     *
+     * @remarks
+     * Mirrors ObjectARX `AcDbLayerFilter::getAt`.
+     *
+     * @param index - Zero-based index into the layer name list.
+     * @returns The layer name at `index`.
+     * @throws {Error} If `index` is out of range.
+     *
+     * @example
+     * ```typescript
+     * const name = filter.getAt(0);
+     * ```
+     */
+    AcDbLayerFilter.prototype.getAt = function (index) {
+        if (index < 0 || index >= this._layerNames.length) {
+            throw new Error('The layer index is out of range!');
+        }
+        return this._layerNames[index];
+    };
+    /**
+     * Removes a layer name from this filter.
+     *
+     * @remarks
+     * Mirrors ObjectARX `AcDbLayerFilter::remove`.
+     *
+     * @param layerName - Layer name to remove.
+     * @returns `true` if the name was removed; otherwise `false`.
+     *
+     * @example
+     * ```typescript
+     * filter.remove('Walls');
+     * ```
+     */
+    AcDbLayerFilter.prototype.remove = function (layerName) {
+        var index = this._layerNames.indexOf(layerName);
+        if (index < 0)
+            return false;
+        this._layerNames.splice(index, 1);
+        return true;
+    };
+    /**
+     * Returns the number of layer names in this filter.
+     *
+     * @remarks
+     * Mirrors ObjectARX `AcDbLayerFilter::layerCount`.
+     *
+     * @returns The number of layer names.
+     *
+     * @example
+     * ```typescript
+     * const count = filter.layerCount();
+     * ```
+     */
+    AcDbLayerFilter.prototype.layerCount = function () {
+        return this._layerNames.length;
+    };
+    /**
+     * Returns the index class name associated with this filter.
+     *
+     * @remarks
+     * Mirrors ObjectARX `AcDbLayerFilter::indexClass`, which returns
+     * `AcDbLayerIndex::desc()`. This port returns the class name string.
+     *
+     * @returns Always `'AcDbLayerIndex'`.
+     */
+    AcDbLayerFilter.prototype.indexClass = function () {
+        return 'AcDbLayerIndex';
+    };
+    /**
+     * Returns whether this filter is considered valid.
+     *
+     * @remarks
+     * Mirrors ObjectARX `AcDbLayerFilter::isValid`. A filter is valid when it
+     * contains at least one non-empty layer name.
+     *
+     * @returns `true` if the filter is valid; otherwise `false`.
+     */
+    AcDbLayerFilter.prototype.isValid = function () {
+        return this._layerNames.some(function (name) { return name.length > 0; });
+    };
+    /**
+     * Writes DXF fields for this layer filter object.
+     *
+     * @param filer - DXF output writer.
+     * @returns The instance (for chaining).
+     */
+    AcDbLayerFilter.prototype.dxfOutFields = function (filer) {
+        var e_1, _a;
+        _super.prototype.dxfOutFields.call(this, filer);
+        filer.writeSubclassMarker('AcDbLayerFilter');
+        try {
+            for (var _b = __values(this._layerNames), _c = _b.next(); !_c.done; _c = _b.next()) {
+                var layerName = _c.value;
+                filer.writeString(8, layerName);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return this;
+    };
+    return AcDbLayerFilter;
+}(AcDbFilter));
+export { AcDbLayerFilter };
+//# sourceMappingURL=AcDbLayerFilter.js.map

package/lib/object/AcDbLayerFilter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AcDbLayerFilter.js","sourceRoot":"","sources":["../../src/object/AcDbLayerFilter.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH;IAAqC,mCAAU;IAI7C;;;;;;;OAOG;IACH;QACE,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,WAAW,GAAG,EAAE,CAAA;;IACvB,CAAC;IAOD,sBAAI,uCAAU;QALd;;;;WAIG;aACH;YACE,OAAO,IAAI,CAAC,WAAW,CAAA;QACzB,CAAC;QAED;;;;WAIG;aACH,UAAe,KAAwB;YACrC,IAAI,CAAC,WAAW,4BAAO,KAAK,SAAC,CAAA;QAC/B,CAAC;;;OATA;IAWD;;;;;;;;;;;;;OAaG;IACH,6BAAG,GAAH,UAAI,SAAiB;QACnB,IAAM,IAAI,GAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,IAAI,EAAE,CAAA;QAC9B,IAAI,CAAC,IAAI;YAAE,OAAO,KAAK,CAAA;QACvB,IAAI,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,OAAO,KAAK,CAAA;QACjD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC3B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,+BAAK,GAAL,UAAM,KAAa;QACjB,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAA;QACrD,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,gCAAM,GAAN,UAAO,SAAiB;QACtB,IAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;QACjD,IAAI,KAAK,GAAG,CAAC;YAAE,OAAO,KAAK,CAAA;QAC3B,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;QACjC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,oCAAU,GAAV;QACE,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAA;IAChC,CAAC;IAED;;;;;;;;OAQG;IACM,oCAAU,GAAnB;QACE,OAAO,gBAAgB,CAAA;IACzB,CAAC;IAED;;;;;;;;OAQG;IACH,iCAAO,GAAP;QACE,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAA,IAAI,IAAI,OAAA,IAAI,CAAC,MAAM,GAAG,CAAC,EAAf,CAAe,CAAC,CAAA;IACvD,CAAC;IAED;;;;;OAKG;IACM,sCAAY,GAArB,UAAsB,KAAmB;;QACvC,gBAAK,CAAC,YAAY,YAAC,KAAK,CAAC,CAAA;QACzB,KAAK,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAA;;YAC5C,KAAwB,IAAA,KAAA,SAAA,IAAI,CAAC,WAAW,CAAA,gBAAA,4BAAE,CAAC;gBAAtC,IAAM,SAAS,WAAA;gBAClB,KAAK,CAAC,WAAW,CAAC,CAAC,EAAE,SAAS,CAAC,CAAA;YACjC,CAAC;;;;;;;;;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IACH,sBAAC;AAAD,CAAC,AA7JD,CAAqC,UAAU,GA6J9C"}

package/lib/object/AcDbLayerIndex.d.ts

@@ -0,0 +1,165 @@
+import { AcDbDxfFiler } from '../base/AcDbDxfFiler';
+import type { AcDbObjectId } from '../base/AcDbObject';
+import type { AcDbBlockTableRecord } from '../database/AcDbBlockTableRecord';
+import type { AcDbLayerTable } from '../database/AcDbLayerTable';
+import type { AcDbFilter } from './AcDbFilter';
+import { AcDbBlockChangeIterator, AcDbFilteredBlockIterator, AcDbIndex, AcDbIndexUpdateData } from './AcDbIndex';
+/**
+ * Describes one layer entry stored in an {@link AcDbLayerIndex}.
+ *
+ * @remarks
+ * LAYER_INDEX DXF objects store parallel arrays of layer names (group 8),
+ * hard-owner IDBUFFER handles (group 360), and IDBUFFER entry counts
+ * (group 90). This type groups those related values for convenience.
+ */
+export interface AcDbLayerIndexEntry {
+    /** Layer name (DXF group code 8). */
+    layerName: string;
+    /** Hard-owner handle of the associated IDBUFFER object (DXF group code 360). */
+    idBufferId: AcDbObjectId;
+    /** Number of entries in the associated IDBUFFER (DXF group code 90). */
+    idBufferEntryCount: number;
+}
+/**
+ * Layer index object used with the AutoCAD index/filter scheme.
+ *
+ * An {@link AcDbLayerIndex} is an index implementation specialized for layers.
+ * It is typically associated with a block table record and used together with
+ * {@link AcDbLayerFilter} when regenerating xrefs and blocks under the
+ * `INDEXCTL` system variable.
+ *
+ * @remarks
+ * Mirrors the ObjectARX `AcDbLayerIndex` class. In DXF this object is written
+ * as type `LAYER_INDEX` with subclass markers `AcDbIndex` and
+ * `AcDbLayerIndex`.
+ *
+ * @see https://help.autodesk.com/view/OARX/2024/ENU/?guid=OARX-RefGuide-AcDbLayerIndex
+ *
+ * @example
+ * ```typescript
+ * const index = new AcDbLayerIndex();
+ * index.lastUpdatedAt = 2451545.0;
+ * index.layerNames = ['0', 'Walls'];
+ * index.idBufferIds = ['1A', '1B'];
+ * index.idBufferEntryCounts = [10, 4];
+ * ```
+ */
+export declare class AcDbLayerIndex extends AcDbIndex {
+    /** Layer names included in this index (DXF group code 8, repeated). */
+    private _layerNames;
+    /** Hard-owner handles to IDBUFFER objects (DXF group code 360, repeated). */
+    private _idBufferIds;
+    /** Entry counts for each IDBUFFER (DXF group code 90, repeated). */
+    private _idBufferEntryCounts;
+    /**
+     * Creates a new {@link AcDbLayerIndex} instance.
+     *
+     * @example
+     * ```typescript
+     * const index = new AcDbLayerIndex();
+     * ```
+     */
+    constructor();
+    /**
+     * Gets a copy of the layer names stored in this index.
+     *
+     * @returns An array of layer names.
+     */
+    get layerNames(): readonly string[];
+    /**
+     * Replaces the layer names stored in this index.
+     *
+     * @param value - The new list of layer names.
+     */
+    set layerNames(value: readonly string[]);
+    /**
+     * Gets a copy of the IDBUFFER object IDs referenced by this index.
+     *
+     * @returns An array of hard-owner IDBUFFER handles.
+     */
+    get idBufferIds(): readonly AcDbObjectId[];
+    /**
+     * Replaces the IDBUFFER object IDs referenced by this index.
+     *
+     * @param value - The new list of IDBUFFER handles.
+     */
+    set idBufferIds(value: readonly AcDbObjectId[]);
+    /**
+     * Gets a copy of the IDBUFFER entry counts stored in this index.
+     *
+     * @returns An array of IDBUFFER entry counts.
+     */
+    get idBufferEntryCounts(): readonly number[];
+    /**
+     * Replaces the IDBUFFER entry counts stored in this index.
+     *
+     * @param value - The new list of entry counts.
+     */
+    set idBufferEntryCounts(value: readonly number[]);
+    /**
+     * Returns grouped layer-index entries derived from the parallel DXF arrays.
+     *
+     * @returns An array of {@link AcDbLayerIndexEntry} values.
+     */
+    get entries(): AcDbLayerIndexEntry[];
+    /**
+     * Replaces this index from grouped layer-index entries.
+     *
+     * @param value - The entries to store.
+     */
+    set entries(value: readonly AcDbLayerIndexEntry[]);
+    /**
+     * Computes (rebuilds) this layer index from a layer table and block table
+     * record.
+     *
+     * @remarks
+     * Mirrors ObjectARX `AcDbLayerIndex::compute`. This port records layer names
+     * present in `layerTable` and associates the index with `blockTableRecord`;
+     * IDBUFFER population is not performed here.
+     *
+     * @param layerTable - Layer table used as the index source.
+     * @param blockTableRecord - Block table record being indexed.
+     * @returns `true` if the compute succeeded.
+     */
+    compute(layerTable?: AcDbLayerTable, blockTableRecord?: AcDbBlockTableRecord): boolean;
+    /**
+     * Creates a filtered block iterator for the given layer filter query.
+     *
+     * @remarks
+     * Mirrors ObjectARX `AcDbLayerIndex::newIterator`. A full filtered iterator
+     * is not yet implemented in this port.
+     *
+     * @param _filter - The filter defining the query (typically an
+     *   {@link AcDbLayerFilter}).
+     * @returns Always `null` until filtered iteration is implemented.
+     */
+    newIterator(_filter: AcDbFilter): AcDbFilteredBlockIterator | null;
+    /**
+     * Fully rebuilds this layer index.
+     *
+     * @remarks
+     * Mirrors ObjectARX `AcDbLayerIndex::rebuildFull`.
+     *
+     * @param _updateData - Optional index update mapping data.
+     * @returns `true` if the rebuild succeeded.
+     */
+    rebuildFull(_updateData?: AcDbIndexUpdateData): boolean;
+    /**
+     * Incrementally rebuilds this layer index for modified block contents.
+     *
+     * @remarks
+     * Mirrors ObjectARX `AcDbLayerIndex::rebuildModified`.
+     *
+     * @param _changeIterator - Optional iterator over changed block entities.
+     * @returns `true` if the rebuild succeeded.
+     */
+    protected rebuildModified(_changeIterator?: AcDbBlockChangeIterator): boolean;
+    /**
+     * Writes DXF fields for this layer index object.
+     *
+     * @param filer - DXF output writer.
+     * @returns The instance (for chaining).
+     */
+    dxfOutFields(filer: AcDbDxfFiler): this;
+}
+//# sourceMappingURL=AcDbLayerIndex.d.ts.map

package/lib/object/AcDbLayerIndex.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AcDbLayerIndex.d.ts","sourceRoot":"","sources":["../../src/object/AcDbLayerIndex.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAA;AAC5E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAChE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,EACL,uBAAuB,EACvB,yBAAyB,EACzB,SAAS,EACT,mBAAmB,EACpB,MAAM,aAAa,CAAA;AAEpB;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAmB;IAClC,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAA;IACjB,gFAAgF;IAChF,UAAU,EAAE,YAAY,CAAA;IACxB,wEAAwE;IACxE,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,cAAe,SAAQ,SAAS;IAC3C,uEAAuE;IACvE,OAAO,CAAC,WAAW,CAAU;IAC7B,6EAA6E;IAC7E,OAAO,CAAC,YAAY,CAAgB;IACpC,oEAAoE;IACpE,OAAO,CAAC,oBAAoB,CAAU;IAEtC;;;;;;;OAOG;;IAQH;;;;OAIG;IACH,IAAI,UAAU,IAAI,SAAS,MAAM,EAAE,CAElC;IAED;;;;OAIG;IACH,IAAI,UAAU,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,EAEtC;IAED;;;;OAIG;IACH,IAAI,WAAW,IAAI,SAAS,YAAY,EAAE,CAEzC;IAED;;;;OAIG;IACH,IAAI,WAAW,CAAC,KAAK,EAAE,SAAS,YAAY,EAAE,EAE7C;IAED;;;;OAIG;IACH,IAAI,mBAAmB,IAAI,SAAS,MAAM,EAAE,CAE3C;IAED;;;;OAIG;IACH,IAAI,mBAAmB,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,EAE/C;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,mBAAmB,EAAE,CAenC;IAED;;;;OAIG;IACH,IAAI,OAAO,CAAC,KAAK,EAAE,SAAS,mBAAmB,EAAE,EAIhD;IAED;;;;;;;;;;;;OAYG;IACH,OAAO,CACL,UAAU,CAAC,EAAE,cAAc,EAC3B,gBAAgB,CAAC,EAAE,oBAAoB,GACtC,OAAO;IAgBV;;;;;;;;;;OAUG;IACM,WAAW,CAAC,OAAO,EAAE,UAAU,GAAG,yBAAyB,GAAG,IAAI;IAI3E;;;;;;;;OAQG;IACM,WAAW,CAAC,WAAW,CAAC,EAAE,mBAAmB,GAAG,OAAO;IAOhE;;;;;;;;OAQG;cACgB,eAAe,CAChC,eAAe,CAAC,EAAE,uBAAuB,GACxC,OAAO;IAOV;;;;;OAKG;IACM,YAAY,CAAC,KAAK,EAAE,YAAY;CAqB1C"}