@mlightcad/data-model 1.15.22 → 1.15.24

package/lib/object/AcDbGroup.d.ts

@@ -1,26 +1,389 @@
+import { AcCmColor } from '@mlightcad/common';
 import { AcDbDxfFiler } from '../base/AcDbDxfFiler.js';
 import { AcDbObject, type AcDbObjectId } from '../base/AcDbObject.js';
+import { AcDbEntity } from '../entity/AcDbEntity.js';
+import { AcDbObjectIterator } from '../misc/AcDbObjectIterator.js';
 /**
- * Nongraphical GROUP object (DXF GROUP).
+ * Nongraphical GROUP object (DXF GROUP / ObjectARX `AcDbGroup`).
  *
- * Minimal fields: name, unnamed/selectable flags, and soft-pointers to
- * member entity handles.
+ * A group is an ordered, named persistent selection set of database entities.
+ * It does not own its members. The group **name** is the key in the
+ * `ACAD_GROUP` dictionary; DXF group code 300 stores the **description**.
+ *
+ * @remarks
+ * ObjectARX requires the group to be added to the group dictionary (so it has
+ * an object id) before members are appended.
  */
 export declare class AcDbGroup extends AcDbObject {
+    /** Dictionary key name of this group (`ACAD_GROUP` entry). */
     private _name;
-    private _unnamed;
+    /** Group description (DXF group 300). */
+    private _description;
+    /** True when this is an anonymous (`*A…`) group. */
+    private _anonymous;
+    /** Whether the group can be selected as a unit. */
     private _selectable;
+    /** Soft-pointer member entity ids, in group order. */
     private _entityIds;
+    /**
+     * Creates a new group.
+     *
+     * @param description - Optional description (ObjectARX ctor first arg).
+     * @param selectable - Whether the group is selectable as a unit (default `true`).
+     */
+    constructor(description?: string, selectable?: boolean);
+    /**
+     * Gets the dictionary key name of this group (`ACAD_GROUP` entry).
+     *
+     * @returns The group name.
+     */
     get name(): string;
+    /**
+     * Sets the dictionary key name of this group.
+     *
+     * Prefer {@link setName} when the group is already stored in
+     * `database.objects.group`, so the dictionary key stays in sync.
+     *
+     * @param value - The new group name.
+     */
     set name(value: string);
+    /**
+     * Gets the group description (DXF group 300).
+     *
+     * @returns The description string.
+     */
+    get description(): string;
+    /**
+     * Sets the group description (DXF group 300).
+     *
+     * @param value - The new description.
+     */
+    set description(value: string);
+    /**
+     * Gets whether this is an anonymous (`*A…`) group.
+     *
+     * @returns `true` when the group is anonymous.
+     *
+     * @deprecated Prefer {@link isAnonymous} / {@link setAnonymous}.
+     */
     get unnamed(): boolean;
+    /**
+     * Sets whether this is an anonymous group.
+     *
+     * @param value - `true` to mark the group anonymous.
+     *
+     * @deprecated Prefer {@link isAnonymous} / {@link setAnonymous}.
+     */
     set unnamed(value: boolean);
+    /**
+     * Gets whether this is an anonymous group.
+     *
+     * @returns `true` when the group is anonymous.
+     */
+    get anonymous(): boolean;
+    /**
+     * Sets whether this is an anonymous group.
+     *
+     * @param value - `true` to mark the group anonymous.
+     */
+    set anonymous(value: boolean);
+    /**
+     * Gets whether the group can be selected as a unit.
+     *
+     * @returns `true` when the group is selectable.
+     */
     get selectable(): boolean;
+    /**
+     * Sets whether the group can be selected as a unit.
+     *
+     * @param value - `true` to allow selecting the group as a unit.
+     */
     set selectable(value: boolean);
+    /**
+     * Gets soft-pointer member entity ids, in group order.
+     *
+     * @returns A readonly view of member object ids.
+     */
     get entityIds(): readonly AcDbObjectId[];
+    /**
+     * Replaces the entire member id list.
+     *
+     * @param value - New ordered list of member object ids.
+     */
     set entityIds(value: readonly AcDbObjectId[]);
+    /**
+     * Appends one member id to the group.
+     *
+     * @param id - Object id of the entity to append.
+     *
+     * @deprecated Prefer {@link append}.
+     */
     addEntityId(id: AcDbObjectId): void;
+    /**
+     * Returns whether this group is anonymous.
+     *
+     * Mirrors ObjectARX `AcDbGroup::isAnonymous`.
+     *
+     * @returns `true` when the group is anonymous.
+     */
+    isAnonymous(): boolean;
+    /**
+     * Marks this group as anonymous.
+     *
+     * Mirrors ObjectARX `AcDbGroup::setAnonymous`.
+     */
+    setAnonymous(): void;
+    /**
+     * Returns whether the group is not accessible.
+     *
+     * Mirrors ObjectARX `AcDbGroup::isNotAccessible`. This port always returns
+     * `false` (inaccessible/proxy groups are not modeled).
+     *
+     * @returns Always `false`.
+     */
+    isNotAccessible(): boolean;
+    /**
+     * Sets the group name and, when database-bound, renames its `ACAD_GROUP`
+     * dictionary entry to match.
+     *
+     * Mirrors ObjectARX `AcDbGroup::setName`.
+     *
+     * @param name - The new group name.
+     */
+    setName(name: string): void;
+    /**
+     * Returns the number of member entities in the group.
+     *
+     * Mirrors ObjectARX `AcDbGroup::numEntities`.
+     *
+     * @returns Member count.
+     */
+    numEntities(): number;
+    /**
+     * Copies all member object ids into `out` (when provided) and returns the
+     * member count.
+     *
+     * Mirrors ObjectARX `AcDbGroup::allEntityIds`.
+     *
+     * @param out - Optional array cleared and filled with member ids.
+     * @returns The number of member ids.
+     */
+    allEntityIds(out?: AcDbObjectId[]): number;
+    /**
+     * Returns whether the group contains the given entity or object id.
+     *
+     * Mirrors ObjectARX `AcDbGroup::has`.
+     *
+     * @param entityOrId - An {@link AcDbEntity} or an object id string.
+     * @returns `true` when the id is a member of this group.
+     */
+    has(entityOrId: AcDbEntity | AcDbObjectId): boolean;
+    /**
+     * Returns the zero-based index of a member id, or `-1` when not found.
+     *
+     * Mirrors ObjectARX `AcDbGroup::getIndex`.
+     *
+     * @param id - Member object id to look up.
+     * @returns Index in the group, or `-1`.
+     */
+    getIndex(id: AcDbObjectId): number;
+    /**
+     * Creates an iterator over member object ids (in group order).
+     *
+     * Uses the shared {@link AcDbObjectIterator} pattern of this codebase
+     * (rather than ObjectARX `AcDbGroupIterator`).
+     *
+     * @returns An iterator yielding member {@link AcDbObjectId} values.
+     *
+     * @example
+     * ```typescript
+     * for (const id of group.newIterator()) {
+     *   const entity = db.getObjectById(id)
+     * }
+     * ```
+     */
+    newIterator(): AcDbObjectIterator<AcDbObjectId>;
+    /**
+     * Appends one or more member ids to the end of the group.
+     *
+     * Duplicate ids already in the group are ignored. Mirrors ObjectARX
+     * `AcDbGroup::append`.
+     *
+     * @param idOrIds - A single object id or an array of object ids.
+     */
+    append(idOrIds: AcDbObjectId | readonly AcDbObjectId[]): void;
+    /**
+     * Prepends one or more member ids to the start of the group.
+     *
+     * Duplicate ids already in the group are ignored. Mirrors ObjectARX
+     * `AcDbGroup::prepend`.
+     *
+     * @param idOrIds - A single object id or an array of object ids.
+     */
+    prepend(idOrIds: AcDbObjectId | readonly AcDbObjectId[]): void;
+    /**
+     * Inserts one or more member ids at the given index.
+     *
+     * Duplicate ids already in the group are ignored. Mirrors ObjectARX
+     * `AcDbGroup::insertAt`.
+     *
+     * @param index - Zero-based insertion index (clamped to `[0, length]`).
+     * @param idOrIds - A single object id or an array of object ids.
+     */
+    insertAt(index: number, idOrIds: AcDbObjectId | readonly AcDbObjectId[]): void;
+    /**
+     * Removes one or more members by object id.
+     *
+     * Mirrors ObjectARX `AcDbGroup::remove`.
+     *
+     * @param idOrIds - A single object id or an array of object ids to remove.
+     */
+    remove(idOrIds: AcDbObjectId | readonly AcDbObjectId[]): void;
+    /**
+     * Removes a member at `index`, or removes the given ids starting from that
+     * index when `ids` is provided.
+     *
+     * Mirrors ObjectARX `AcDbGroup::removeAt`.
+     *
+     * @param index - Zero-based index of the first member to consider.
+     * @param ids - Optional subset of ids to remove from `index` onward.
+     */
+    removeAt(index: number, ids?: readonly AcDbObjectId[]): void;
+    /**
+     * Replaces one member id with another.
+     *
+     * If `newId` is already in the group, `oldId` is simply removed. Mirrors
+     * ObjectARX `AcDbGroup::replace`.
+     *
+     * @param oldId - Existing member object id.
+     * @param newId - Replacement object id.
+     */
+    replace(oldId: AcDbObjectId, newId: AcDbObjectId): void;
+    /**
+     * Moves `num` members starting at `fromIndex` so they begin at `toIndex`.
+     *
+     * Mirrors ObjectARX `AcDbGroup::transfer`.
+     *
+     * @param fromIndex - Start index of the block to move.
+     * @param toIndex - Destination index for the block.
+     * @param num - Number of members to move.
+     */
+    transfer(fromIndex: number, toIndex: number, num: number): void;
+    /**
+     * Reverses the order of members in the group.
+     *
+     * Mirrors ObjectARX `AcDbGroup::reverse`.
+     */
+    reverse(): void;
+    /**
+     * Removes all members from the group.
+     *
+     * Mirrors ObjectARX `AcDbGroup::clear`.
+     */
+    clear(): void;
+    /**
+     * Sets the color of every resolvable member entity.
+     *
+     * Mirrors ObjectARX `AcDbGroup::setColor`.
+     *
+     * @param color - Color to apply (cloned onto each entity).
+     */
+    setColor(color: AcCmColor): void;
+    /**
+     * Sets the ACI color of every resolvable member entity.
+     *
+     * Mirrors ObjectARX `AcDbGroup::setColorIndex`.
+     *
+     * @param index - AutoCAD Color Index (`0`–`256`).
+     */
+    setColorIndex(index: number): void;
+    /**
+     * Sets the layer of every resolvable member entity.
+     *
+     * Mirrors ObjectARX `AcDbGroup::setLayer`. When `layerOrId` is an object id
+     * of a layer table record, the record's name is used.
+     *
+     * @param layerOrId - Layer name or layer-table-record object id.
+     */
+    setLayer(layerOrId: string | AcDbObjectId): void;
+    /**
+     * Sets the linetype of every resolvable member entity.
+     *
+     * Mirrors ObjectARX `AcDbGroup::setLinetype`. When `linetypeOrId` is an
+     * object id of a linetype table record, the record's name is used.
+     *
+     * @param linetypeOrId - Linetype name or linetype-table-record object id.
+     */
+    setLinetype(linetypeOrId: string | AcDbObjectId): void;
+    /**
+     * Sets the linetype scale of every resolvable member entity.
+     *
+     * Mirrors ObjectARX `AcDbGroup::setLinetypeScale`.
+     *
+     * @param scale - Linetype scale factor.
+     */
+    setLinetypeScale(scale: number): void;
+    /**
+     * Sets the material of every resolvable member entity.
+     *
+     * Mirrors ObjectARX `AcDbGroup::setMaterial`. Currently a no-op because
+     * entities keep material as a raw DXF extra without a typed setter.
+     *
+     * @param _materialOrId - Material name or material object id.
+     */
+    setMaterial(_materialOrId: string | AcDbObjectId): void;
+    /**
+     * Sets the visibility of every resolvable member entity.
+     *
+     * Mirrors ObjectARX `AcDbGroup::setVisibility`.
+     *
+     * @param visible - `true` to show members; `false` to hide them.
+     */
+    setVisibility(visible: boolean): void;
+    /**
+     * Sets the highlight state of every resolvable member entity.
+     *
+     * Mirrors ObjectARX `AcDbGroup::setHighlight`. Currently a no-op because
+     * this model has no per-entity highlight persistence.
+     *
+     * @param _highlight - Desired highlight state.
+     */
+    setHighlight(_highlight: boolean): void;
+    /**
+     * Writes DXF subclass fields for this group.
+     *
+     * @param filer - DXF output writer.
+     * @returns This instance for chaining.
+     */
     dxfOutFields(filer: AcDbDxfFiler): this;
+    /**
+     * Reads DXF subclass fields for this group.
+     *
+     * @param filer - DXF input reader positioned at this object.
+     * @returns This instance for chaining.
+     */
     dxfInFields(filer: AcDbDxfFiler): this;
+    /**
+     * Resolves member ids to {@link AcDbEntity} instances via the owning
+     * database. Non-entity or missing ids are skipped.
+     *
+     * @returns Entities currently resolvable from {@link entityIds}.
+     */
+    private memberEntities;
+    /**
+     * Resolves a layer name from a name string or layer-table-record object id.
+     *
+     * @param layerOrId - Layer name or object id.
+     * @returns Layer name to apply to member entities.
+     */
+    private resolveLayerName;
+    /**
+     * Resolves a linetype name from a name string or linetype-table-record
+     * object id.
+     *
+     * @param linetypeOrId - Linetype name or object id.
+     * @returns Linetype name to apply to member entities.
+     */
+    private resolveLinetypeName;
 }
 //# sourceMappingURL=AcDbGroup.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"AcDbGroup.d.ts","sourceRoot":"","sources":["../../src/object/AcDbGroup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAA;AACtD,OAAO,EAAE,UAAU,EAAE,KAAK,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAErE;;;;;GAKG;AACH,qBAAa,SAAU,SAAQ,UAAU;IACvC,OAAO,CAAC,KAAK,CAAK;IAClB,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,WAAW,CAAO;IAC1B,OAAO,CAAC,UAAU,CAAqB;IAEvC,IAAI,IAAI,IAGQ,MAAM,CADrB;IACD,IAAI,IAAI,CAAC,KAAK,EAAE,MAAM,EAErB;IAED,IAAI,OAAO,IAGQ,OAAO,CADzB;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAEzB;IAED,IAAI,UAAU,IAGQ,OAAO,CAD5B;IACD,IAAI,UAAU,CAAC,KAAK,EAAE,OAAO,EAE5B;IAED,IAAI,SAAS,IAAI,SAAS,YAAY,EAAE,CAEvC;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,SAAS,YAAY,EAAE,EAE3C;IAED,WAAW,CAAC,EAAE,EAAE,YAAY;IAInB,YAAY,CAAC,KAAK,EAAE,YAAY;IAchC,WAAW,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;CAgChD"}
