IFClite TypeScript API
    Preparing search index...

    Interface ModellingStoreBackendMethods

    interface ModellingStoreBackendMethods {
        addColumnOnGrid?(
            modelId: string,
            storeyExpressId: number,
            params: ColumnInStoreParams | ProfiledColumnInStoreParams,
            binding: GridColumnBinding,
        ): EntityRef;
        addCurtainWall?(
            modelId: string,
            storeyExpressId: number,
            params: CurtainWallInStoreParams,
        ): EntityRef;
        addElementType(
            modelId: string,
            params: ElementTypeInStoreParams,
        ): EntityRef;
        addGrid?(
            modelId: string,
            storeyExpressId: number,
            params: GridInStoreParams,
        ): EntityRef;
        addHostedDoor(
            modelId: string,
            hostExpressId: number,
            params: HostedDoorInStoreParams,
        ): EntityRef;
        addHostedWindow(
            modelId: string,
            hostExpressId: number,
            params: HostedWindowInStoreParams,
        ): EntityRef;
        addMaterial(modelId: string, params: MaterialInStoreParams): EntityRef;
        addMaterialLayerSet(
            modelId: string,
            params: MaterialLayerSetInStoreParams,
        ): EntityRef;
        addMaterialLayerSetUsage(
            modelId: string,
            params: MaterialLayerSetUsageInStoreParams,
        ): EntityRef;
        addOpening(
            modelId: string,
            hostExpressId: number,
            params: OpeningInStoreParams,
        ): EntityRef;
        addRailing?(
            modelId: string,
            storeyExpressId: number,
            params: RailingInStoreParams,
        ): EntityRef;
        addStair?(
            modelId: string,
            storeyExpressId: number,
            params: StairInStoreParams,
        ): EntityRef;
        alignElements?(
            modelId: string,
            reference: number,
            targets: readonly number[],
            mode: AlignMode,
        ): Promise<EntityRef[]>;
        arrayElements?(
            modelId: string,
            expressIds: readonly number[],
            params: CopyArrayParams,
        ): EntityRef[];
        assignMaterial(
            modelId: string,
            materialExpressId: number,
            objectExpressIds: number[],
        ): EntityRef;
        assignType(
            modelId: string,
            typeExpressId: number,
            objectExpressIds: number[],
        ): EntityRef;
        copyElements?(
            modelId: string,
            expressIds: readonly number[],
            transforms: readonly CopyTransform[],
        ): EntityRef[];
        duplicateElement?(
            ref: EntityRef,
            options: { Name?: string; offset: [number, number, number] },
        ): EntityRef;
        editHostedElement?(ref: EntityRef, patch: HostedElementEdit): EntityRef;
        joinWalls(
            modelId: string,
            aExpressId: number,
            bExpressId: number,
            options?: WallJoinApplyOptions,
        ): EntityRef;
        removeStair?(ref: EntityRef): boolean;
        replaceElement?(
            ref: EntityRef,
            storeyExpressId: number,
            element: InStoreReplacementElement,
        ): EntityRef;
        resizeWall?(
            ref: EntityRef,
            start: [number, number, number],
            end: [number, number, number],
            options?: { moveJoinedEnds?: boolean },
        ): EntityRef[];
        roomCommand?(
            modelId: string,
            storeyId: number,
            command: RoomCommand,
        ): Promise<RoomCommandResult>;
        setElementSize?(ref: EntityRef, patch: PhysicalSizePatch): EntityRef[];
        splitElements?(
            modelId: string,
            requests: readonly ElementSplitRequest[],
        ): {
            added: EntityRef;
            left: EntityRef;
            right: EntityRef;
            source: EntityRef;
        }[];
        transformElements?(
            modelId: string,
            expressIds: readonly number[],
            operation: StoreyTransformOp,
        ): EntityRef[];
        trimExtendElement?(
            ref: EntityRef,
            params: ElementTrimExtendParams,
        ): EntityRef[];
    }

    Hierarchy

    • PhysicalStoreBackendMethods
      • ModellingStoreBackendMethods
    Index
    addColumnOnGrid? addCurtainWall? addElementType addGrid? addHostedDoor addHostedWindow addMaterial addMaterialLayerSet addMaterialLayerSetUsage addOpening addRailing? addStair? alignElements? arrayElements? assignMaterial assignType copyElements? duplicateElement? editHostedElement? joinWalls removeStair? replaceElement? resizeWall? roomCommand? setElementSize? splitElements? transformElements? trimExtendElement?

    • IfcGrid with straight, tagged axes and its FootPrint representation.

      Parameters

      Returns EntityRef

    • IfcOpeningElement + IfcRelVoidsElement cut into an existing IfcWall or IfcSlab. Returns the opening.

      Parameters

      Returns EntityRef

    • Optional host capability: an IfcRailing along a storey-local polyline. Returns the railing.

      Parameters

      Returns EntityRef

    • Optional host capability: a storey-local IfcStair aggregating one IfcStairFlight. Returns the stair.

      Parameters

      Returns EntityRef

    • Parameters

      • modelId: string
      • reference: number
      • targets: readonly number[]
      • mode: AlignMode

      Returns Promise<EntityRef[]>

    • Array count includes the original; full circles exclude a coincident final copy.

      Parameters

      Returns EntityRef[]

    • Associate a material (any IfcMaterialSelect) with objects via IfcRelAssociatesMaterial, replacing their previous association. Returns the relationship.

      Parameters

      • modelId: string
      • materialExpressId: number
      • objectExpressIds: number[]

      Returns EntityRef

    • Type objects via IfcRelDefinesByType, extending the type's relationship and detaching them from a previous type. Returns the relationship.

      Parameters

      • modelId: string
      • typeExpressId: number
      • objectExpressIds: number[]

      Returns EntityRef

    • Copy a dependency-pruned selection once per storey-local transform, atomically.

      Parameters

      • modelId: string
      • expressIds: readonly number[]
      • transforms: readonly CopyTransform[]

      Returns EntityRef[]

    • Duplicate with the viewer naming policy; explicit storey-local IFC XYZ displacement.

      Parameters

      • ref: EntityRef
      • options: { Name?: string; offset: [number, number, number] }

      Returns EntityRef

    • Join two straight walls through IfcRelConnectsPathElements, rewriting their bodies/axes atomically. Returns the relationship.

      Parameters

      Returns EntityRef

    • Optional host capability: atomically remove a uniquely owned single-flight stair assembly.

      Parameters

      Returns boolean

    • Parameters

      • ref: EntityRef
      • start: [number, number, number]
      • end: [number, number, number]
      • Optionaloptions: { moveJoinedEnds?: boolean }

      Returns EntityRef[]

    • Native mesh/DCEL Room operations with atomic history-aware layout edits.

      Parameters

      Returns Promise<RoomCommandResult>

    • Parameters

      Returns EntityRef[]

    Settings
    Member Visibility

    On This Page
    Methods