BimIfcLoader

Represents a BIM IFC Loader. Responsible for managing a collection of IFC files and loading data from them.

Implements

• BimIfcLoaderElementParent

Index

Constructors

• constructor

Properties

• vertexDataRepository

Accessors

• classes
• disciplines
• floors
• ifcHttpResources
• ifcProductsWithGeometryCount
• loaderElements
• projects
• regionBoundingInfo
• spaces

Methods

• aabb
• add
• addOrGetIfcProductCache
• applyAndResetTrackedVisualChanges
• applyColor
• clear
• deleteIfcProductCache
• foreach
• geometryBuilder
• getRegionBoundingInfo
• loadPropertySets
• products

Constructors

publicconstructor

• new BimIfcLoader(_bimApi: BimCoreApiClient, _propertySetRepository: BimPropertySetRepository, vertexDataRepository: BimVertexDataRepository, _materials: Materials): BimIfcLoader

• Creates a instance of BimIfcLoader class. Responsible for managing a collection of IFC files and loading data from them.

  ---

  Parameters

  • _bimApi: BimCoreApiClient

  • _propertySetRepository: BimPropertySetRepository

  • vertexDataRepository: BimVertexDataRepository

  • _materials: Materials

  Returns BimIfcLoader

Properties

publicreadonlyvertexDataRepository

vertexDataRepository: BimVertexDataRepository

Accessors

publicclasses

• get classes(): BimIfcClass[]

• Implementation of BimIfcLoaderElementParent.classes

  Gets all the IFC classes used by IFC products in the currently loaded IFC files.

  ---

  Returns BimIfcClass[]

  An array of BimIfcClass objects representing the available classes.

publicdisciplines

• get disciplines(): Discipline[]

• Implementation of BimIfcLoaderElementParent.disciplines

  Gets the available disciplines.

  ---

  Returns Discipline[]

  An array of Discipline objects.

publicfloors

• get floors(): BimIfcBuildingStorey[]

• Implementation of BimIfcLoaderElementParent.floors

  Gets the floors (IfcBuildingStorey) available in the currently loaded IFC files.

  ---

  Returns BimIfcBuildingStorey[]

  An array of BimIfcBuildingStorey objects representing the available floors (storey levels).

publicifcHttpResources

• get ifcHttpResources(): BimChangeIfc[]

• Gets the array of BimChangeIfc objects representing the IFC files that are loaded.

  ---

  Returns BimChangeIfc[]

  An array of BimChangeIfc objects.

publicifcProductsWithGeometryCount

• get ifcProductsWithGeometryCount(): number

• Gets the count of IFC products with geometry.

  ---

  Returns number

  The number of IFC products with geometry.

publicloaderElements

• get loaderElements(): BimIfcLoaderElement[]

• Implementation of BimIfcLoaderElementParent.loaderElements

  Gets the BimIfcLoaderElement for the loaded IFC files.

  ---

  Returns BimIfcLoaderElement[]

  An array of BimIfcLoaderElement objects.

publicprojects

• get projects(): BimIfcObject[]

• Implementation of BimIfcLoaderElementParent.projects

  Gets the IfcProject root nodes from each loaded IFC file.

  @remarks

  These can then be used to traverse the IFC file structure by calling foreach, or entries on each project.

  ---

  Returns BimIfcObject[]

  An array of BimIfcObject representing the projects.

publicregionBoundingInfo

• get regionBoundingInfo(): BoundingInfo

• Get the bounding info for loaded IFC files based on the most populated regions of each IFC file, excluding outliers and anomalous regions. The bounding info is derived from the regions with the highest IFC product count in each IFC file. Regions distant from the majority are excluded. The regionBoundingInfo is critical for camera positioning to ensure the entire regionBoundingInfo is within the camera’s frustum. Overly large regionBoundingInfo can result in the camera being too distant, causing visibility issues. This can occur if anomalies are undetectable, e.g., when 50% of regions are proximate while the remaining 50% are outliers but also proximate to each other. This is common when IFC files are modeled in different coordinate systems, leading to disparate global positions for files intended to be co-located. There have been cases where IFC files, that should been co-located, are actually located in widely different places on the globe. Whenever add is called (before clear) this property is updated.

  ---

  Returns BoundingInfo

publicspaces

• get spaces(): BimIfcSpace[]

• Implementation of BimIfcLoaderElementParent.spaces

  Gets the spaces (IfcSpace) available in the currently loaded IFC files..

  ---

  Returns BimIfcSpace[]

  An array of BimIfcSpace objects.

Methods

publicaabb

• aabb(min: Vector3, max: Vector3, ifcProducts: BimIfcObject[], predicate?: (o: BimIfcObject, recursionOptions: BimIfcObjectRecursionOptions) => unknown): void

• Calculates the min and max coordinate of the axis-aligned bounding box (AABB) encompassing a collection of BimIfcObject‘s. The AABB is defined by the minimum and maximum coordinates in each axis. The result is written to the provided min and max vectors.

  ---

  Parameters

  • min: Vector3

    The minimum coordinates of the AABB will be stored in this vector.

  • max: Vector3

    The maximum coordinates of the AABB will be stored in this vector.

  • ifcProducts: BimIfcObject[]

    The collection of BimIfcObject to calculate the AABB for.

  • predicate: (o: BimIfcObject, recursionOptions: BimIfcObjectRecursionOptions) => unknown = DefaultBimIfcObjectForEachPredicate

    The predicate function to filter the BimIfcObject. Defaults to DefaultBimIfcObjectForEachPredicate.

  Returns void

