Skip to main content

IfcWithOptions

Represents the data structure for loading an IFC file with additional options.

Hierarchy

Index

Properties

Properties

readonlyapiUrl

apiUrl: string

Contains base API URL to use when calling backend methods for this particular item.

readonlyavailableLayerDefinitions

availableLayerDefinitions: LayerDefinitions

List of layers, that can be added to this change, together with the permission that the current user has for each of them.

readonlyblobId

blobId: string

Id of blob that contains the geometry

readonlyclasses

classes: BimIfcClass[]

Set of IfcClasses available in the IFC file

readonlycontainerId

containerId: string

Id of BimContainer to which this change belongs.

readonlydiscipline

discipline: Discipline

Discipline. Example A, K, V etc

readonlyetag

etag: string

etag for change. Used for optimistic concurrency checks and in operations where we want to check if data has changed or not since last etag we have.

readonlyfloors

floors: IfcFloor[]

Floors (IfcBuildingStorey) available in IFC file

readonlyformat

format: string

Format of change.

readonlyid

id: string

Id of change.

optionalloadOptions

loadOptions?: BimApiIfcObjectsLoadOptions

Extra options for loading the IFC file. Normally used to prevent geometry being loaded for certain IFC objects or to set the visibility of IFC objects.

readonlymetadata

metadata: BimChangeIfcMetadata & BimChangeBaseMetadata

IFC change metadata.

readonlyname

name: string

Name of change.

readonlyownerSystem

ownerSystem: string

Id of system that the change originated from. If a change in Twinfinity was created because an external system pushed it into Twinfinity then the id will refer to that system. If change originates from Twinfinity (for example because a file was uploaded by a user) then the id will always be ‘twinfinity’.

readonlypath

path: string

Unique path for the change. Each change has one. If the change or one of its parents are renamed then the path will change.

readonlypermissions

permissions: Permissions

64 bit permission bitmask. Used to verify that a user has required permissions on a change. Since there is no native JSON support for bitmasks, the value is derived from permissionsString.

readonlypermissionsString

permissionsString: string

String used to represent the permissions bitmask.

readonlyproductCount

productCount: number

Number of IFC products available in this change

readonlyresourceUrl

resourceUrl: HttpIfcResourceUrls

Urls of .idx, .geom and .prop files available for the .ifc file.

optionaltransform

transform?: Matrix

The transformation to be applied to the loaded IFC file. This is useful for positioning the IFC file in the world.

readonlytype

type: BlobWithGeometry

Indicates that we have a change with ifc

readonlyurl

url: string

URL of change content. Points to the endpoint where the content of the change can be retrieved by a simple GET request.

readonlyversion

version: number

Version of change