Skip to main content

BimIfcSpace

This class contains the structure of an IFC Object

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

publicconstructor

Properties

publicreadonlyclass

class: ModelProductClass

Returns the class object for IFC-product

publicreadonlycomputedPropertySets

computedPropertySets: Record<string, T8PropertySet<T8Unit>> = emptyRecord

Computed property sets added by Twinfinity processing.

publicoptionalreadonlyenclosingFloor

enclosingFloor?: BimIfcBuildingStorey

publicreadonlyentityLabelInIfc

entityLabelInIfc: string

publicreadonlyhasGeometry

hasGeometry: boolean

True if this product has at least one mesh with geometry data.

publicreadonlyifcLoaderElement

ifcLoaderElement: IBimIfcLoaderElement

publicreadonlyparents

parents: BimIfcObject[]

publicreadonlypropertySets

propertySets: Record<string, T8PropertySet<T8Unit>> = emptyRecord

IFC property sets (e.g. Pset_WallCommon).

publicreadonlyquantitySets

quantitySets: Record<string, T8QuantitySet<T8Unit>> = emptyRecord

IFC quantity sets (e.g. Qto_WallBaseQuantities).

publicreadonlyrawProduct

rawProduct: BimProduct

publicreadonlyvisible

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

Returns true if object is visible

Type declaration

Accessors

publicaggregates

  • Products related via IfcRelAggregates (decomposition). Empty when hasStructuredRelationships is false.

    Returns readonly BimIfcObject[]

publicbbox

  • @deprecated

    Use boundingInfo or aabb.

    Returns SimpleBoundingBox

publicbuilding

  • Returns undefined | BimIfcObject

publiccalculatedArea

  • get calculatedArea(): number

  • Returns number

publicchildCount

  • get childCount(): number

  • Returns number

publicchildren

  • All children IFC objects.

    Returns BimIfcObject[]

publicclassName

  • get className(): string

  • Full IFC class name including prefix (e.g. 'IfcWall', 'IfcDoor').

    Returns string

publiccontains

  • Products related via IfcRelContainedInSpatialStructure (spatial containment). Empty when hasStructuredRelationships is false.

    Returns readonly BimIfcObject[]

publicdata

  • get data(): Record<string, string | number | boolean>

  • Product-level scalar data values (e.g. operationType, objectPlacement).

    Returns Record<string, string | number | boolean>

publicdescription

  • get description(): string

  • Returns string

publicdiscipline

  • Returns the discipline class for this IFC-product

    Returns Discipline

publicelevationWithFlooring

  • get elevationWithFlooring(): number

  • Returns number

publicfacility

  • The IfcBuilding (or IfcFacility) ancestor of this product.

    Returns undefined | BimIfcObject

publicfacilityPart

  • The IfcBuildingStorey (or IfcFacilityPart) ancestor of this product.

    Returns undefined | BimIfcBuildingStorey

publicgid

  • get gid(): string

  • Returns string

publicglobalId

  • get globalId(): string

  • IFC GlobalId (GUID), unique across all models.

    Returns string

publichasStructuredRelationships

  • get hasStructuredRelationships(): boolean

  • True when aggregates and contains carry structured IFC relationship data (IfcRelAggregates / IfcRelContainedInSpatialStructure). When false, only children is populated.

    Returns boolean

publicifc

publiclocalId

  • get localId(): number

  • Numerical identifier, unique within a single model.

    Returns number

publiclongname

  • get longname(): undefined | string

  • Returns undefined | string

publicmeshes

  • Geometry meshes belonging to this product.

    Returns readonly BimProductMesh[]

publicname

  • get name(): string

  • Returns name of IFC-product

    Returns string

publicparent

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

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

    Returns undefined | BimIfcObject

publicproductMeshes

publicproject

publicsite

  • The IfcSite ancestor of this product.

    Returns undefined | BimIfcObject

publicspaceType

  • get spaceType(): undefined | string

  • Returns undefined | string

publictype

  • get type(): undefined | BimTypeObject

  • The entity type definition this product is an instance of (e.g. an IfcWallType).

    Returns undefined | BimTypeObject

Methods

publicaabb

  • 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

      ?

      • noCache: boolean = true

        If true, transform caches will not be used.

      Returns void

    publicapplyColor

    • applyColor(): void
    • @deprecated

      No longer does anything.

      Returns void

    publicboundingInfo

    • Parameters

      Returns BoundingInfo

    publiccomputeObjectBboxInWorldSpace

    • 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

    • Parameters

      Returns boolean

    publicdeleteComputedPropertySet

    • deleteComputedPropertySet(name: string): boolean

    • Parameters

      • name: string

      Returns boolean

    publicentries

    • Gets a iterator for all Ifc products currently loaded.

      Returns IterableIterator<BimIfcObject, any, any>

    publicforeach

    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

      Returns number

    publicghostOutline

    • 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

    • 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

    • Parameters

      Returns boolean

    publicmesh

    publicmeshDescriptor

    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

      Returns boolean

    publicsetColors

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

    • Parameters

      Returns boolean

    publicsetComputedPropertySet

    • Parameters

      Returns void

    publicstyle

    publictransform

    • Parameters

      Returns Matrix

    publicvertexData

    publicstaticcreate

    publicstaticcreateGeometryFrom

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

      Parameters

      Returns Geometry3d

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

    publicstaticcreateGeometryFromAsync

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

      Parameters

      Returns Promise<Geometry3d>

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

    Page Options