publicadd

• add(ifcFiles: IfcWithOptions[]): Promise<(BimIfcLoaderElement | BimIfcLoaderElementCreateFailure)[]>

• Adds the specified IFC files to the loader.

  @remarks

  When files are added, the loader will load the IFC files and create BimIfcLoaderElement instances for each file. See loaderElements for the created instances. To read the IFC products, present the loaded files, use foreach or products.

  ---

  Parameters

  • ifcFiles: IfcWithOptions[]

    An array of IfcWithOptions objects representing the IFC files to be added.

  Returns Promise<(BimIfcLoaderElement | BimIfcLoaderElementCreateFailure)[]>

  A promise that resolves to an array of BimIfcLoaderElement or BimIfcLoaderElementCreateFailure instances. Use isFailure to check if a returned instance is a failure or not. Its not required to check for failures but it can be useful to know why a file failed to load.

publicaddOrGetIfcProductCache

• addOrGetIfcProductCache<T>(key: string, predicate: BimIfcObjectForEachPredicate): DeepImmutableObject<Set<T>>

• Implementation of BimIfcLoaderElementParent.addOrGetIfcProductCache

  Adds or retrieves the cached set of BimIfcObject instances based on the provided key and predicate. Cache is cleared when clear is called.

  ---

  Type parameters

  • T: BimIfcObject<T> = BimIfcObject

    The type of BimIfcObject to be stored in the cache.

  Parameters

  • key: string

    The key used to identify the cache entry.

  • predicate: BimIfcObjectForEachPredicate

    The predicate function used to filter BimIfcObject instances. If it returns truthy then object is added to cache. Otherwise not

  Returns DeepImmutableObject<Set<T>>

  The cached set of BimIfcObject instances.

publicapplyAndResetTrackedVisualChanges

• applyAndResetTrackedVisualChanges(): undefined | ReadonlySet<BimIfcObject>

• @deprecated

  • No longer does anything.

  ---

  Returns undefined | ReadonlySet<BimIfcObject>

publicapplyColor

• applyColor(): void

• @deprecated

  No longer does anything

  ---

  Returns void

publicclear

• clear(): void

• Implementation of BimIfcLoaderElementParent.clear

  Clears the state of the BimIfcLoader instance. If geometryBuilder has been called, and if it has been used to create Geometry3d instances that have been added to TwinfinityViewer then those instances are NOT removed from the viewer. Call Twinfinity.clear to remove all geometry from the viewer as well.

  ---

  Returns void

publicdeleteIfcProductCache

• deleteIfcProductCache(key: string): boolean

• Implementation of BimIfcLoaderElementParent.deleteIfcProductCache

  Deletes a cache created by addOrGetIfcProductCache-

  ---

  Parameters

  • key: string

    Cache to delete

  Returns boolean

  true if a cache was deleted, otherwise false.

publicforeach

• foreach(action: BimIfcObjectForEachAction): void

• Iterate all IFC objects with a callback. Its also possible to call products to get an iterator.

  ---

  Parameters

  • action: BimIfcObjectForEachAction

    Visitor callback. Called for every IFC object.

  Returns void

publicgeometryBuilder

• geometryBuilder(options?: (ifcProduct: BimIfcObject) => unknown | GeometryBuilderOptions): Promise<IfcGeometryBuilder>

• Creates an IfcGeometryBuilder containing the BimIfcObject instances matched by the provided predicate. If no predicate is provided, all objects will be included.

  @remarks

  The IfcGeometryBuilder can be used to create Geometry3d instances for the matched objects. In order to visualize them use addOrReplaceMesh.

  ---

  Parameters

  • optionaloptions: (ifcProduct: BimIfcObject) => unknown | GeometryBuilderOptions

    Optional predicate function to filter the objects.

  Returns Promise<IfcGeometryBuilder>

  A promise that resolves to an instance of IfcGeometryBuilder.

publicgetRegionBoundingInfo

• getRegionBoundingInfo(onlyMostPopulatedRegions: boolean, useWorldSpace?: boolean): BoundingInfo

• Calculate the bounding info for the currently loaded IFC files based on the most populated regions of each IFC file, excluding outliers and anomalous regions.

  @remarks

  The bounding info is derived from the regions with the highest IFC product count in each IFC file. Regions distant from the majority are excluded. The regionBoundingInfo is critical for camera positioning to ensure the entire regionBoundingInfo is within the camera’s frustum. Overly large regionBoundingInfo can result in the camera being too distant, causing visibility issues. This can occur if anomalies are undetectable, e.g., when 50% of regions are proximate while the remaining 50% are outliers but also proximate to each other. This is common when IFC files are modeled in different coordinate systems, leading to disparate global positions for files intended to be co-located. There have been cases where IFC files, that should been co-located, are actually located in widely different places on the globe.

  ---

  Parameters

  • onlyMostPopulatedRegions: boolean

    Indicates whether to include only the most populated regions.

  • useWorldSpace: boolean = true

    Indicates whether to use world space coordinates. Default is true

  Returns BoundingInfo

  The bounding information for the regions.

publicloadPropertySets

• loadPropertySets(): Promise<void>

• Loads the property sets for currently loaded IFC files add. If property sets are already loaded then this method does nothing.

  ---

  Returns Promise<void>

  A promise that resolves when all property sets have been loaded.

publicproducts

• products(): IterableIterator<BimIfcObject>

• Gets a iterator for all Ifc products currently loaded.

  ---

  Returns IterableIterator<BimIfcObject>