mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-09 17:31:45 +00:00
Refactor Project Info panel to clarify distinct modes (#4880)
* Rename modes in Project Info documentation * Refactor project info panel UI code
This commit is contained in:
John Yani
@@ -96,13 +96,16 @@ class BIM_PT_project(Panel):
|
||||
pprops = context.scene.BIMProjectProperties
|
||||
self.file = IfcStore.get_file()
|
||||
if pprops.is_loading:
|
||||
self.draw_load_ui(context)
|
||||
self.draw_advanced_loading_ui(context)
|
||||
elif self.file or props.ifc_file:
|
||||
self.draw_project_ui(context)
|
||||
if props.ifc_file:
|
||||
self.draw_loaded_project_ui(context)
|
||||
else:
|
||||
self.draw_unsaved_project_ui(context)
|
||||
else:
|
||||
self.draw_create_project_ui(context)
|
||||
self.draw_project_setup_ui(context)
|
||||
|
||||
def draw_load_ui(self, context):
|
||||
def draw_advanced_loading_ui(self, context):
|
||||
pprops = context.scene.BIMProjectProperties
|
||||
prop_with_search(self.layout, pprops, "filter_mode")
|
||||
if pprops.filter_mode in ["DECOMPOSITION", "IFC_CLASS", "IFC_TYPE"]:
|
||||
@@ -160,12 +163,8 @@ class BIM_PT_project(Panel):
|
||||
row.operator("bim.load_project_elements")
|
||||
row.operator("bim.unload_project", text="", icon="CANCEL")
|
||||
|
||||
def draw_project_ui(self, context):
|
||||
props = context.scene.BIMProperties
|
||||
def draw_editing_buttons(self, context, row):
|
||||
pprops = context.scene.BIMProjectProperties
|
||||
row = self.layout.row(align=True)
|
||||
row.label(text=os.path.basename(props.ifc_file) or "No File Found", icon="FILE")
|
||||
|
||||
if IfcStore.get_file():
|
||||
if pprops.is_editing:
|
||||
row.operator("bim.edit_header", icon="CHECKMARK", text="")
|
||||
@@ -173,6 +172,10 @@ class BIM_PT_project(Panel):
|
||||
else:
|
||||
row.operator("bim.enable_editing_header", icon="GREASEPENCIL", text="")
|
||||
|
||||
def draw_editable_file_info(self, context):
|
||||
pprops = context.scene.BIMProjectProperties
|
||||
|
||||
if IfcStore.get_file():
|
||||
row = self.layout.row(align=True)
|
||||
row.label(text="IFC Schema", icon="FILE_CACHE")
|
||||
row.label(text=IfcStore.get_file().schema)
|
||||
@@ -200,27 +203,48 @@ class BIM_PT_project(Panel):
|
||||
if "[" in mvd:
|
||||
mvd = mvd.split("[")[1][0:-1]
|
||||
row.label(text=mvd)
|
||||
|
||||
else:
|
||||
row = self.layout.row(align=True)
|
||||
row.label(text="File Not Loaded", icon="ERROR")
|
||||
|
||||
if props.ifc_file:
|
||||
row = self.layout.row(align=True)
|
||||
if context.scene.BIMProperties.is_dirty:
|
||||
row.label(text="Saved*", icon="EXPORT")
|
||||
else:
|
||||
row.label(text="Saved", icon="EXPORT")
|
||||
row.label(text=ProjectData.data["last_saved"])
|
||||
def draw_unsaved_project_ui(self, context):
|
||||
# file name row
|
||||
file_name_row = self.layout.row(align=True)
|
||||
file_name_row.label(text="No File Found", icon="FILE")
|
||||
self.draw_editing_buttons(context, file_name_row)
|
||||
|
||||
row = self.layout.row(align=True)
|
||||
row.prop(props, "ifc_file", text="")
|
||||
row.operator("bim.select_ifc_file", icon="FILE_FOLDER", text="")
|
||||
row.operator("bim.unload_project", text="", icon="CANCEL")
|
||||
# main section
|
||||
self.draw_editable_file_info(context)
|
||||
|
||||
# file path row and actions section
|
||||
row = self.layout.row()
|
||||
row.label(text="File Not Saved", icon="ERROR")
|
||||
|
||||
def draw_loaded_project_ui(self, context):
|
||||
# file name row
|
||||
props = context.scene.BIMProperties
|
||||
file_name_row = self.layout.row(align=True)
|
||||
file_name_row.label(text=os.path.basename(props.ifc_file), icon="FILE")
|
||||
self.draw_editing_buttons(context, file_name_row)
|
||||
|
||||
# main section
|
||||
self.draw_editable_file_info(context)
|
||||
|
||||
# file path row and actions section
|
||||
row = self.layout.row(align=True)
|
||||
if context.scene.BIMProperties.is_dirty:
|
||||
row.label(text="Saved*", icon="EXPORT")
|
||||
else:
|
||||
row = self.layout.row()
|
||||
row.label(text="File Not Saved", icon="ERROR")
|
||||
row.label(text="Saved", icon="EXPORT")
|
||||
row.label(text=ProjectData.data["last_saved"])
|
||||
|
||||
def draw_create_project_ui(self, context):
|
||||
row = self.layout.row(align=True)
|
||||
row.prop(props, "ifc_file", text="")
|
||||
row.operator("bim.select_ifc_file", icon="FILE_FOLDER", text="")
|
||||
row.operator("bim.unload_project", text="", icon="CANCEL")
|
||||
|
||||
def draw_project_setup_ui(self, context):
|
||||
props = context.scene.BIMProperties
|
||||
pprops = context.scene.BIMProjectProperties
|
||||
prop_with_search(self.layout, pprops, "export_schema")
|
||||
|
||||
@@ -3,8 +3,7 @@ Let's get started
|
||||
|
||||
The BlenderBIM Add-on lets you analyse, create, and modify OpenBIM with Blender.
|
||||
|
||||
Quickstart video tutorial
|
||||
-------------------------
|
||||
**Quickstart video tutorial**
|
||||
|
||||
Learn how to model a small building and create simple architectural plans, sections, 2D details, and sheet layouts in this short tutorial series.
|
||||
|
||||
|
||||
@@ -62,13 +62,14 @@ Filtered model loading
|
||||
----------------------
|
||||
|
||||
You may filter elements and only load a portion of the model. Click on
|
||||
:ref:`Advanced Mode <Project Info Advanced Mode>` checkbox when loading a model.
|
||||
:ref:`Enable Advanced Mode <Project Info Advanced Loading Mode>` checkbox when loading a model.
|
||||
|
||||
|
||||
.. image:: images/advanced-mode.png
|
||||
|
||||
This will preload the model and present you with model loading options in the
|
||||
**IFC Project** panel.
|
||||
:doc:`Project Info </users/user_interface/property_editor/scene_editor/project_overview/project_info>`
|
||||
panel.
|
||||
|
||||
.. image:: images/advanced-mode-settings.png
|
||||
|
||||
@@ -89,7 +90,7 @@ Large polygon counts
|
||||
--------------------
|
||||
|
||||
If objects with large polygon counts are blocking you from importing, consider
|
||||
enabling **Native Meshes** in the **Advanced Mode** when loading projects.
|
||||
enabling **Native Meshes** in the :ref:`Advanced Loading Mode <Project Info Advanced Loading Mode>` when loading projects.
|
||||
|
||||
The **Debug Panel** allows you to **Select High Polygon Meshes** or **Select
|
||||
Highest Polygon Meshes** to isolate geometrically complex objects by a polygon
|
||||
@@ -123,8 +124,8 @@ here.
|
||||
High number of elements
|
||||
-----------------------
|
||||
|
||||
Click on **Enable Advanced Mode** when loading a model and you will be presented
|
||||
with model loading options in the **IFC Project** panel.
|
||||
Click on :ref:`Enable Advanced Mode <Project Info Advanced Loading Mode>` when loading a model and you will be presented
|
||||
with model loading options in the **Project Info** panel.
|
||||
|
||||
You may specify an **Element Range** to process. The **Element Offset** says the
|
||||
first element to start processing at, and the **Element Limit** says how many
|
||||
@@ -146,8 +147,8 @@ geometry and basic attributes such as names are sufficient. Example usecases
|
||||
include CG visualisation, overall federated model coordination, or pure
|
||||
geometric checks.
|
||||
|
||||
Click on **Enable Advanced Mode** when loading a model and you will be presented
|
||||
with model loading options in the **IFC Project** panel. Enable **For
|
||||
Click on :ref:`Enable Advanced Mode <Project Info Advanced Loading 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.
|
||||
|
||||
@@ -144,10 +144,10 @@ temporarily affects your Blender session.
|
||||
This distance limit of 1km and autodetected false origin may not be appropriate
|
||||
for your project. For example, your project may exceed the 1km limit, or you may
|
||||
want to federate multiple files together and manually specify a consistent and
|
||||
fixed false origin. You can customise these options by choosing **Enable
|
||||
Advanced Mode** when loading a project. Then, set the **Distance Limit** (in
|
||||
meters) and the **False Origin** coordinate before pressing **Load Project
|
||||
Elements**.
|
||||
fixed false origin. You can customise these options by choosing
|
||||
:ref:`Enable Advanced Mode <Project Info Advanced Loading Mode>` when loading a project.
|
||||
Then, set the **Distance Limit** (in meters) and the **False Origin** coordinate
|
||||
before pressing **Load Project Elements**.
|
||||
|
||||
.. image:: images/manualorigin.png
|
||||
|
||||
|
||||
+40
-34
@@ -14,22 +14,22 @@ 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:
|
||||
The "Project Info" panel has four distinct modes 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)
|
||||
1. `Project Setup Mode`_
|
||||
2. `Project Unsaved Mode`_
|
||||
3. `Project Loaded Mode`_
|
||||
4. `Advanced Loading 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.
|
||||
There's also an editing submode in some modes 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
|
||||
---------------------------
|
||||
Project Setup Mode
|
||||
------------------
|
||||
|
||||
.. figure:: images/interface_property-editor_project-overview_new_load.png
|
||||
:alt: Project Info when project is not created or loaded
|
||||
:alt: Project Info in Project Setup Mode
|
||||
|
||||
When no IFC file is loaded, the "Project Info" panel displays options to create a new IFC project or load an existing one.
|
||||
When no IFC file is loaded or created, the "Project Info" panel displays options to create a new IFC project or load an existing one.
|
||||
|
||||
Fields
|
||||
^^^^^^
|
||||
@@ -80,20 +80,26 @@ Buttons
|
||||
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.
|
||||
|
||||
After creation Project Info will transition into `Project Unsaved Mode`_
|
||||
|
||||
**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
|
||||
---------------
|
||||
This will open an Open Dialog that is customized with some additional IFC loading functionality. See `Advanced Loading Mode`_
|
||||
|
||||
After loading Project Info will transition into `Project Loaded Mode`_
|
||||
|
||||
Project Unsaved Mode
|
||||
--------------------
|
||||
|
||||
.. 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`_).
|
||||
The IFC header can be edited by clicking the pencil button (see `Project Info Editing Mode`_).
|
||||
|
||||
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.
|
||||
Caveat: In this mode you can't unload the IFC project and go back to the Project Setup Mode. You have to save the IFC file first and then unload the project.
|
||||
|
||||
Static text
|
||||
^^^^^^^^^^^
|
||||
@@ -119,10 +125,10 @@ 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.
|
||||
Clicking this button switches the "Project Info" panel to `editing mode <Project Info Editing Mode_>`_, allowing users to modify the IFC header fields.
|
||||
|
||||
Saved and Loaded State
|
||||
----------------------
|
||||
Project Loaded Mode
|
||||
-------------------
|
||||
|
||||
.. figure:: images/interface_property-editor_project-overview_saved.png
|
||||
:alt: Project Info when IFC project is created and IFC file is saved
|
||||
@@ -134,10 +140,10 @@ Fields
|
||||
Displays the name of the loaded IFC file. Example: "demo.ifc"
|
||||
|
||||
|FILE_CACHE| **IFC Schema** (read-only)
|
||||
Same as in `Not Saved State`_.
|
||||
Same as in `Project Unsaved Mode`_.
|
||||
|
||||
|FILE_HIDDEN| **IFC MVD**
|
||||
Same as in `Not Saved State`_.
|
||||
Same as in `Project Unsaved Mode`_.
|
||||
|
||||
|EXPORT| **Saved**
|
||||
Displays the last saved date and time of the loaded IFC file. Example: "2024-06-10 13:15"
|
||||
@@ -149,22 +155,22 @@ Buttons
|
||||
^^^^^^^
|
||||
|
||||
|GREASEPENCIL| **Edit**
|
||||
Same as in `Not Saved State`_, switches to `editing mode <IFC Header Editing toggle_>`_.
|
||||
Same as in `Project Unsaved Mode`_, switches to `editing mode <Project Info Editing Mode_>`_.
|
||||
|
||||
**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.
|
||||
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, switching it to the Project Setup Mode.
|
||||
|
||||
|
||||
IFC Header Editing toggle
|
||||
Project Info Editing Mode
|
||||
-------------------------
|
||||
|
||||
.. 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.
|
||||
Clicking the pencil button (which doesn't exist when in the Project Setup Mode) switches the "Project Info" panel to `editing mode <Project Info 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
|
||||
^^^^^^
|
||||
@@ -200,39 +206,39 @@ Buttons
|
||||
**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:
|
||||
.. _Project Info Advanced Loading Mode:
|
||||
|
||||
|
||||
Preloaded State (Advanced Mode)
|
||||
-------------------------------
|
||||
Advanced Loading 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.
|
||||
The Advanced Loading Mode is an additional mode that is available when loading an IFC file using the **Enable 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,
|
||||
The Advanced Loading Mode 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.
|
||||
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 Loading Mode,
|
||||
the "Project Info" panel will transition to the `Project Loaded Mode`_, displaying the relevant metadata and options for the loaded IFC project.
|
||||
|
||||
|
||||
To access this mode, click on "Advanced Mode" checkbox when loading a model.
|
||||
To access this mode, click on **Enable 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:
|
||||
In the Advanced Loading Mode, the "Project Info" panel presents the following options:
|
||||
|
||||
.. image:: images/advanced-mode-settings.png
|
||||
:alt: Project Info when in Advanced Mode Loading State
|
||||
:alt: Project Info when in Advanced Loading Mode
|
||||
|
||||
Fields
|
||||
^^^^^^
|
||||
|
||||
Reference in New Issue
Block a user