Continuing work to update docs
|
Before Width: | Height: | Size: 53 KiB |
|
Before Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 47 KiB |
|
Before Width: | Height: | Size: 40 KiB |
|
Before Width: | Height: | Size: 513 KiB |
|
After Width: | Height: | Size: 38 KiB |
|
After Width: | Height: | Size: 127 KiB |
|
After Width: | Height: | Size: 37 KiB |
|
After Width: | Height: | Size: 37 KiB |
|
After Width: | Height: | Size: 43 KiB |
@@ -3,58 +3,29 @@ Properties
|
||||
|
||||
.. container:: location-scene
|
||||
|
||||
|location| Scene Properties
|
||||
|location| Properties
|
||||
|
||||
.. |location| image:: /images/location-scene.svg
|
||||
|
||||
Bonsai adds new functionality to the `Property Editor` -> `Scene` tab.
|
||||
The properties panel shows information about the IFC model and the actively
|
||||
selected IFC object in the 3D Viewport.
|
||||
|
||||
.. figure:: images/interface_property-editor_project-overview_start-up.png
|
||||
:alt: Property editor on Blender start-up
|
||||
Tab bar
|
||||
-------
|
||||
|
||||
The property editor on Blender startup.
|
||||
A horizontal row of icons are provided to switch between what type of
|
||||
properties are shown. Alternatively, a dropdown list may also be used.
|
||||
|
||||
Most of these sub-tabs become available with a created or loaded IFC file.
|
||||
Don't worry, the default Blender scene properties are still reachable under their own dedicated sub-tab.
|
||||
.. image:: images/properties-tabs.png
|
||||
|
||||
.. figure:: images/interface_property-editor_icons.png
|
||||
:alt: Overview over the added property sub-tabs by Bonsai
|
||||
|
||||
Overview over the added property sub-tabs by Bonsai.
|
||||
|
||||
1. Project Overview
|
||||
2. Object Information
|
||||
3. Geometry and Materials
|
||||
4. Drawings and Documents
|
||||
5. Services and Systems
|
||||
6. Structural Analyses
|
||||
7. Costing and Scheduling
|
||||
8. Facility Management
|
||||
9. Quality and Coordination
|
||||
10. Blender Properties
|
||||
11. Switch Tab
|
||||
|
||||
You can also select the needed panel via the drop-down menue.
|
||||
|
||||
.. figure:: images/interface_property-editor_panel-dropdown.png
|
||||
:alt: Bonsai property editor sub-tabs drop-down menue
|
||||
|
||||
Switching between Bonsai property editor sub-tabs via the drop-down menue.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 1
|
||||
:caption: Contents:
|
||||
|
||||
project_overview/index
|
||||
object_information/index
|
||||
geometry_and_materials/index
|
||||
drawings_and_documents/index
|
||||
services_and_systems/index
|
||||
structural_analysis/index
|
||||
costing_and_scheduling/index
|
||||
facility_management/index
|
||||
quality_and_coordination/index
|
||||
blender
|
||||
switch_tab
|
||||
- **Project Overview**: Overall project information.
|
||||
- **Object Information**: Simple properties and relationships about the actively selected object.
|
||||
- **Geometry and Materials**: Geometric, material, and style data.
|
||||
- **Drawings and Documents**: Drawings, sheets, schedules, and other documents.
|
||||
- **Services and Systems**: Mechanical, electrical, hydraulic, fire systems, and building physics.
|
||||
- **Structural Analysis**: Structural analytical models and analysis.
|
||||
- **Costing and Scheduling**: Project staging, quantity take-off, cost schedules, work schedules and animation, and resource management.
|
||||
- **Facility Management**: Facility management integration, Brickschema integration.
|
||||
- **Quality and Coordination**: Model auditing and fixing, clash detection, BCF collaboration, and debugging.
|
||||
- **Blender Properties**: (Only visible at the bottom of the dropdown menu) Shows default Blender panels for Blender users who do not want to see IFC information.
|
||||
- **Switch Tab** (:kbd:`Ctrl` + :kbd:`Tab`): (Only visible at the end of the tab icons) Toggles between the two last active tabs.
|
||||
|
||||
@@ -1,44 +1,100 @@
|
||||
Topbar
|
||||
======
|
||||
|
||||
For general informations about the Blender Topbar see the respective
|
||||
`Workspaces <https://docs.blender.org/manual/en/latest/interface/window_system/topbar.html>`__ section in Blender documentation.
|
||||
.. container:: location-scene
|
||||
|
||||
Menus
|
||||
-----
|
||||
|location| Topbar
|
||||
|
||||
The `File` menu in the Topbar adds menu entries to Create/Open and Save an IFC project directly.
|
||||
.. |location| image:: /images/location-scene.svg
|
||||
|
||||
.. figure:: images/interface_window_file-menue.png
|
||||
:alt: Additional file menu options related to IFC projects
|
||||
|
||||
Additional file menu options related to IFC projects.
|
||||
.. seealso::
|
||||
|
||||
See more documentation about the `Blender Topbar <https://docs.blender.org/manual/en/latest/interface/window_system/topbar.html>`__.
|
||||
|
||||
File
|
||||
----
|
||||
|
||||
.. container:: location-scene
|
||||
|
||||
|location| Topbar |>| File
|
||||
|
||||
.. |location| image:: /images/location-scene.svg
|
||||
.. |>| image:: /images/location-breadcrumb.svg
|
||||
|
||||
Access new, open, save, and import functionality.
|
||||
|
||||
.. image:: images/topbar-file.png
|
||||
|
||||
- :ref:`reference/topbar:new ifc project` (:kbd:`Ctrl` + :kbd:`N`): Provides convenient presets to create new IFC projects.
|
||||
- **Open IFC Project**: Launches a file browser to open an IFC model for viewing and authoring.
|
||||
- :ref:`reference/topbar:open recent ifc project`: See recently opened IFC models.
|
||||
- **Save IFC Project** (:kbd:`Shift` + :kbd:`S`): saves the ``.ifc`` file, optionally launching a file browse dialog if the file has not yet been saved.
|
||||
- **Save IFC Project As**: launches a file browse dialog to save the ``.ifc``. This location is remembered for future saves.
|
||||
- **Revert IFC Project**: Discards all unsaved changes and reloads the currently loaded IFC model.
|
||||
- :ref:`reference/topbar:import`: Imports data from external sources into the Blender session or IFC model.
|
||||
|
||||
.. warning::
|
||||
|
||||
Other menu items, such as ``New`` or ``Open...`` are part of Blender. These
|
||||
create, open, save, and interact with Blender files, not IFC models. If you
|
||||
are using Bonsai to work with IFC natively, using these functions may
|
||||
damage your IFC model. For more information, see
|
||||
:ref:`guides/troubleshooting:saving and loading blend files`.
|
||||
|
||||
New IFC Project
|
||||
^^^^^^^^^^^^^^^
|
||||
---------------
|
||||
|
||||
The New IFC Project submenu offers several options for creating a new IFC project:
|
||||
.. container:: location-scene
|
||||
|
||||
.. figure:: images/file_new-ifc-project-submenu.png
|
||||
:alt: New IFC Project submenu options
|
||||
|
||||
New IFC Project submenu options
|
||||
|location| Topbar |>| File |>| New IFC Project (:kbd:`Shift` + :kbd:`N`)
|
||||
|
||||
- New Metric (m) Project: Creates a new IFC project using meters as the base unit.
|
||||
- New Metric (mm) Project: Creates a new IFC project using millimeters as the base unit.
|
||||
- New Imperial (ft) Project: Creates a new IFC project using feet as the base unit.
|
||||
- New Demo Project: Creates a new IFC project with pre-populated demo content.
|
||||
- New Project Wizard: Creates a default Blender project (including the default cube)
|
||||
and opens the Scene Properties > Project Overview > Project Info tab.
|
||||
This allows users to customize their project settings before creation.
|
||||
Clicking the "Create Project" button in this panel will delete the default cube and set up the new IFC project with the specified settings.
|
||||
.. |location| image:: /images/location-scene.svg
|
||||
.. |>| image:: /images/location-breadcrumb.svg
|
||||
|
||||
These options provide flexibility in setting up new IFC projects,
|
||||
allowing users to choose between quick starts with predefined units
|
||||
or a more customizable approach through the Project Wizard.
|
||||
Provides convenient presets to create new IFC projects.
|
||||
|
||||
.. image:: images/topbar-file-new.png
|
||||
|
||||
BIM Workspace
|
||||
-------------
|
||||
- **New Metric (m) Project**: Creates a new IFC4 project using meters as the length unit.
|
||||
- **New Metric (mm) Project**: Creates a new IFC4 project using millimeters as the length unit.
|
||||
- **New Imperial (ft) Project**: Creates a new IFC4 project using feet as the length unit.
|
||||
- **New Demo Project**: Creates a new IFC4 project with pre-populated demo types and content. Useful for experimenting and learning.
|
||||
- **New Project Wizard**: Resets the Blender session and shows the :ref:`viewing/project_overview:new project wizard` panel to customise project creation settings such as schema version.
|
||||
|
||||
Bonsai adds the **BIM** Workspace to the Topbar Workspaces tabs.
|
||||
Open Recent IFC Project
|
||||
-----------------------
|
||||
|
||||
.. container:: location-scene
|
||||
|
||||
|location| Topbar |>| File |>| Open Recent IFC Project
|
||||
|
||||
.. |location| image:: /images/location-scene.svg
|
||||
.. |>| image:: /images/location-breadcrumb.svg
|
||||
|
||||
Shows a list of recently opened IFC models.
|
||||
|
||||
- **Clear Recent IFC Projects List**: Clears the list of recently opened IFC models.
|
||||
|
||||
.. image:: images/topbar-file-recent.png
|
||||
|
||||
Import
|
||||
------
|
||||
|
||||
.. container:: location-scene
|
||||
|
||||
|location| Topbar |>| File |>| Import
|
||||
|
||||
.. |location| image:: /images/location-scene.svg
|
||||
.. |>| image:: /images/location-breadcrumb.svg
|
||||
|
||||
Imports data from external sources into the Blender session or IFC model.
|
||||
|
||||
.. image:: images/topbar-file-import.png
|
||||
|
||||
- **IFC (Geometry Only) (.ifc/.ifczip/.ifcxml)**: Imports only the geometry from an IFC model into the current Blender session. This can not be used for editing the IFC model. Typically used by CG artists.
|
||||
- **Cost Schedule (.csv)**: Imports a CSV containing a cost schedule into the active IFC model.
|
||||
- **Work Schedule (.csv)**: Imports a CSV containing a work schedule into the active IFC model.
|
||||
- **P6 (.xml)**: Imports a P6 XML file containing a work schedule into the active IFC model.
|
||||
- **P6 (.xer)**: Imports a P6 XER file containing a work schedule into the active IFC model.
|
||||
- **Powerproject (.pp)**: Imports a Powerproject file containing a work schedule into the active IFC model.
|
||||
- **Microsoft Project (.xml)**: Imports a Microsoft Project XML file containing a work schedule into the active IFC model.
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
Workspace
|
||||
=========
|
||||
|
||||
For general informations about the Blender Workspaces see the respective
|
||||
`Workspaces <https://docs.blender.org/manual/en/latest/interface/window_system/workspaces.html>`__ section in Blender documentation.
|
||||
|
||||
After installation of Bonsai the default Blender start-up screen looks different from the standard Blender interface.
|
||||
|
||||
Bonsai adds the **BIM** Workspace to the interface and by default activates this workspace on start-up.
|
||||
It also modifies the layout of views and sidebars and adds custom functionality to the toolbar.
|
||||
The left **Outliner** panel shows a tree of geometric objects. The centre main **Viewport** panel shows 3D geometry.
|
||||
The right **Properties** panel shows data and relationships.
|
||||
|
||||
.. figure:: images/interface_window_start-up.png
|
||||
:alt: Blender start-up window with installed Bonsai
|
||||
|
||||
Blender start-up window with installed Bonsai.
|
||||
|
||||
1. **BIM** Workspace tab
|
||||
2. Outliner with the document tree
|
||||
3. Main 3D viewport
|
||||
4. Property editor
|
||||
5. Toolbar with added BIM functionality
|
||||
6. Sidebar with Bonsai & 4D/5D Toolkit panels
|
||||
7. Status bar with information about the currently used Blender and Bonsai version
|
||||
|
||||