Skip to main content
The user then edits the building in the 3D view, and each edit goes into the session.

Import

Example

Notes

  • Add session.root to your scene one time.
  • hostedOpeningDetachTolerance is a distance in metres. When the user moves a door or a window farther than this from its wall, it leaves the wall.
  • Set onError to show an edit that Floorkit rejected.
  • Dispose the editor before the session.

Signature

Parameters

GUIEditor
required
BuildingSession
required
ManagedSceneBindingOptions
Default: {}.

Returns

Types

ManagedSceneBindingOptions

(error: unknown) => void
number
Metres from every wall beyond which a dragged door or window leaves its wall; default 0.35.
ManagedEditHistory
Undo and redo through another history, such as a project manager; default is the session.
Last modified on October 11, 2026