IFClite TypeScript API
    Preparing search index...

    Interface ClashBcfOptions

    interface ClashBcfOptions {
        author: string;
        cameraDistanceFactor?: number;
        maxMembersPerTopic?: number;
        maxTopics?: number;
        modelNameOf?: (model: string) => string;
        projectName?: string;
        reviewStatusOf?: (clash: Clash) => ClashReviewStatus;
        snapshotProvider?: (
            group: ClashGroup,
        ) => Promise<Uint8Array<ArrayBufferLike> | undefined>;
        status?: string;
        worldOffset?: { x: number; y: number; z: number };
    }
    Index
    author cameraDistanceFactor? maxMembersPerTopic? maxTopics? modelNameOf? projectName? reviewStatusOf? snapshotProvider? status? worldOffset?
    author: string
    cameraDistanceFactor?: number
    maxMembersPerTopic?: number
    maxTopics?: number
    modelNameOf?: (model: string) => string

    Resolve a ClashElementRef.model id to its display file name for the BCF <Header> source files (#1591). The viewer's model ids are opaque UUIDs, so without this the Header would record UUIDs instead of file names. Omit when the ids are already human-readable (e.g. the CLI uses file paths).

    projectName?: string
    reviewStatusOf?: (clash: Clash) => ClashReviewStatus

    Resolve a clash's REVIEW status (#1468). When provided, each topic's status is the least-resolved status among its members, mapped to a BCF TopicStatus (open -> Open, resolved/accepted -> Closed). Omit to keep the flat status for every topic (the pre-review behaviour).

    snapshotProvider?: (
        group: ClashGroup,
    ) => Promise<Uint8Array<ArrayBufferLike> | undefined>
    status?: string

    Fallback topic status for topics whose members have no review status (and for the overflow marker). Ignored per-topic when reviewStatusOf resolves a status from the members. Defaults to Open.

    worldOffset?: { x: number; y: number; z: number }

    Clash-bounds (render) frame -> IFC world, Z-up metres: renderFrameWorldOffset(coordinateInfo) from @ifc-lite/geometry/world-frame (#4806, #4879).

    Settings
    Member Visibility

    On This Page
    Properties