Expand Project Info documentation. Reorganize General Usage (#4875)

This commit is contained in:
John Yani
2024-06-15 07:10:00 +03:00
committed by GitHub
parent 9331292dd1
commit a23e6dcd66
47 changed files with 620 additions and 449 deletions
+1
View File
@@ -54,6 +54,7 @@ extensions = ["sphinx.ext.autodoc", "sphinx.ext.autosectionlabel", "sphinx_copyb
# Auto add document prefixes to help guarantee uniqueness of automatic section references.
autosectionlabel_prefix_document = True
autosectionlabel_maxdepth = 2
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
+3 -1
View File
@@ -24,7 +24,9 @@ documentation>`. Traditional references like `Writing technical documentation`_
work too but are discouraged. You can link to other pages, like :doc:`Hello
World<hello_world>` or sections within other pages, like
:ref:`devs/installation:unstable installation`. We have ``autosectionlabel``
enabled so it is not necessary to manually create labels.
enabled so it is not necessary to manually create labels. The depth of sections
with automatic labels is set to 2, so the third level of titles
will not get automatic labels to avoid duplication.
The following colours and annotation styles should be used for annotating
images. All stroke widths are 3px with a corner radius of 3px. Horizontal
+1 -1
View File
@@ -31,7 +31,7 @@ Learn how to model a small building and create simple architectural plans, secti
users/dealing_with_large_models
users/git_support
users/other_addons
users/general_usage
users/user_interface
users/troubleshooting
.. toctree::
@@ -62,7 +62,8 @@ Filtered model loading
----------------------
You may filter elements and only load a portion of the model. Click on
:ref:`users/general_usage/ifc_project:Advanced mode` when loading a model.
:ref:`Advanced Mode <Project Info Advanced Mode>` checkbox when loading a model.
.. image:: images/advanced-mode.png
@@ -1,13 +0,0 @@
General usage
=============
Covers general topics that are not specific to any discipline, such as loading
and exploring models.
.. toctree::
:hidden:
:maxdepth: 1
:caption: Contents:
general_usage/interface
general_usage/ifc_project
@@ -1,126 +0,0 @@
IFC Project
===========
Overview
--------
.. container:: location-scene
|location| Scene Properties |>| IFC Project Info |>| IFC Project
.. |location| image:: /images/location-scene.svg
.. |>| image:: /images/location-breadcrumb.svg
The IFC Project panel lets you create a new IFC project, load an existing IFC
project, or view high level project metadata about the currently loaded project.
.. image:: images/ifc-project.png
**IFC Schema**
Choose between which IFC schema version to use when creating a new project.
IFC4 is recommended for all new projects.
**Unit System**
Choose between metric and imperial units of measurement when creating a
project.
**Length Unit**
Depending on the unit system, choose the default unit to be used for all
length measurements. Lengths are used for moving objects around in the 3D
scene, as well as lengths, widths, height, and depth quantity take-off data.
**Area Unit**
Depending on the unit system, choose the default unit to be used for all
area measurements. Areas are typically used for quantity take-off.
**Volume Unit**
Depending on the unit system, choose the default unit to be used for all
volume measurements. Volumes are typically used for quantity take-off.
**Template**
Choose between starting a completely blank project with no objects, or with
preloaded object assets (such as wall types, beam types, etc) that you can
use immediately. The blank project is recommended for users who want to
curate assets, whereas the IFC4 Demo Template is recommended for users wanting
to experiment and learn with a basic set of objects.
This also shows other larger object libraries for steel and countries
available with the BlenderBIM Add-on. These contain hundreds of objects and
are not recommended to be loaded as a template.
.. seealso::
You can start with a blank project and load in more assets later from a
library using the IFC Project Library panel.
**Create Project**
Create a new project based on the selected settings and template. By default,
your project will be created with a basic spatial structure, including a
single site, a building, and a single storey within the building.
**Load Project**
Load an existing project from an IFC file. The IFC may come from any source,
including exported from proprietary BIM software.
Project details
---------------
Once a project is created, basic metadata about the project will be displayed,
with basic features to save and unload the project.
.. image:: images/ifc-project-create.png
|FILE| **Filename**
Shows the URI of where the IFC is saved, or "No File Found" if the IFC has
not yet been saved.
|GREASEPENCIL| **Enable Editing Header**
Enable editing basic metadata about the project.
|FILE_CACHE| **IFC Schema**
Shows the IFC schema identifier of the model. This cannot be changed while
the model is open. It is typically one of IFC2X3, IFC4, or IFC4X3. Other
values are not standardised and not supported by the BlenderBIM Add-on.
|FILE_HIDDEN| **IFC MVD**
The Model View Definition (MVD) defines the intended purpose of the IFC
model. "Design Transfer" is the most advanced MVD, meaning that IFC may be
used for native authoring of the model. Other examples include "Reference
View" for purely read only geometry (i.e. "dumb geometric model") or
"Coordination View" for coordinating models between different disciplines.
The Design Transfer MVD is used by all BlenderBIM Add-on projects, and is a
superset of all other MVDs.
|EXPORT| **Save Project**
Saves the current IFC project to a file on disk. Note that this should be
used to save the IFC project, *not* the regular Blender ``File > Save`` menu.
|FILE_TICK| **Save Project As**
Saves the current IFC project to a file on a disk with a different filename.
Advanced mode
-------------
The advanced mode will not load the model right away, but preload it and
provide additional loading possibilities like :ref:`users/dealing_with_large_models:Filtered model loading`.
.. image:: images/ifc-project-load.png
.. |FILE| image:: /images/icon-FILE.svg
:class: icon
.. |FILE_CACHE| image:: /images/icon-FILE_CACHE.svg
:class: icon
.. |FILE_HIDDEN| image:: /images/icon-FILE_HIDDEN.svg
:class: icon
.. |GREASEPENCIL| image:: /images/icon-GREASEPENCIL.svg
:class: icon
.. |EXPORT| image:: /images/icon-EXPORT.svg
:class: icon
.. |FILE_TICK| image:: /images/icon-FILE_TICK.svg
:class: icon
Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

@@ -1,12 +0,0 @@
User Interface
==============
This section covers the general user interface of BlenderBIM.
.. toctree::
:hidden:
:maxdepth: 1
:caption: Contents:
interface/workspace
interface/property-editor
@@ -1,283 +0,0 @@
Property Editor
===============
Overview
--------
BlenderBIM adds new functionality to the `Property Editor` -> `Scene` tab.
.. figure:: images/interface_property-editor_project-overview_start-up.png
:alt: Property editor on Blender start-up
The property editor on Blender startup.
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.
.. figure:: images/interface_property-editor_icons.png
:alt: Overview over the added property sub-tabs by BlenderBIM
Overview over the added property sub-tabs by BlenderBIM.
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 - the default Blender scene properties moved under its own dedicated panel
11. Switch Tab - quick access to switch between the last 2 used Property panels
You can also select the needed panel via the drop-down menue.
.. figure:: images/interface_property-editor_panel-dropdown.png
:alt: BlenderBIM property editor sub-tabs drop-down menue
Switching between BlenderBIM property editor sub-tabs via the drop-down menue.
Project Overview
----------------
.. figure:: images/interface_property-editor_project-overview.png
:alt: property editor project overview sub-tab
Project Overview sub-tab with subsection panels.
Project Info
^^^^^^^^^^^^
The "Project Info" subsection in the BlenderBIM Add-on interface changes depending on the state of the IFC project. When no project is loaded, the subsection displays options to create a new project or load an existing one. If a new IFC project is created but not yet saved, the subsection shows a "No File Found" message, indicating that the project is not yet saved. Once an IFC project is loaded or created and saved, the subsection presents an overview of the project's metadata, including the IFC schema version, MVD, author, organization, last saved date, filename, and file path. Users can edit specific metadata fields, select a different IFC file, or unload the current project from within this subsection.
**Not Created or Loaded state**
.. figure:: images/interface_property-editor_project-overview_new_load.png
:alt: Project Info when project is not created or loaded
When no IFC file is loaded, the "Project Info" subsection displays options to create a new IFC project or load an existing one.
Fields:
- **IFC Schema**. Indicates the version of the Industry Foundation Classes (IFC) schema used by the loaded file. Example: "IFC4"
Buttons:
- **Create Project**. Button to create a new IFC project with the selected IFC schema, unit system, and template. Clicking this button changes to the Not Saved mode, waiting for user to edit metadata and save the IFC file.
- **Load Project**. Button to load an existing IFC file into the Blender scene. Clicking this button opens a file browser dialog, enabling users to navigate to and select the desired IFC file.
**Not Saved state**
.. figure:: images/interface_property-editor_project-overview_unsaved.png
:alt: Project Info when IFC project is created but IFC file is not saved
When a new IFC project is created but not yet saved, the "Project Info" subsection displays the following message: "File Not Saved". Indicates that the current IFC project has not been saved to a file. The IFC header can be edited by clicking the pencil button. In this mode you can't unload the IFC project and go back to the Not Create or Loaded mode. You have to save the IFC file first and then unload the project.
Fields:
- **IFC Schema** (read-only). Indicates the version of the Industry Foundation Classes (IFC) schema used by the loaded file. Example: "IFC4"
Buttons:
- **Edit (pencil icon)**: Clicking this button switches the "Project Info" subsection to editing mode, allowing users to modify the IFC header/metadata fields.
**Saved and Loaded state**
.. figure:: images/interface_property-editor_project-overview_saved.png
:alt: Project Info when IFC project is created and IFC file is saved
Fields:
- **Filename**. Displays the name of the loaded IFC file. Example: "demo.ifc"
- **File path**. Shows the location of the loaded IFC file on the user's file system. Example: "/home/user/Docum...lenderbim/"
Buttons:
When an IFC project is created or loaded and saved additional buttons appear (beside the Edit button):
- **Select a different IFC file**: This button allows users to choose and load a different IFC file. Clicking the button will open a file browser dialog, enabling users to navigate to and select the desired IFC file.
- **Unload the IFC project**: This button allows users to unload the currently loaded IFC file from the Blender scene. Clicking the button will remove the IFC data and clear the "Project Info" subsection, returning it to the "Not create or Loaded" mode.
**IFC Header Editing toggle**
.. figure:: images/interface_property-editor_project-overview_edit-header.png
:alt: Project Info when edit header toggle is active
Clicking the pencil button (which doesn't exist when in the Not Created or Loaded state) switches the "Project Info" subsection to editing mode, allowing users to modify the IFC header/metadata fields
Fields:
- **IFC Schema** (read only). Indicates the version of the Industry Foundation Classes (IFC) schema used by the loaded file. Example: "IFC4"
- **IFC MVD**. Specifies the Model View Definition (MVD) used by the loaded IFC file. An MVD defines a subset of the IFC schema for a specific data exchange purpose. Example: "DesignTransferView"
- **Author**. Displays the author of the IFC file.
- **Author Email**. Shows the email address of the IFC file author.
- **Organisation**. Indicates the organization associated with the IFC file.
- **OrganisationEmail**. Displays the email address of the organization.
- **Authoriser**. Shows the authoriser of the IFC file, if available. Example: "Nobody"
- **Saved**. Displays the last saved date and time of the loaded IFC file. Example: "2024-06-10 13:15"
Buttons:
- **Save header information (checkbox icon)**
- **Cancel unsaved header information (cross icon)**
Project Setup
^^^^^^^^^^^^^
tbd
Geometry
^^^^^^^^
tbd
Stakeholders
^^^^^^^^^^^^
tbd
Grouping and Filtering
^^^^^^^^^^^^^^^^^^^^^^
tbd
Object Information
------------------
.. figure:: images/interface_property-editor_object-information.png
:alt: property editor object information sub-tab
Object Information sub-tab.
Object Metadata
tbd
Miscellaneous
tbd
Geometry and Materials
----------------------
.. figure:: images/interface_property-editor_geometry-materials.png
:alt: property editor geometry and materials sub-tab
Geometry and Materials sub-tab.
Placement
tbd
Representations
tbd
Geometric Relationships
tbd
Parametric Geometry
tbd
Profiles
tbd
Materials
tbd
Styles
tbd
Drawings and Documents
----------------------
.. figure:: images/interface_property-editor_drawings-documents.png
:alt: property editor drawings and documents sub-tab
Drawings ans Documents sub-tab.
Sheets
tbd
Drawings
tbd
Schedules
tbd
References
tbd
Services and Systems
--------------------
.. figure:: images/interface_property-editor_services-systems.png
:alt: property editor services and systems sub-tab
Services and Systems sub-tab.
Services
tbd
Zones
tbd
Structural Analyses
-------------------
.. figure:: images/interface_property-editor_structural-analysis.png
:alt: property editor structural analysis sub-tab
Structural Analysis sub-tab.
Costing and Scheduling
----------------------
.. figure:: images/interface_property-editor_costing-scheduling.png
:alt: property editor costing and scheduling sub-tab
Costing and Scheduling sub-tab.
Status
tbd
Resources
tbd
Cost
tbd
Construction Scheduling
tbd
Facility Management
-------------------
.. figure:: images/interface_property-editor_facility-management.png
:alt: property editor facility management sub-tab
Facility Management sub-tab.
Commissioning and Handover
tbd
Operations and Maintenance
tbd
Quality and Coordination
------------------------
.. figure:: images/interface_property-editor_quality-coordination.png
:alt: property editor quality and coordination sub-tab
Quality and Coordination sub-tab.
Quality Control
tbd
Clash Detection
tbd
Collaboration
tbd
Sandbox
tbd
@@ -0,0 +1,16 @@
User interface
==============
This section covers the general user interface of BlenderBIM. User interface documentation does not cover any specific use case but provides a general reference of BlenderBIM UI.
The documentation doesn't cover Blender UI, but makes references to `Blender documentation <https://docs.blender.org/manual/en/latest/interface/index.html>`__ where appropriate.
.. toctree::
:hidden:
:maxdepth: 1
:caption: Contents:
user_interface/topbar
user_interface/workspace
user_interface/property-editor

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

@@ -0,0 +1,60 @@
Property Editor Scene Properties
================================
.. container:: location-scene
|location| Scene Properties
.. |location| image:: /images/location-scene.svg
BlenderBIM adds new functionality to the `Property Editor` -> `Scene` tab.
.. figure:: images/interface_property-editor_project-overview_start-up.png
:alt: Property editor on Blender start-up
The property editor on Blender startup.
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.
.. figure:: images/interface_property-editor_icons.png
:alt: Overview over the added property sub-tabs by BlenderBIM
Overview over the added property sub-tabs by BlenderBIM.
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: BlenderBIM property editor sub-tabs drop-down menue
Switching between BlenderBIM property editor sub-tabs via the drop-down menue.
.. toctree::
:hidden:
:maxdepth: 1
:caption: Contents:
property_editor/scene_editor/project_overview/index
property_editor/scene_editor/object_information/index
property_editor/scene_editor/geometry_and_materials/index
property_editor/scene_editor/drawings_and_documents/index
property_editor/scene_editor/services_and_systems/index
property_editor/scene_editor/structural_analysis/index
property_editor/scene_editor/costing_and_scheduling/index
property_editor/scene_editor/facility_management/index
property_editor/scene_editor/quality_and_coordination/index
property_editor/scene_editor/blender
property_editor/scene_editor/switch_tab
@@ -0,0 +1,7 @@
Blender Properties
==================
The default Blender scene properties moved under its own dedicated panel.
For general informations about the Blender Scene Properties see the respective
`Scene Properties <https://docs.blender.org/manual/en/latest/scene_layout/scene/properties.html>`__ section in Blender documentation.
@@ -0,0 +1,19 @@
Costing and Scheduling
======================
.. figure:: images/interface_property-editor_costing-scheduling.png
:alt: property editor costing and scheduling sub-tab
Costing and Scheduling sub-tab.
Status
tbd
Resources
tbd
Cost
tbd
Construction Scheduling
tbd
@@ -0,0 +1,19 @@
Drawings and Documents
======================
.. figure:: images/interface_property-editor_drawings-documents.png
:alt: property editor drawings and documents sub-tab
Drawings ans Documents sub-tab.
Sheets
tbd
Drawings
tbd
Schedules
tbd
References
tbd
@@ -0,0 +1,13 @@
Facility Management
===================
.. figure:: images/interface_property-editor_facility-management.png
:alt: property editor facility management sub-tab
Facility Management sub-tab.
Commissioning and Handover
tbd
Operations and Maintenance
tbd
@@ -0,0 +1,28 @@
Geometry and Materials
======================
.. figure:: images/interface_property-editor_geometry-materials.png
:alt: property editor geometry and materials sub-tab
Geometry and Materials sub-tab.
Placement
tbd
Representations
tbd
Geometric Relationships
tbd
Parametric Geometry
tbd
Profiles
tbd
Materials
tbd
Styles
tbd
@@ -0,0 +1,14 @@
Object Information
==================
.. figure:: images/interface_property-editor_object-information.png
:alt: property editor object information sub-tab
Object Information sub-tab.
Object Metadata
tbd
Miscellaneous
tbd
@@ -0,0 +1,63 @@
Project Overview
================
.. container:: location-scene
|location| Scene Properties |>| Project Overview
.. |location| image:: /images/location-scene.svg
.. |>| image:: /images/location-breadcrumb.svg
The Project Overview sub-tab in the BlenderBIM Add-on interface provides a central hub
for accessing and managing essential information and settings related to an IFC project.
Located within the Scene Properties tab of Property Editor, this sub-tab is organized into several panels, each focusing on a specific aspect of the project.
.. figure:: images/interface_property-editor_project-overview.png
:alt: property editor project overview sub-tab
Project Overview sub-tab with subsection panels.
The primary subsection panel is **Project Info** which displays crucial metadata about the loaded IFC file, such as
the IFC schema version, model view definition (MVD), authoring information, and file location.
It also provides options to create new IFC projects, load existing ones, and unload the current project.
In addition to **Project Info**, the Project Overview sub-tab includes several other panels that cover various aspects of project management, such as:
- Project Setup
- Geometry
- Stakeholders
- Grouping and Filtering
Project Info
^^^^^^^^^^^^
The Project Info subsection adapts to the state of the IFC project, presenting relevant options and information based on whether a project is loaded,
saved, or in the process of being created.
Project Setup
^^^^^^^^^^^^^
Project Setup subsection allows users to configure project-specific settings, libraries, and templates.
Geometry
^^^^^^^^
The Geometry panel provides access to geometry-related settings and tools, such as units, georeferencing, and geometric representation contexts.
Stakeholders
^^^^^^^^^^^^
The Stakeholders panel enables users to manage project stakeholders, including people, organizations, and roles.
Grouping and Filtering
^^^^^^^^^^^^^^^^^^^^^^
Grouping and Filtering panel offers tools for organizing and filtering project data based on specific criteria.
.. toctree::
:hidden:
:maxdepth: 1
:caption: Contents:
project_info
@@ -0,0 +1,305 @@
Project Info
============
.. container:: location-scene
|location| Scene Properties |>| Project Overview |>| Project Info
.. |location| image:: /images/location-scene.svg
.. |>| image:: /images/location-breadcrumb.svg
Overview
--------
The "Project Info" panel in the "Project Overview" tab of "Scene Properties" of "Properties Editor"
provides an overview of the essential information about the currently loaded IFC file or allows users to create a new or load an existing IFC project.
The "Project Info" panel has four distinct states depending on the state of the IFC project:
1. Not Created or Loaded State
2. Not Saved State
3. Saved and Loaded State
4. Preloaded State (Advanced Mode)
There's also an edit toggle in some states that allows to modify the various metadata of the IFC file i.e. the IFC header section of the file.
Not Created or Loaded State
---------------------------
.. figure:: images/interface_property-editor_project-overview_new_load.png
:alt: Project Info when project is not created or loaded
When no IFC file is loaded, the "Project Info" panel displays options to create a new IFC project or load an existing one.
Fields
^^^^^^
|FILE_CACHE| **IFC Schema**
Choose between which IFC schema version to use when creating a new project. IFC4 is recommended for all new projects.
The list of IFC specifications can be viewed on the `BuildingSMART website <https://technical.buildingsmart.org/standards/ifc/ifc-schema-specifications/>`__.
Supported versions are `IFC2X3 <https://standards.buildingsmart.org/IFC/RELEASE/IFC2x3/FINAL/HTML/>`__ (2005), `IFC4 <https://standards.buildingsmart.org/IFC/RELEASE/IFC4/FINAL/HTML/>`__ (2013) and `IFC4X3 <https://standards.buildingsmart.org/IFC/RELEASE/IFC4_3/>`__ (2024).
.. seealso::
Use the `IFC Class search tool
<https://blenderbim.org/search-ifc-class.html>`__ to help choose an **IFC
Class** based on the IFC Schema version.
**Unit System**
Choose between metric and imperial units of measurement when creating a project.
**Length Unit**
Depending on the unit system, choose the default unit to be used for all length measurements. Lengths are used for moving objects around in the 3D scene, as well as lengths, widths, height, and depth quantity take-off data.
**Area Unit**
Depending on the unit system, choose the default unit to be used for all area measurements. Areas are typically used for quantity take-off.
**Volume Unit**
Depending on the unit system, choose the default unit to be used for all volume measurements. Volumes are typically used for quantity take-off.
**Template**
Choose between starting a completely blank project with no objects, or with preloaded object assets (such as wall types, beam types, etc) that you can use immediately.
The blank project is recommended for users who want to curate assets, whereas the IFC4 Demo Template is recommended for users wanting to experiment and learn with a basic set of objects.
This also shows other larger object libraries for steel and countries available with the BlenderBIM Add-on. These contain hundreds of objects and are not recommended to be loaded as a template.
.. seealso::
You can start with a blank project and load in more assets later from a
library using the IFC Project Library panel.
Buttons
^^^^^^^
**Create Project**
Create a new project based on the selected settings and template.
By default, your project will be created with a basic spatial tree with the structure ``IfcProject > IfcSite >
IfcBuilding > IfcStorey``. Template might include additional colllections and classes, such as Types. You can see the tree of collections in the outliner when this is done.
**Load Project**
Load an existing project from an IFC file. The IFC may come from any source, including exported from proprietary BIM software.
Not Saved State
---------------
.. figure:: images/interface_property-editor_project-overview_unsaved.png
:alt: Project Info when IFC project is created but IFC file is not saved
Once a project is created, basic metadata about the project will be displayed.
The IFC header can be edited by clicking the pencil button (see `IFC Header Editing toggle`_).
Caveat: In this state you can't unload the IFC project and go back to the Not Created or Loaded State. You have to save the IFC file first and then unload the project.
Static text
^^^^^^^^^^^
Since the file is not yet saved, the "Project Info" panel displays the following messages:
|FILE| **No File Found**
**File Not Saved**
This indicates that the current IFC project has not been saved to a file.
Fields
^^^^^^
|FILE_CACHE| **IFC Schema** (read-only)
Indicates the version of the Industry Foundation Classes (IFC) schema used by the created file. This would usually be "IFC4".
|FILE_HIDDEN| **IFC MVD**
Specifies the Model View Definition (MVD) used by the loaded IFC file. An MVD defines a subset of the IFC schema for a specific data exchange purpose. By default this is "DesignTransferView".
Buttons
^^^^^^^
|GREASEPENCIL| **Edit**
Clicking this button switches the "Project Info" panel to `editing mode <IFC Header Editing toggle_>`_, allowing users to modify the IFC header fields.
Saved and Loaded State
----------------------
.. figure:: images/interface_property-editor_project-overview_saved.png
:alt: Project Info when IFC project is created and IFC file is saved
Fields
^^^^^^
|FILE| **Filename**
Displays the name of the loaded IFC file. Example: "demo.ifc"
|FILE_CACHE| **IFC Schema** (read-only)
Same as in `Not Saved State`_.
|FILE_HIDDEN| **IFC MVD**
Same as in `Not Saved State`_.
|EXPORT| **Saved**
Displays the last saved date and time of the loaded IFC file. Example: "2024-06-10 13:15"
**File path**
Shows the location of the loaded IFC file on the user's file system. Example: "/home/user/Docum...lenderbim/demo.ifc"
Buttons
^^^^^^^
|GREASEPENCIL| **Edit**
Same as in `Not Saved State`_, switches to `editing mode <IFC Header Editing toggle_>`_.
**Select a different IFC file**
This button allows users to choose and load a different IFC file. Clicking the button will open a file browser dialog, enabling users to navigate to and select the desired IFC file.
**Unload the IFC project**
This button allows users to unload the currently loaded IFC file from the Blender scene. Clicking the button will remove the IFC data and clear the "Project Info" panel, returning it to the Not Created or Loaded State.
IFC Header Editing toggle
-------------------------
.. figure:: images/interface_property-editor_project-overview_edit-header.png
:alt: Project Info when edit header toggle is active
Clicking the pencil button (which doesn't exist when in the Not Created or Loaded State) switches the "Project Info" panel to editing mode, allowing users to modify the IFC header. The IFC Schema version can't be edited. You can upgrade the IFC schema when opening a file though.
Fields
^^^^^^
|FILE_CACHE| **IFC Schema** (read only)
Indicates the version of the Industry Foundation Classes (IFC) schema used by the loaded file. Example: "IFC4"
**IFC MVD**
Specifies the Model View Definition (MVD) used by the loaded IFC file. An MVD defines a subset of the IFC schema for a specific data exchange purpose. Example: "DesignTransferView"
**Author**
Displays the author of the IFC file.
**Author Email**
Shows the email address of the IFC file author.
**Organisation**
Indicates the organization associated with the IFC file.
**OrganisationEmail**
Displays the email address of the organization.
**Authoriser**
Shows the authoriser of the IFC file, if available. Example: "Nobody"
Buttons
^^^^^^^
**Save header information (checkbox icon)**
Saves the edited IFC header/metadata fields.
**Cancel unsaved header information (cross icon)**
Discards the changes made to the IFC header/metadata fields and returns to the non-editing mode.
.. _Advanced: Advanced
.. _Project Info Advanced Mode:
Preloaded State (Advanced Mode)
-------------------------------
.. seealso::
:ref:`users/dealing_with_large_models:Filtered model loading`.
The Preloaded State is an additional state that appears when loading an IFC file using the "Advanced Mode" checkbox.
This mode allows users to preload the model and filter elements, loading only a portion of the model.
The Advanced Mode Loading State provides users with extensive control over the loading process,
allowing them to customize which elements are loaded and how they are represented in the Blender scene.
This can be particularly helpful when working with large and complex IFC models, as it enables users to selectively load and optimize specific portions
of the model based on their requirements.
Once the desired settings have been configured, users can click on the "Load Project Elements" button to load the filtered and optimized IFC model into the Blender scene. After the model has been loaded using the Advanced Mode Loading State, the "Project Info" panel will transition to the "Saved and Loaded State", displaying the relevant metadata and options for the loaded IFC project.
To access this mode, click on "Advanced Mode" checkbox when loading a model.
.. image:: images/advanced-mode.png
:alt: Open file dialog
In the Advanced Mode Loading State, the "Project Info" panel presents the following options:
.. image:: images/advanced-mode-settings.png
:alt: Project Info when in Advanced Mode Loading State
Fields
^^^^^^
**Collection Mode**
Options:
- Decomposition
- Spatial Decomposition
- IFC Class
- None
**Filter Mode**
Options:
- **Decomposition**: filter the IFC elements based on their decomposition within the building hierarchy, such as Level 1 or Building A.
- **IFC Class**: Filter elements by their IFC class, such as "IfcWall", "IfcColumn", or "IfcDoor".
- **IFC Type**: Filter elements by their IFC type, which represents the specific subtype or predefined type of an element, such as "IfcSlabType/100mmConcrete".
- **Whitelist**: Filter elements based on a custom query, where only elements matching the query are included in the loaded model.
- **Blacklist**: Filter elements based on a custom query, where elements matching the query are excluded from the loaded model.
When "Whitelist" or "Blacklist" is chosen, users can input a custom query in the "Filter Query" field to define the specific criteria for filtering elements.
**Deflection Tolerance**
**Angular Tolerance**
**Void Limit**
**Distance Limit**
**False Origin**
**Element Range**
Users can define a range of elements to load based on their index within the IFC file. This is useful for loading a specific subset of elements when dealing with large models.
Checkboxes
^^^^^^^^^^
- **Filter Spatial Elements**: Available when the Filter Mode option is selected.
- **CPU Multiprocessing**: Enables the use of multiple CPU cores to speed up the loading process.
- **Clean Meshes**: Automatically cleans and optimizes the geometry of the loaded elements.
- **Cache**: Caches the loaded elements to improve performance.
- **Load Geometry**:
- **Native Meshes**: Loads the native geometry of elements instead of using Blender's built-in representation.
- **Merge Materials by Color**: Merges materials with similar colors to reduce the number of unique materials in the model.
- **For Coordination Only**: Loads the model in a coordination-only mode, which may disable certain features or simplify the representation of elements.
Buttons
^^^^^^^
- **Load Project Elements**: Loads the IFC model with the selected filters, options, and element range applied.
- **Unload Project**: Unload the currently loaded IFC file from the Blender scene.
.. |FILE| image:: /images/icon-FILE.svg
:class: icon
.. |FILE_CACHE| image:: /images/icon-FILE_CACHE.svg
:class: icon
.. |FILE_HIDDEN| image:: /images/icon-FILE_HIDDEN.svg
:class: icon
.. |EXPORT| image:: /images/icon-EXPORT.svg
:class: icon
.. |GREASEPENCIL| image:: /images/icon-GREASEPENCIL.svg
:class: icon
@@ -0,0 +1,19 @@
Quality and Coordination
========================
.. figure:: images/interface_property-editor_quality-coordination.png
:alt: property editor quality and coordination sub-tab
Quality and Coordination sub-tab.
Quality Control
tbd
Clash Detection
tbd
Collaboration
tbd
Sandbox
tbd
@@ -0,0 +1,13 @@
Services and Systems
====================
.. figure:: images/interface_property-editor_services-systems.png
:alt: property editor services and systems sub-tab
Services and Systems sub-tab.
Services
tbd
Zones
tbd
@@ -0,0 +1,7 @@
Structural Analysis
===================
.. figure:: images/interface_property-editor_structural-analysis.png
:alt: property editor structural analysis sub-tab
Structural Analysis sub-tab.
@@ -0,0 +1,4 @@
Switch Tab
==========
Switch Tab button provides quick access to switch between the last 2 used Property panels
@@ -0,0 +1,20 @@
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.
Menus
-----
The `File` menu in the Topbar adds menu entries to Create/Open and Save an IFC project directly.
.. figure:: images/interface_window_file-menue.png
:alt: Additional file menu options related to IFC projects
Additional file menu options related to IFC projects.
BIM Workspace
-------------
BlenderBIM adds the **BIM** Workspace to the Topbar Workspaces tabs.
@@ -1,12 +1,12 @@
Workspace
=========
BIM Workspace
=============
For general informations about the Blender user interface see the respective
`Blender handbook section <https://docs.blender.org/manual/en/latest/interface/index.html>`__.
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 BlenderBIM the default Blender start-up screen looks different from the standard Blender interface.
BlenderBIM adds a new `BIM` **Workspace** to the interface and by default activates this workspace on start-up.
BlenderBIM 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.
@@ -16,7 +16,7 @@ The right **Properties** panel shows data and relationships.
Blender start-up window with installed BlenderBIM add-on.
1. BlenderBIM `BIM` workspace tab
1. **BIM** Workspace tab
2. Outliner with the document tree
3. Main 3D viewport
4. Property editor
@@ -24,9 +24,3 @@ The right **Properties** panel shows data and relationships.
6. Sidebar with BlenderBIM & 4D/5D Toolkit panels
7. Status bar with information about the currently used Blender and BlenderBIM version
Additionally, the `File` menue in the Topbar adds menue entries to Create/Open and Save an IFC project directly.
.. figure:: images/interface_window_file-menue.png
:alt: Additional file menue options related to IFC projects
Additional file menue options related to IFC projects.