@twinfinity/core
    Preparing search index...

    Interface IfcWithOptions

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

    interface IfcWithOptions {
        apiUrl: string;
        availableLayerDefinitions: LayerDefinitions;
        blobId: string;
        classes: ModelProductClass[];
        containerId: string;
        discipline: Discipline;
        etag: string;
        floors: IfcFloor[];
        format: string;
        id: string;
        loadOptions?: BimApiIfcObjectsLoadOptions;
        metadata: BimChangeIfcMetadata & BimChangeBaseMetadata;
        name: string;
        ownerSystem: string;
        path: string;
        permissions: Permissions;
        permissionsString: string;
        productCount: number;
        resourceUrl: HttpIfcResourceUrls;
        transform?: Matrix;
        type: BlobWithGeometry;
        url: string;
        version: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    apiUrl availableLayerDefinitions blobId classes containerId discipline etag floors format id loadOptions? metadata name ownerSystem path permissions permissionsString productCount resourceUrl transform? type url version

    Properties

    apiUrl: string

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

    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.

    blobId: string

    Id of blob that contains the geometry

    classes: ModelProductClass[]

    Set of IfcClasses available in the IFC file

    containerId: string

    Id of BimContainer to which this change belongs.

    discipline: Discipline

    Discipline. Example A, K, V etc

    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.

    floors: IfcFloor[]

    Floors (IfcBuildingStorey) available in IFC file

    format: string

    Format of change.

    id: string

    Id of change.

    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.

    metadata: BimChangeIfcMetadata & BimChangeBaseMetadata

    IFC change metadata.

    name: string

    Name of change.

    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'.

    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.

    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.

    permissionsString: string

    String used to represent the permissions bitmask.

    productCount: number

    Number of IFC products available in this change

    resourceUrl: HttpIfcResourceUrls

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

    transform?: Matrix

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

    type: BlobWithGeometry

    Indicates that we have a change with ifc

    url: string

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

    version: number

    Version of change

    Settings

    Member Visibility

    On This Page

    Properties