ViewerUI

Constructs a ViewerUI.

De-selects all objects currently in the viewer.

Destroys the viewer, freeing all resources.

Returns the IDs of the currently loaded models, if any.

Returns the ID of the currently loaded project, if any.

Gets information on a project.

Use ViewerUI#getProjects to get information on all available projects.

Example

myViewer.getProjectInfo(("Duplex") => {
     console.log(JSON.stringify(projectInfo, null, "\t"));
});

Returns JSON similar to:

{
     "id": "Duplex",
     "name": "Duplex"
}

Gets information on all available projects.

Example

myViewer.getProjectsInfo((projectsInfo) => {
     console.log(JSON.stringify(projectsInfo, null, "\t"));
});

Returns JSON similar to:

{
     "projects": [
         {
             "id": "Duplex",
             "name": "Duplex"
         },
         {
             "id": "Schependomlaan",
             "name": "Schependomlaan"
         },
         {
             "id": "WestRiversideHospital",
             "name": "West Riverside Hospital"
         }
    ]
}

Hides all objects currently in the viewer.

Hides all objects currently in the viewer, except for those with the given IDs.

Hides the object with the given ID.

Sets viewer state to the given BCF viewpoint.

This assumes that the viewer currently contains the same project and model(s) that were loaded at the time that the viewpoint was originally saved (the BCF viewpoint specification does not contain that information).

Note that xeokit's Camera#look is the point-of-interest, whereas the BCF camera_direction is a direction vector. Therefore, when loading a BCF viewpoint, we set Camera#look to the absolute position obtained by offsetting the BCF camera_view_point along camera_direction.

When loading a viewpoint, we also have the option to find Camera#look as the closest point of intersection (on the surface of any visible and pickable Entity) with a 3D ray fired from camera_view_point in the direction of camera_direction.

Loads a model into the viewer.

Assumes that the project that contains the model is currently loaded.

Loads a project into the viewer.

Unloads any project and contained models that are already loaded.

Opens the specified viewer tab.

The available tabs are:

• "models" - the Models tab, which lists the models available within the currently loaded project,
• "objects" - the Objects tab, which contains a tree view for each loaded model, organized to indicate the containment hierarchy of their objects,
• "classes" - the Classes tab, which contains a tree view for each loaded model, with nodes grouped by IFC types of their objects, and
• "storeys" - the Storeys tab, which contains a tree view for each loaded model, with nodes grouped within IfcBuildingStoreys, sub-grouped by their IFC types.

Resets the view.

Saves viewer state to a BCF viewpoint.

This does not save information about the project and model(s) that are currently loaded. When loading the viewpoint, the viewer will assume that the same project and models will be currently loaded (the BCF viewpoint specification does not contain that information).

Note that xeokit's Camera#look is the point-of-interest, whereas the BCF camera_direction is a direction vector. Therefore, we save camera_direction as the vector from Camera#eye to Camera#look.

Example:

const viewpoint = viewerUI.saveBCFViewpoint({
    spacesVisible: false,          // Default
    spaceBoundariesVisible: false, // Default
    openingsVisible: false         // Default
});

// viewpoint will resemble the following:

{
    perspective_camera: {
        camera_view_point: {
            x: 0.0,
            y: 0.0,
            z: 0.0
        },
        camera_direction: {
            x: 1.0,
            y: 1.0,
            z: 2.0
        },
        camera_up_vector: {
            x: 0.0,
            y: 0.0,
            z: 1.0
        },
        field_of_view: 90.0
    },
    lines: [],
    clipping_planes: [{
        location: {
            x: 0.5,
            y: 0.5,
            z: 0.5
        },
        direction: {
            x: 1.0,
            y: 0.0,
            z: 0.0
        }
    }],
    bitmaps: [],
    snapshot: {
        snapshot_type: png,
        snapshot_data: "data:image/png;base64,......"
    },
    components: {
        visibility: {
            default_visibility: false,
            exceptions: [{
                ifc_guid: 4$cshxZO9AJBebsni$z9Yk,
                originating_system: xeokit.io,
                authoring_tool_id: xeokit/v1.0
            }]
       },
        selection: [{
           ifc_guid: "4$cshxZO9AJBebsni$z9Yk",
        }]
    }
}

Selects all objects currently in the viewer.

Selects all objects currently in the viewer, except for those with the given IDs.

Selects the objects with the given ID.

Enables or disables the various buttons and controls throughout the viewer.

This also makes various buttons appear disabled.

Shows all objects currently in the viewer.

Shows all objects currently in the viewer, except for those with the given IDs.

Shows the object with the given ID.

Unloads a model from the viewer.

Does nothing if the model is not currently loaded.

Unloads all currently loaded models.

X-rays all objects currently in the viewer.

X-rays all objects currently in the viewer, except for those with the given IDs.

Un-x-rays all objects currently in the viewer.

X-ray the object with the given ID.