Skip to main content

BimApiLoadOptionsWithIfcChangePredicate

Load options to use when IFC files in a container needs to match a specified predicate in order to be loaded. Useful when you for example only want to load files with of type disicpline A.

Hierarchy

Index

Properties

Methods

Properties

readonlyifcChangePredicate

ifcChangePredicate: (o: BimChangeIfc) => boolean

Type declaration

optionalreadonlyifcObjectHasGeometryPredicate

ifcObjectHasGeometryPredicate?: (o: BimIfcObject) => boolean

Type declaration

    • All BimIfcObject matching this criteria will be marked with hasGeometry = false so that they can not be visualized (no geometry data will be loaded)

      Parameters

      Returns boolean

optionalreadonlyisIfcObjectVisiblePredicate

isIfcObjectVisiblePredicate?: (o: BimIfcObject) => boolean

Type declaration

    • Determines if object is initially visible or not. Only valid if hasGeometryPredicate is not defined or returns true for the object.

      Parameters

      Returns boolean

loadGeometry

loadGeometry: boolean

If true then geometry is loaded automatically.

loadPropertySets

loadPropertySets: boolean

If true then property sets are loaded automatically. No call to () is needed.

optionalremoveLeafIfcObjectsWithNoGeometry

removeLeafIfcObjectsWithNoGeometry?: boolean

Determines whether leaf nodes in the IFC hierarchy, with no geometry, should be removed during loading. Defaults to false.

throwOnNoIfcChanges

throwOnNoIfcChanges: boolean

Throw exception when ifcChangePredicate is applied to a list of BimChangeIfc and the result is a empty collection.

Methods

toExplicitLoadOptions

  • Converts a BimApiLoadOptionsWithIfcChangePredicate instance to a BimApiLoadOptionsWithExplicitIfcChanges. This allows a user to specify exactly which ifc files that shall be loaded (for example external files can be added to ifcChanges). Do note that if ifc files previusly marked as not loadable and any new ifc’s that are added will still be subject to the filters (ifcObjectHasGeometryPredicate and isIfcObjectVisiblePredicate). Hence if those filters are specified and don’t match anything in the files that are marked for load then objects from those files will still not be visible (and may not even get geometry).

    Parameters

    • ifcChanges: BimChangeIfc[]

      Collection of ifc files that will be initially included in ifcChanges. Only items matching ifcChangePredicate will initially be marked for loading.

    Returns BimApiLoadOptionsWithExplicitIfcChanges