BimIfcObject

This class contains the structure of an IFC Object

Hierarchy

• BimIfcObject
  • BimIfcSpace
  • BimIfcBuildingStorey
  • BimIfcDoor

Index

Properties

• class
• enclosingFloor
• entityLabelInIfc
• ifcLoaderElement
• parents
• properties
• quantifiers
• rawProduct
• visible

Accessors

• bbox
• building
• childCount
• children
• description
• discipline
• gid
• hasGeometry
• ifc
• name
• parent
• productMeshes
• project
• site
• type

Methods

• aabb
• applyColor
• boundingInfo
• computeObjectBboxInWorldSpace
• copyColorTo
• copyColorsTo
• defaultColor
• entries
• foreach
• geometricallyIntersects
• getColorComponent
• ghostOutline
• highlight
• isOnGpu
• mesh
• meshDescriptor
• remove
• setColor
• setColors
• style
• transform
• vertexData
• create
• createGeometryFrom
• createGeometryFromAsync

Properties

publicreadonlyclass

class: BimIfcClass

Returns the class object for IFC-product

publicoptionalreadonlyenclosingFloor

enclosingFloor?: BimIfcBuildingStorey

publicreadonlyentityLabelInIfc

entityLabelInIfc: string

publicreadonlyifcLoaderElement

ifcLoaderElement: IBimIfcLoaderElement

publicreadonlyparents

parents: BimIfcObject[]

publicreadonlyproperties

properties: DeepImmutableObject<BimPropertySets> = ...

Contains all property sets for this product Readonly

publicreadonlyquantifiers

quantifiers: DeepImmutableObject<BimPropertySets> = ...

Contains all quantifiers for this product Readonly

publicreadonlyrawProduct

rawProduct: BimProduct

publicreadonlyvisible

visible: (visible?: boolean, meshes?: BimProductMesh[]) => boolean

Returns true if object is visible

---

Type declaration

• • (visible?: boolean, meshes?: BimProductMesh[]): boolean

  • Parameters

    • optionalvisible: boolean

    • optionalmeshes: BimProductMesh[]

    Returns boolean

Accessors

publicbbox

• get bbox(): SimpleBoundingBox

• @deprecated

  Use boundingInfo or aabb.

  ---

  Returns SimpleBoundingBox

publicbuilding

• get building(): undefined | BimIfcObject

• Returns undefined | BimIfcObject

publicchildCount

• get childCount(): number

• Returns number

publicchildren

• get children(): BimIfcObject[]

• All children IFC objects.

  ---

  Returns BimIfcObject[]

publicdescription

• get description(): string

• Returns string

publicdiscipline

• get discipline(): Discipline

• Returns the discipline class for this IFC-product

  ---

  Returns Discipline

publicgid

• get gid(): string

• Returns string

publichasGeometry

• get hasGeometry(): boolean

• Returns boolean

publicifc

• get ifc(): BimChangeIfc

• Returns BimChangeIfc

publicname

• get name(): string

• Returns name of IFC-product

  ---

  Returns string

publicparent

• get parent(): undefined | BimIfcObject

• Get the closest parent in the IFC hiearchy. Equivalent of

  @example

  const parent = bimIfcObject.parents[bimIfcObjects.parents.length -1];

  ---

  Returns undefined | BimIfcObject

publicproductMeshes

• get productMeshes(): BimProductMesh[]

• Returns BimProductMesh[]

publicproject

• get project(): BimIfcObject

• Returns BimIfcObject

publicsite

• get site(): undefined | BimIfcObject

• Returns undefined | BimIfcObject

publictype

• get type(): undefined | BimTypeObject

• Returns undefined | BimTypeObject

Methods

publicaabb

• aabb(min: Vector3, max: Vector3, predicate?: (o: BimIfcObject, recursionOptions: BimIfcObjectRecursionOptions) => unknown, clearTransformCache?: boolean): void