+{"version":3,"file":"AcDbGroup.d.ts","sourceRoot":"","sources":["../../src/object/AcDbGroup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAE7C,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAA;AACtD,OAAO,EAAE,UAAU,EAAE,KAAK,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACrE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AAElE;;;;;;;;;;GAUG;AACH,qBAAa,SAAU,SAAQ,UAAU;IACvC,8DAA8D;IAC9D,OAAO,CAAC,KAAK,CAAK;IAClB,yCAAyC;IACzC,OAAO,CAAC,YAAY,CAAK;IACzB,oDAAoD;IACpD,OAAO,CAAC,UAAU,CAAQ;IAC1B,mDAAmD;IACnD,OAAO,CAAC,WAAW,CAAO;IAC1B,sDAAsD;IACtD,OAAO,CAAC,UAAU,CAAqB;IAEvC;;;;;OAKG;gBACS,WAAW,SAAK,EAAE,UAAU,UAAO;IAM/C;;;;OAIG;IACH,IAAI,IAAI,IAYQ,MAAM,CAVrB;IAED;;;;;;;OAOG;IACH,IAAI,IAAI,CAAC,KAAK,EAAE,MAAM,EAErB;IAED;;;;OAIG;IACH,IAAI,WAAW,IASQ,MAAM,CAP5B;IAED;;;;OAIG;IACH,IAAI,WAAW,CAAC,KAAK,EAAE,MAAM,EAE5B;IAED;;;;;;OAMG;IACH,IAAI,OAAO,IAWQ,OAAO,CATzB;IAED;;;;;;OAMG;IACH,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAEzB;IAED;;;;OAIG;IACH,IAAI,SAAS,IASQ,OAAO,CAP3B;IAED;;;;OAIG;IACH,IAAI,SAAS,CAAC,KAAK,EAAE,OAAO,EAE3B;IAED;;;;OAIG;IACH,IAAI,UAAU,IASQ,OAAO,CAP5B;IAED;;;;OAIG;IACH,IAAI,UAAU,CAAC,KAAK,EAAE,OAAO,EAE5B;IAED;;;;OAIG;IACH,IAAI,SAAS,IAAI,SAAS,YAAY,EAAE,CAEvC;IAED;;;;OAIG;IACH,IAAI,SAAS,CAAC,KAAK,EAAE,SAAS,YAAY,EAAE,EAE3C;IAED;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,EAAE,YAAY;IAI5B;;;;;;OAMG;IACH,WAAW,IAAI,OAAO;IAItB;;;;OAIG;IACH,YAAY,IAAI,IAAI;IAIpB;;;;;;;OAOG;IACH,eAAe,IAAI,OAAO;IAI1B;;;;;;;OAOG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAuC3B;;;;;;OAMG;IACH,WAAW,IAAI,MAAM;IAIrB;;;;;;;;OAQG;IACH,YAAY,CAAC,GAAG,CAAC,EAAE,YAAY,EAAE,GAAG,MAAM;IAQ1C;;;;;;;OAOG;IACH,GAAG,CAAC,UAAU,EAAE,UAAU,GAAG,YAAY,GAAG,OAAO;IAOnD;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,YAAY,GAAG,MAAM;IAIlC;;;;;;;;;;;;;;OAcG;IACH,WAAW,IAAI,kBAAkB,CAAC,YAAY,CAAC;IAI/C;;;;;;;OAOG;IACH,MAAM,CAAC,OAAO,EAAE,YAAY,GAAG,SAAS,YAAY,EAAE,GAAG,IAAI;IAQ7D;;;;;;;OAOG;IACH,OAAO,CAAC,OAAO,EAAE,YAAY,GAAG,SAAS,YAAY,EAAE,GAAG,IAAI;IAS9D;;;;;;;;OAQG;IACH,QAAQ,CACN,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,YAAY,GAAG,SAAS,YAAY,EAAE,GAC9C,IAAI;IASP;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE,YAAY,GAAG,SAAS,YAAY,EAAE,GAAG,IAAI;IAQ7D;;;;;;;;OAQG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,SAAS,YAAY,EAAE,GAAG,IAAI;IAc5D;;;;;;;;OAQG;IACH,OAAO,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,GAAG,IAAI;IAWvD;;;;;;;;OAQG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAY/D;;;;OAIG;IACH,OAAO,IAAI,IAAI;IAIf;;;;OAIG;IACH,KAAK,IAAI,IAAI;IAIb;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAMhC;;;;;;OAMG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAMlC;;;;;;;OAOG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,YAAY,GAAG,IAAI;IAQhD;;;;;;;OAOG;IACH,WAAW,CAAC,YAAY,EAAE,MAAM,GAAG,YAAY,GAAG,IAAI;IAQtD;;;;;;OAMG;IACH,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAMrC;;;;;;;OAOG;IACH,WAAW,CAAC,aAAa,EAAE,MAAM,GAAG,YAAY,GAAG,IAAI;IAIvD;;;;;;OAMG;IACH,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAMrC;;;;;;;OAOG;IACH,YAAY,CAAC,UAAU,EAAE,OAAO,GAAG,IAAI;IAIvC;;;;;OAKG;IACM,YAAY,CAAC,KAAK,EAAE,YAAY;IAczC;;;;;OAKG;IACM,WAAW,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAiC/C;;;;;OAKG;IACH,OAAO,CAAC,cAAc;IAWtB;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAcxB;;;;;;OAMG;IACH,OAAO,CAAC,mBAAmB;CAa5B"}