The data flow
The four parts
The document is the source
The building model stores the design. A project file also keeps your named views and sheets. Floorkit makes the geometry again when you open that file.- A change to the document changes the 3D model and each drawing.
- A change to a mesh in your scene changes nothing in the document. Do not edit meshes.
- You choose the id of each wall, door and room. Floorkit keeps these ids, so your app can find an element again.
Two ways to make geometry
With a document. You write a building model. UseProjectManager for a product with editors, views, sheets, saving, and one history. It owns the BuildingSession that checks commands and builds geometry. Use a session directly when your app manages the other project data separately. See Save and reopen.
With element classes. You create objects such as new Wall(...) or new Slab(...) and add them to your scene. Use this way for one object or a small test. Your app must keep these objects, and Floorkit does not save them.
What your app does
Floorkit does not make a page, a toolbar or a file dialog. Your app does these things:- It makes the Three.js scene, the camera and the renderer.
- It starts the geometry kernel one time. See Installation.
- It stores project text from
manager.save()or, for the direct-session route,saveProject. - It connects its AI provider to validation and supported commands. See Build with agents.
Next
Building model
Learn the structure of the document.
Editing and history
Learn how a session applies an edit.