• Calculates the min and max value in the coordinate system.

  ---

  Parameters

  • min: Vector3

    Minimum bounding vector3

  • max: Vector3

    Maximum bounding vector3

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

    ?

  • clearTransformCache: boolean = true

    ?

  Returns void

publicapplyColor

• applyColor(): void

• @deprecated

  No longer does anything.

  ---

  Returns void

publicboundingInfo

• boundingInfo(bI?: BoundingInfo, predicate?: (o: BimIfcObject, recursionOptions: BimIfcObjectRecursionOptions) => unknown, clearTransformCache?: boolean): BoundingInfo

• Parameters

  • optionalbI: BoundingInfo

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

  • clearTransformCache: boolean = true

  Returns BoundingInfo

publiccomputeObjectBboxInWorldSpace

• computeObjectBboxInWorldSpace(): SimpleBoundingBox

• alpha

  Aggregates a bbox from current objects meshes. This does not include related children. This is alpha. Expect changes. Will probably be replaced by one of the other bounding info functions.

  @deprecated

  Use boundingInfo or aabb.

  ---

  Returns SimpleBoundingBox

publiccopyColorTo

• copyColorTo(m: BimProductMesh, dst: Writeable<ArrayLike<number>>, dstOffset?: number): void

• Parameters

  • m: BimProductMesh

  • dst: Writeable<ArrayLike<number>>

  • dstOffset: number = 0

  Returns void

publiccopyColorsTo

• copyColorsTo(dst: Pick<Map<BimProductMesh, Writeable<ArrayLike<number>>>, set | get>): void

• Parameters

  • dst: Pick<Map<BimProductMesh, Writeable<ArrayLike<number>>>, set | get>

  Returns void

publicdefaultColor

• defaultColor(meshes?: BimProductMesh[]): boolean

• Parameters

  • optionalmeshes: BimProductMesh[]

  Returns boolean

publicentries

• entries(): IterableIterator<BimIfcObject, any, any>

• Gets a iterator for all Ifc products currently loaded.

  ---

  Returns IterableIterator<BimIfcObject, any, any>

publicforeach

• foreach(action: BimIfcObjectForEachAction): void

• Parameters

  • action: BimIfcObjectForEachAction

  Returns void

publicgeometricallyIntersects

• geometricallyIntersects(objects: BimIfcObject[], includeEnclosedObjects?: boolean, includeIntersectingObjects?: boolean): BimIfcObject[]

• Checks intersections of an object (containing object) against an array of other objects.

  ---

  Parameters

  • objects: BimIfcObject[]

    Array of objects to test intersection against.

  • includeEnclosedObjects: boolean = true

    Default is true, it includes geometries completely geometrically on the inside, in the returned result.

  • includeIntersectingObjects: boolean = true

    Default is true, it includes geometries that intersects on border surface, in the returned result. If both enclosedObjects and intersectingObjects are false, the function will make a quick rough test based on bbox and return all objects intersecting and enclosing on bounding box level.

  Returns BimIfcObject[]

publicgetColorComponent

• getColorComponent(m: BimProductMesh, colorComponent: RgbaComponent): number

• Parameters

  • m: BimProductMesh

  • colorComponent: RgbaComponent

  Returns number

publicghostOutline

• ghostOutline(enabled: boolean, meshes?: BimProductMesh[]): boolean

• Makes the object give an ghosty outline when either SSAO or line outlines are enabled. It does this by making the object invisible but also flag it to still write to the depth buffer used by the lines and SSAO

  ---

  Parameters

  • enabled: boolean

    If true the object will be hidden but will also be set to still write to the depth buffer

  • optionalmeshes: BimProductMesh[]

    The specific meshes of the object to apply this method on

  Returns boolean

  A bool indicating if any of the objects meshes was changed as a result of this method call

publichighlight

• highlight(highlightIndex?: IfcMaterialHighlightIndex, meshes?: BimProductMesh[]): boolean

