diff --git a/src/bonsai/docs/guides/viewing/dealing_with_large_models.rst b/src/bonsai/docs/guides/viewing/dealing_with_large_models.rst index 5467883ace..3b110b9567 100644 --- a/src/bonsai/docs/guides/viewing/dealing_with_large_models.rst +++ b/src/bonsai/docs/guides/viewing/dealing_with_large_models.rst @@ -18,6 +18,30 @@ Models may be large in terms of different metrics, such as: There are always solutions to all of these, but an understanding of the type of size limitation you are up against will always help. +Linking in models +----------------- + +Bonsai defaults to authoring IFCs. This allows full editing and inspection of +all element properties and relationships. However, sometimes only geometry and +basic attributes such as names are sufficient. Example usecases include CG +visualisation, overall federated model coordination, or pure geometric checks. + +For these usecases, it's much more efficient to link a model rather than to +open a model. In the **Links Panel**, click on **Link IFC**, and browse to your +IFC. You can also bulk select multiple IFCs. + +You will not be able to directly edit geometry or data in a linked model, but +you will be able to efficiently load multiple huge models easily and navigate +it with a reasonable FPS. + +Activate the **Explore Tool** to quickly navigate these linked models. You can +**Enable Culling** to improve FPS speeds further, and use the :kbd:`RMB` to query +data about a selected object. + +Once loaded, the linked model is cached as a ``.cache.blend`` file for +subsequent loads in the same folder as the ``.ifc``. The data is cached in a +``.cache.sqlite`` file. + Large filesizes --------------- @@ -138,45 +162,6 @@ combined with other filters. Using Blender 3.3 and above will result in a faster load time (~50%) compared to older Blender versions. -Coordination only models ------------------------- - -Bonsai defaults to authoring IFCs. This allows full editing and inspection of -all element properties and relationships. However, sometimes only geometry and -basic attributes such as names are sufficient. Example usecases include CG -visualisation, overall federated model coordination, or pure geometric checks. - -Click on :ref:`Enable Advanced Mode ` checkbox when loading a model and you will be presented -with model loading options in the **Project Info** panel. Enable **For -Coordination Only**, which will exclude non geometric elements, openings, and -types from being imported. This leads to slightly faster imports, and a -decreased object count. - -Enabling **For Coordination Only** also allows you to specify a **Merge Mode**. -This combines objects to keep object counts low. Blender is very good at -handling less objects with more complexity, rather than the other way around. -When a **Merge Mode** is activated, import times will increase (~50%) but object -counts will be drastically reduced, which is critical for the federation of -large models. **Merge Modes** include: - -- **IFC Class**, where objects of the same IFC class are merged. This is useful - if you have models where only the class is meaningful for other disciplines, - such as structural models. -- **IFC Type**, where objects of the same construction type are merged. This is - useful where the main identification of interest is the element type, not the - element instance. -- **Material**, where objects of the same material are merged. This is useful if - the model is used for purely visual exploration such as CG visualisation. - -Once loaded, the model may be saved as a ``.blend`` file for subsequent loads. -You can think of the ``.blend`` file as a geometry cache, which is very, very -fast to load. If it no longer necessary to access IFC data, consider pressing -the **Unload Project** icon so that future loads of the ``.blend`` file will be -very fast. - -With these strategies, a federated 1GB IFC model can easily load in 10 seconds -from the saved Blender files. - Processing models headlessly ---------------------------- diff --git a/src/bonsai/docs/index.rst b/src/bonsai/docs/index.rst index 134f73c1f2..d1cb36f467 100644 --- a/src/bonsai/docs/index.rst +++ b/src/bonsai/docs/index.rst @@ -68,6 +68,8 @@ and data-rich OpenBIM with Blender :) :caption: Reference :maxdepth: 2 + reference/interface + reference/topbar reference/workspace reference/properties diff --git a/src/bonsai/docs/reference/images/interface-panel.png b/src/bonsai/docs/reference/images/interface-panel.png new file mode 100644 index 0000000000..c815a4029a Binary files /dev/null and b/src/bonsai/docs/reference/images/interface-panel.png differ diff --git a/src/bonsai/docs/reference/images/interface-split-merge.png b/src/bonsai/docs/reference/images/interface-split-merge.png new file mode 100644 index 0000000000..91ab33ecc3 Binary files /dev/null and b/src/bonsai/docs/reference/images/interface-split-merge.png differ diff --git a/src/bonsai/docs/reference/images/interface-tabs.png b/src/bonsai/docs/reference/images/interface-tabs.png new file mode 100644 index 0000000000..a5e2774ccf Binary files /dev/null and b/src/bonsai/docs/reference/images/interface-tabs.png differ diff --git a/src/bonsai/docs/reference/images/interface.png b/src/bonsai/docs/reference/images/interface.png new file mode 100644 index 0000000000..bc455b659f Binary files /dev/null and b/src/bonsai/docs/reference/images/interface.png differ diff --git a/src/bonsai/docs/reference/interface.rst b/src/bonsai/docs/reference/interface.rst new file mode 100644 index 0000000000..89087450c2 --- /dev/null +++ b/src/bonsai/docs/reference/interface.rst @@ -0,0 +1,38 @@ +Interface +========= + +.. container:: location-scene + + |location| Interface + + .. |location| image:: /images/location-scene.svg + +The Bonsai interface is split into 5 main sections. + +.. image:: images/interface.png + +1. :doc:`Topbar ` - shows main application menus to open and save IFCs, import IFCs, as well as tabs to save and load customised panel layouts. +2. :doc:`Outliner Panel ` - shows a list of all geometric objects loaded into your 3D view. Objects can be organised into collections for any purpose. +3. :doc:`3D Viewport Panel ` - shows a 3D view of your geometric objects. +4. :doc:`Properties Panel ` - shows properties about your project, non-geometric objects, and selected objects from the 3D view. +5. :doc:`Status Bar ` - shows useful hotkeys when a tool is active, statistics, and version information. + +Panels, such as the :doc:`/reference/outliner`, :doc:`/reference/3d_viewport`, and :doc:`/reference/properties` can be customised. You can click the top left icon of any panel to change the type of panel. + +.. image:: images/interface-panel.png + +You can split, merge, or create new panels by clicking :kbd:`RMB` in-between panels. + +.. image:: images/interface-split-merge.png + +You can save panel layouts, or switch to another customised panel layout by clicking the tabs in the :doc:`/reference/topbar`. Bonsai's default layout is stored in the **BIM** tab. + +.. image:: images/interface-tabs.png + +The :doc:`Topbar ` and :doc:`/reference/status_bar` cannot be customised. + +.. seealso:: + + Bonsai's interface is a customised version of the default Blender + interface. Read more about `Blender Workspaces + `__.