IFClite TypeScript API
    Preparing search index...

    Interface OverlayWallReader

    Optional overlay reader. If supplied, overlay walls (entities created via editor.addEntity('IfcWall', ...) since the model was parsed) are included alongside the source walls.

    interface OverlayWallReader {
        getAttribute?(
            expressId: number,
            index: number,
        ): IfcAttributeValue | undefined;
        getEntityTypeMutation?(
            expressId: number,
        ): { newType: string } | null | undefined;
        getNewEntities(): Iterable<
            { attributes: IfcAttributeValue[]; expressId: number; type: string },
        >;
        getPositionalMutationsForEntity?(
            expressId: number,
        ): ReadonlyMap<number, IfcAttributeValue> | null;
        getTypeMutations?(): ReadonlyMap<number, { newType: string }>;
        isDeleted?(expressId: number): boolean;
        readEntity?(
            expressId: number,
        ): { attributes: IfcAttributeValue[]; type?: string } | null;
    }
    Index
    getAttribute? getEntityTypeMutation? getNewEntities getPositionalMutationsForEntity? getTypeMutations? isDeleted? readEntity?

    • Resolve a positional attribute (with mutations applied).

      Parameters

      • expressId: number
      • index: number

      Returns IfcAttributeValue | undefined

    • Point lookup of a live retype, without copying the whole retype map.

      Parameters

      • expressId: number

      Returns { newType: string } | null | undefined

    • Iterate every overlay-created entity.

      Returns Iterable<{ attributes: IfcAttributeValue[]; expressId: number; type: string }>

    • Queued positional attribute edits of one entity (#5249).

      Parameters

      • expressId: number

      Returns ReadonlyMap<number, IfcAttributeValue> | null

    • Retypes queued this session (#5249).

      Returns ReadonlyMap<number, { newType: string }>

    • Deleted this session (#5249): the entity is not part of the model.

      Parameters

      • expressId: number

      Returns boolean

    • Authoritative effective metadata callback: null never falls back to source.

      Parameters

      • expressId: number

      Returns { attributes: IfcAttributeValue[]; type?: string } | null

    Settings
    Member Visibility

    On This Page
    Methods