IFClite TypeScript API
    Preparing search index...

    Interface RelatedEntityOptions

    Which relationship kinds collectRelatedEntities expands from the seed selection, and how far. Every boolean defaults to what the doc comment says, not to false — an omitted RelatedEntityOptions (or an omitted field within one) must reproduce the bug the seed exhibits, which usually needs its host/opening/type/material context, not a bare, disconnected element.

    interface RelatedEntityOptions {
        IfcRelAggregates?: "down" | "none" | "up" | "both";
        IfcRelAssociatesMaterial?: boolean;
        IfcRelConnectsPathElementsDepth?: number;
        IfcRelContainedInSpatialStructure?: boolean;
        IfcRelDefinesByProperties?: boolean;
        IfcRelDefinesByType?: boolean;
        IfcRelFillsElement?: boolean;
        IfcRelNests?: "down" | "none" | "up" | "both";
        IfcRelVoidsElement?: boolean;
    }
    Index
    IfcRelAggregates?: "down" | "none" | "up" | "both"

    Aggregate parents/children (IfcRelAggregates): 'up' walks to RelatingObject only, 'down' to RelatedObjects only, 'both' walks both directions, 'none' skips it. Default 'both'.

    IfcRelAssociatesMaterial?: boolean

    An included object's material assignment (IfcRelAssociatesMaterial). Default true.

    IfcRelConnectsPathElementsDepth?: number

    BFS depth (both directions) to walk IfcRelConnectsPathElements from an included element — e.g. a wall's structurally-connected neighbour. Default 0 (no expansion).

    IfcRelContainedInSpatialStructure?: boolean

    The spatial containment chain (IfcRelContainedInSpatialStructure) up to storey/building/site. Default true; regardless of this flag, IfcProject is ALWAYS included — a STEP file with no project is not a valid reproduction of anything.

    IfcRelDefinesByProperties?: boolean

    An included object's property sets (IfcRelDefinesByProperties). Default false — psets are the majority of what this feature exists to strip, so expanding them is opt-in, and turning this on still pulls in ePSet_MapConversion/ePSet_ProjectedCRS style georeferencing psets unless those are separately excluded.

    IfcRelDefinesByType?: boolean

    An included object's IfcTypeObject (IfcRelDefinesByType). Default true.

    IfcRelFillsElement?: boolean

    The filler↔opening↔host chain (a window/door and the wall it sits in). Default true.

    IfcRelNests?: "down" | "none" | "up" | "both"

    Nesting parents/children (IfcRelNests) — a separate EXPRESS relationship from IfcRelAggregates even though the parser folds both into the same aggregation edge type on RelationshipGraph; this option is split out from the one above by REL ENTITY TYPE, not by graph edge, so a caller can toggle them independently. Default 'down'.

    IfcRelVoidsElement?: boolean

    Openings of an included host element. Default true.