The install stops with an authentication error
@opengeometry/floorkit is a public package and needs no token. This error has one usual cause: an .npmrc file sends an old token to the npm registry. The file can be in your app, in your home folder or in your CI.
Renew the token or remove it. Then install again.
The geometry kernel does not start
Look at the network panel of your browser and find the request for the.wasm file.
- 404 or an HTML page: the address is wrong. Pass the correct address to
setupOpenGeometry. With Vite, import the file with?url. See Installation. - The request is correct but geometry fails: you created geometry before the setup finished. Await
setupOpenGeometry()first.
The console says “Multiple instances of Three.js being imported”
Your app has two copies of Three.js. The text package that Floorkit uses asks for a newer Three.js than your app has, so npm installs a second copy for it. The app runs, but it is larger, and text is made by a different copy than your scene. Tell npm to use your copy everywhere. Add this to thepackage.json of your app:
node_modules and package-lock.json and install again. npm ls three must show one version.
An error says “Scene not assigned”
You created a datum, a dimension or a room label before Floorkit had a scene for its text. Callawait setGlyphScene(scene, camera) after the kernel setup and before you create these objects. See Use your Three.js scene.
The canvas is blank
Check these things in sequence:- The container of the canvas has a width and a height.
- Your render loop calls
renderer.render(scene, camera). session.rootis in the scene.- The camera looks at the building. A building near
[0, 0, 0]is not visible from inside a wall. - The scene has a light.
A view stops and shows “This site needs a floorkit license”
The page is on a deployed site and has no valid license key. Floorkit is free onlocalhost. Each other hostname needs a key, and this includes an address on your local network such as 192.168.1.20.
Read getLicenseState() and see Licensing.
A view goes blank and shows no message
The “made with floorkit” badge is hidden or covered by your interface. Keep the bottom-right corner of the view free. The view draws again when the badge is visible.A door or a window does not cut its wall
In a building model, a door must be an entry in theopenings of its wall. A door in unhostedOpenings is a free door and cuts nothing.
With element classes, call wall.attachDoor(door, ...) and then wall.commitOpeningCuts(). A door that you only add to the scene cuts nothing.
apply throws an error
After each of these errors, the building is the same as before the edit.
A change is gone after I reopen the project
The change was not in the model that you saved. Two causes are usual:- You changed a mesh or an element object directly. Use an edit command.
- You saved an old model. Put
session.snapshot()into the project before you callsaveProject.
A view cannot be drawn
drawProjectView and exportProjectPdf throw ProjectDrawingError with a code.
For a section,
unsupported-element can also mean that the cut line or the far limit of the view touches a wall face or the edge of an opening. Move the line by some centimetres. See Cut a section.
An export fails because of raster views
A sheet shows an isometric view, and its image is missing or old. CallprepareProjectRasterViews after the last model change, and pass the result to the export in rasterViews.
Memory grows when I close and open views
Something was not disposed. When a view closes, stop the render loop, dispose the editors, removesession.root, call session.dispose() and dispose your renderer. See Clean up.