IFClite TypeScript API
    Preparing search index...

    Interface ClashRule

    A single detection rule. Omit b for a self-clash within selection a.

    interface ClashRule {
        a: string;
        b?: string;
        clearance?: number;
        id: string;
        membersA?: readonly string[];
        membersB?: readonly string[];
        mode: ClashMode;
        name: string;
        reportTouch?: boolean;
        severity?: ClashSeverity;
        tolerance?: number;
    }
    Index
    a b? clearance? id membersA? membersB? mode name reportTouch? severity? tolerance?
    a: string

    Selector for set A (e.g. IfcDuct*|IfcPipe*, !IfcSpace).

    b?: string

    Selector for set B. Omitted ⇒ self-clash within A.

    clearance?: number

    Required gap (m) for clearance mode.

    id: string
    membersA?: readonly string[]

    Explicit membership for set A — clashMemberKey(model, ref) strings. When present it REPLACES the a selector, so a caller that can resolve a richer filter than a type name (properties, attributes, storeys) against the model can express it. An empty array means "matched nothing", never "everything". See members.ts.

    membersB?: readonly string[]

    Explicit membership for set B, replacing the b selector. See membersA.

    mode: ClashMode
    name: string
    reportTouch?: boolean

    Emit touch-classified results instead of suppressing them.

    severity?: ClashSeverity

    Explicit severity; otherwise inferred from the discipline matrix.

    tolerance?: number

    Touching band (m). Defaults to the run-level tolerance.

    Settings
    Member Visibility

    On This Page
    Properties