• Highlights the object

  ---

  Parameters

  • highlightIndex: IfcMaterialHighlightIndex = IfcMaterialHighlightIndex.One

    The highlight color index to use, setting it to zero means the mesh will not be highlighted

  • optionalmeshes: BimProductMesh[]

    The meshes to highlight

  Returns boolean

  a boolean indicating if the object was changed from the highlighting

publicisOnGpu

• isOnGpu(meshes?: BimProductMesh[]): boolean

• Parameters

  • optionalmeshes: BimProductMesh[]

  Returns boolean

publicmesh

• mesh(m: BimProductMesh, clearTransformCache?: boolean): BimIfcMesh

• Parameters

  • m: BimProductMesh

  • clearTransformCache: boolean = true

  Returns BimIfcMesh

publicmeshDescriptor

• meshDescriptor(pM: BimProductMesh): BimProductMeshDescriptor

• Parameters

  • pM: BimProductMesh

  Returns BimProductMeshDescriptor

publicremove

• remove(): void

• Remove the IFC object and its children from the IFC hiearchy.

  ---

  Returns void

publicsetColor

• setColor(color: ArrayLike<number>, meshes?: BimProductMesh[]): boolean

• Parameters

  • color: ArrayLike<number>

  • optionalmeshes: BimProductMesh[]

  Returns boolean

publicsetColors

• setColors(src: Iterable<[BimProductMesh, ArrayLike<number>], any, any>): boolean

• Parameters

  • src: Iterable<[BimProductMesh, ArrayLike<number>], any, any>

  Returns boolean

publicstyle

• style(m: BimProductMesh): BimIfcStyle

• Parameters

  • m: BimProductMesh

  Returns BimIfcStyle

publictransform

• transform(m: BimProductMesh, clearTransformCache?: boolean): Matrix

• Parameters

  • m: BimProductMesh

  • clearTransformCache: boolean = true

  Returns Matrix

publicvertexData

• vertexData(m: BimProductMesh): BimVertexData

• Parameters

  • m: BimProductMesh

  Returns BimVertexData

publicstaticcreate

• create(ifcLoaderElement: IBimIfcLoaderElement): BimIfcObject

• Parameters

  • ifcLoaderElement: IBimIfcLoaderElement

  Returns BimIfcObject

publicstaticcreateGeometryFrom

• createGeometryFrom(items: (BimIfcObject | { ifcObject: BimIfcObject; meshes: BimProductMesh[] })[]): Geometry3d

• Creates a geometry consisting of all specified IFC objects (or specific meshes.).

  ---

  Parameters

  • items: (BimIfcObject | { ifcObject: BimIfcObject; meshes: BimProductMesh[] })[]

    All objects that will be combined. It is possible to optionally specify exactly which BimProductMesh that are to be used on each IFC object. If none is specified, then all meshes in the IFC objects are used. Geom. Items where BimIfcObject.isOnGpu === false will not be included in the final Geometry3d.

  Returns Geometry3d

  A Geometry3d instance that represents all geometry. Note that the geometry is in IFC space and not BabylonJS worldspace.

publicstaticcreateGeometryFromAsync

• createGeometryFromAsync(items: (BimIfcObject | { ifcObject: BimIfcObject; meshes: BimProductMesh[] })[]): Promise<Geometry3d>

• Creates a geometry consisting of all specified IFC objects (or specific meshes.).

  ---

  Parameters

  • items: (BimIfcObject | { ifcObject: BimIfcObject; meshes: BimProductMesh[] })[]

    All objects that will be combined. It is possible to specify multiple BimProductMesh to be used on each IFC object. If none are specified, then all meshes in the IFC objects are used. When BimIfcObject.isOnGpu === false, the geometry will automatically be loaded and included in the final Geometry3d.

  Returns Promise<Geometry3d>

  A Geometry3d instance that represents all geometry. Note that the geometry is in IFC space and not BabylonJS worldspace.