Work in progress starting to restructure docs in preparation for next release

This commit is contained in:
Dion Moult
2024-08-22 23:56:43 +10:00
parent 951b2b76a6
commit 53d7624fc4
192 changed files with 151 additions and 825 deletions
+7
View File
@@ -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.
Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

@@ -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
Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

@@ -0,0 +1,19 @@
Drawings and documents
======================
.. figure:: images/interface_property-editor_drawings-documents.png
:alt: property editor drawings and documents sub-tab
Drawings and Documents sub-tab.
Sheets
tbd
Drawings
tbd
Schedules
tbd
References
tbd
Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

@@ -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
Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

@@ -0,0 +1,250 @@
Geometry and Materials
======================
.. figure:: images/interface_property-editor_geometry-materials.png
:alt: property editor geometry and materials sub-tab
Geometry and Materials sub-tab.
The Geometry and Materials sub-tab in the Property Editor provides access to various aspects of an IFC element's
geometric representation and material properties.
This section is crucial for viewing and editing the physical and visual characteristics of IFC elements.
Placement
---------
.. figure:: images/placement.png
:alt: Placement panel in the Geometry and Materials sub-tab
Placement panel in the Geometry and Materials sub-tab
The Placement panel allows you to view and edit the spatial position and orientation of the IFC element within the project.
Location
^^^^^^^^
The Location fields display and allow editing of the element's position in 3D space:
- X: The position along the X-axis (left/right)
- Y: The position along the Y-axis (front/back)
- Z: The position along the Z-axis (up/down)
These values are typically measured in the project's chosen unit of measurement.
Rotation
^^^^^^^^
The Rotation fields show and allow modification of the element's orientation:
- X: Rotation around the X-axis (pitch)
- Y: Rotation around the Y-axis (roll)
- Z: Rotation around the Z-axis (yaw)
Rotation values are measured in degrees.
Derived Coordinates
^^^^^^^^^^^^^^^^^^^
This section provides additional information about the element's placement:
**Edit Object Placement**
A button that allows you to manually edit the object's placement.
**XYZ Dimensions**
Displays the absolute bounding box dimensions of the object.
**Min Global Z and Max Global Z**
Shows the lowest and highest points of the object in the global Z coordinate system.
**Min Decomposed Z and Max Decomposed Z**
Indicates the lowest and highest points of the object when considering its decomposed parts or components.
Note: The specific units used may depend on your project settings. Always ensure you're working in the correct units when adjusting placement values.
For more detailed information about Object Placements in IFC,
including how they are represented mathematically and how to create them programmatically,
please refer to the `IfcOpenShell documentation on Object Placements <https://docs.ifcopenshell.org/ifcopenshell-python/geometry_creation.html#object-placements>`_.
Representations
---------------
.. figure:: images/representations.png
:alt: Representations panel in the Geometry and Materials sub-tab
Representations panel in the Geometry and Materials sub-tab
The Representations panel allows you to view and manage the geometric representations of an IFC element.
In IFC, an element can have multiple representations for different purposes or contexts.
Adding Representations
^^^^^^^^^^^^^^^^^^^^^^
At the top of the panel, you can add new representations to the element:
1. Select the desired representation context from the dropdown menu (e.g., Model, Plan).
2. Click the "+" button next to the dropdown.
3. A dialog box will appear, allowing you to choose the type of representation to add (e.g., Trace Outline, Bounding Box).
4. Depending on the chosen type, you may be prompted to select an object as the basis for the new representation.
This feature allows you to create multiple representations for different purposes, such as simplified views, detailed 3D models, or 2D symbols.
.. figure:: images/add-representation-dialog.png
:alt: Add Representation dialog
Add Representation dialog
Representation List
^^^^^^^^^^^^^^^^^^^
Below the add representation controls, you can see a list of representations.
Each row shows the context (e.g., Model, Plan) and type (e.g., Axis, Body) of a representation.
Two buttons are available for each representation in the list:
1. View/Edit button: This button allows you to switch to the selected representation and view or edit it in the 3D view.
It's useful for inspecting or modifying specific representations of the element.
- When a representation is not active, this button appears as a standard "switch/geometry" icon.
- When a representation is active (i.e., currently being viewed/edited), the button changes to a "reload" icon.
This visual cue helps you identify which representation is currently active in the 3D view.
2. Delete button: This button allows you to remove the selected representation from the element.
Use this with caution, as deleting a representation can affect how the element is displayed or used in different contexts.
The ability to switch between representations and visually identify the active one allows for efficient management of multiple geometric
representations for a single IFC element.
Representation Items
^^^^^^^^^^^^^^^^^^^^
This section lists the items that make up the current representation. In the example, there is one item of type "IfcExtrudedAreaSolid".
- You can select items to view or edit their properties.
- The "x" button allows you to remove items from the representation.
Surface Style
~~~~~~~~~~~~~
Indicates whether a surface style is applied to the representation. You can assign a style using the pencil icon.
Presentation Layer
~~~~~~~~~~~~~~~~~~
Shows if the representation is assigned to a presentation layer. This can be useful for organizing and displaying elements in CAD or BIM software.
Shape Aspect
~~~~~~~~~~~~
Displays any shape aspects associated with the representation. Shape aspects can define specific parts or features of the geometry.
Representation Utilities
^^^^^^^^^^^^^^^^^^^^^^^^
This section provides advanced tools for manipulating representations:
- Manually Save Representation: Allows direct saving of representation data.
- Copy Mesh From Active To Selected: Copies mesh data between representations.
- Convert To Tessellation: Transforms the representation into a tessellated form.
- Convert To Rectangle Extrusion: Changes the representation to a simple rectangular extrusion.
- Convert To Circle Extrusion: Changes the representation to a circular extrusion.
- Convert To Arbitrary Extrusion: Allows for custom extrusion shapes.
- Convert To Arbitrary Extrusion With Voids: Similar to above, but includes the ability to add voids.
- Get Representation IFC Parameters: Retrieves the IFC-specific parameters of the representation.
Note: These utilities are marked as "Advanced Users Only" and should be used with caution,
as they can significantly alter the element's geometry and IFC data.
For more detailed information about IFC Representations and how they are handled in IfcOpenShell,
refer to the `IfcOpenShell documentation on Representations <https://docs.ifcopenshell.org/ifcopenshell-python/geometry_creation.html#representations>`_.
Geometric Relationships
-----------------------
.. figure:: images/geometric_relationships.png
:alt: Geometric Relationships panel in the Geometry and Materials sub-tab
Geometric Relationships panel in the Geometry and Materials sub-tab
The Geometric Relationships panel provides tools and information about how the current IFC element relates geometrically to other elements in the model.
Vendor Workarounds
^^^^^^^^^^^^^^^^^^
This section contains options to force certain geometric behaviors:
- Force Faceted Breps: Converts curved surfaces to faceted representations.
- Force Triangulation: Ensures all polygonal faces are triangulated.
- Force Presentation Style Assignment: Applies presentation styles to all geometric items.
These options can be useful when working with software that has specific geometric requirements or limitations.
Presentation Layers
^^^^^^^^^^^^^^^^^^^
Displays and manages the presentation layers associated with the element. The pencil icon allows you to add or manage presentation layers.
Note: There are known bugs an limitations with using presentation layers.
.. tip::
While layers are supported for compatibility with CAD environments,
consider using IFC properties, groups, or model views for more advanced data organization in BIM workflows.
Voids
^^^^^
Lists the voids (openings) associated with the element. Each void has an associated element.
The "x" button allows you to remove a void from the element.
Booleans
^^^^^^^^
Shows boolean operations applied to the element's geometry. The panel displays the number of booleans found and how many are manual (user-defined) versus automatic.
- The "+" button allows you to add a new boolean operation.
- The dropdown menu lets you choose the type of boolean operation.
- The "x" button removes the selected boolean operation.
Connections
^^^^^^^^^^^
Lists other elements that are geometrically connected to the current element. In this example, "Wall.006" is connected "AT_START" to the current element.
- The connection type (e.g., AT_START) indicates how the elements are related.
- The arrow button likely allows you to navigate to the connected element.
This panel is crucial for understanding and managing the geometric relationships between different elements in your IFC model,
including openings, boolean operations, and connections to other building components.
Parametric Geometry
-------------------
.. figure:: images/geometric_relationships.png
:alt: Parametric Geometry panel in the Geometry and Materials sub-tab
Parametric Geometry panel in the Geometry and Materials sub-tab
For elements with parametric definitions,
this panel allows you to view and edit the parameters that control the element's geometry.
This is particularly useful for elements like doors, windows, stairs, etc.
Parametric geometry allows for efficient modeling and updating of BIM elements while maintaining IFC compatibility.
Experiment with the available options to find parametric workflows that suit your modeling needs.
Materials
---------
.. figure:: images/materials.png
:alt: Materials panel in the Geometry and Materials sub-tab
Materials panel in the Geometry and Materials sub-tab
The Materials panel allows you to manage material assignments for IFC elements.
You can assign materials to elements, create and edit material definitions, and manage material layers for layered elements (e.g., walls).
Styles
------
The Styles panel is used to manage presentation styles for elements, including surface styles (color, texture, etc.),
curve styles (line color, thickness, etc.), and fill area styles. These styles control how elements are visually represented in various contexts,
such as in 2D drawings or 3D views.
Profiles
--------
The Profiles panel is used to manage cross-sectional profiles for elements such as beams, columns, or railings.
You can create new profiles, edit existing ones, or assign profiles to elements.
Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 513 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

@@ -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
Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

@@ -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 Bonsai 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,384 @@
Project Info
============
.. container:: location-scene
|location| Scene Properties |>| Project Overview |>| Project Info
.. |location| image:: /images/location-scene.svg
.. |>| image:: /images/location-breadcrumb.svg
.. warning::
It's recommended to avoid using the "Unload IFC project" button,
as it may promote the misconception that the .blend file can continue without the IFC data.
Always start a new Blender session for a clean project start.
The Unload IFC project button will be removed in future versions.
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 modes depending on the state of the IFC project:
1. `Project Setup Mode`_
2. `Project Unsaved Mode`_
3. `Project Loaded Mode`_
4. `Advanced Loading Mode`_
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.
Project Setup Mode
------------------
.. figure:: images/interface_property-editor_project-overview_new_load.png
:alt: Project Info in Project Setup Mode
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
^^^^^^
|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://bonsaibim.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.
- **Blank**: Start with an empty project and no predefined objects.
- **IFC4 Demo Template**: Includes a basic set of common object types like bunny, windows, doors, and other basic elements with complex geometry.
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.
Bonsai provides other larger libraries containing hundreds of objects, but
loading them as a template is not recommended due to their size and
complexity.
.. 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.
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.
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 `Project Info Editing Mode`_).
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
^^^^^^^^^^^
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 <Project Info Editing Mode_>`_, allowing users to modify the IFC header fields.
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
Fields
^^^^^^
|FILE| **Filename**
Displays the name of the loaded IFC file. Example: "demo.ifc"
|FILE_CACHE| **IFC Schema** (read-only)
Same as in `Project Unsaved Mode`_.
|FILE_HIDDEN| **IFC MVD**
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"
**IFC File**
Shows the location of the loaded IFC file on the user's file system. Example: "/home/user/Docum...lenderbim/demo.ifc". If part of the path is hidden by ellipsis, hovering over it will reveal the full file path.
Buttons
^^^^^^^
|GREASEPENCIL| **Edit**
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 `Project Setup Mode`_.
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 Project Setup Mode) switches the "Project Info" panel to `editing mode <Project Info Editing Mode_>`_, allowing users to modify the IFC header.
The header section has information about:
- the IFC version used
- the application that exported the file
- the date and time when the export was done
- other optional user defined fields like the author's name, company and authorizing person of the file
The IFC Schema version cannot be edited in this mode. However, you have the option to upgrade the IFC schema when opening a file.
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. Example: "Nobody". The authoriser typically represents the person or entity responsible for approving the IFC file and its contents.
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.
.. _Project Info Advanced Loading Mode:
Advanced Loading Mode
---------------------
.. seealso::
:ref:`users/advanced/dealing_with_large_models:Filtered model loading`.
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 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 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 **Enable Advanced Mode** checkbox when loading a model.
.. image:: images/advanced-mode.png
:alt: Open file dialog
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 Loading Mode
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**
Maximum distance between a curved surface and its tessellation (mesh approximation).
Higher values result in a coarser tessellation, while lower values produce a finer mesh approximation.
.. seealso
`IfcOpenShell deflection_tolerance <https://docs.ifcopenshell.org/ifcopenshell/geometry_settings.html#deflection-tolerance>`__
**Angular Tolerance**
Maximum angle between adjacent face normals in a tessellation (mesh approximation).
Higher values result in a smoother tessellation, while lower values may produce more angular or faceted surfaces.
.. seealso
`IfcOpenShell angular_tolerance <https://docs.ifcopenshell.org/ifcopenshell/geometry_settings.html#angular-tolerance>`__
**Void Limit**
The maximum number of voids or openings an element can have before being considered excessive and skipped during the loading process.
Elements with a number of openings exceeding the specified limit will be excluded from the loaded model,
and a warning message will be displayed in the console, listing the skipped elements.
Openings slowdown the rendering process, so lower values result in improved performance.
**Distance Limit**
Maximum distance between vertices in a tessellation (mesh approximation).
Higher values result in a coarser mesh, while lower values produce a denser mesh with more vertices.
**False Origin Mode**
Sets the origin point or reference point for the loaded model geometry. This can be useful for aligning or positioning the model within the Blender scene.
There are three modes available for setting the False Origin:
- **Automatic**: An automatic false origin will be detected and applied based on the geometry with large coordinate values.
This mode is useful when the model's coordinates are extremely large or outside the typical Blender coordinate range.
- **Manual**: You can specify the false origin coordinates manually.
This mode allows you to enter the desired origin coordinates in the project's units (e.g., meters, millimeters) where the Blender origin (0,0,0) should be positioned.
- **Disabled**: The model will be loaded with its original local coordinates, without any false origin adjustments.
This mode is suitable when the model's coordinates are within the standard Blender coordinate range and do not require any origin shifting.
When the "Manual" mode is selected, an additional field **False Origin** will appear,
allowing you to enter the desired false origin coordinates in the project's units, separated by commas (e.g., "20.1,10.9,-3.1").
Applying a false origin can help prevent precision issues and ensure accurate positioning and scaling of the model within the Blender scene,
especially when working with large-scale projects or models with coordinates outside the typical Blender range.
**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.
- **Element Offset**: Specifies the starting index of the elements to be loaded.
- **Element Limit**: Specifies the maximum number of elements to be loaded from the specified offset.
For example, if the offset is set to 10 and the limit is set to 50, only 50 elements will be loaded, starting from the 11th element.
If no offset or limit is specified, all elements within the specified filter criteria will be loaded.
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
+60
View File
@@ -0,0 +1,60 @@
Properties
==========
.. container:: location-scene
|location| Scene Properties
.. |location| image:: /images/location-scene.svg
Bonsai 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 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
Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

@@ -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
+178
View File
@@ -0,0 +1,178 @@
Scene Properties
================
The scene properties panels allow you to manage data that applies to your entire
IFC project as a whole, or to multiple elements.
Building Information Modeling Panel
-----------------------------------
System Setup
^^^^^^^^^^^^
* **Quick Project Setup** - this will create a basic spatial tree. It will
create a tree of collections with the structure ``IfcProject > IfcSite >
IfcBuilding > IfcStorey`` This is merely for convenience instead of having to
create it all by yourself, since all IFC exports require a valid spatial
tree. You can see the tree of collections in the outliner when this is done.
* **Schema Directory** - this folder stores the current IFC schema. You can
download different schemas from the buildingSMART website. Unless you are an
IFC guru, you probably shouldn't touch this. Bonsai recognises different
IFC data based on what is provided in this schema folder. It defaults to the
``{{BLENDER_ADDONS_DIR}}/bonsai/schema/`` folder, which is prepackaged
with the IFC4 schema. This is known as the ``{SCHEMA_DIR}``.
* **Data Directory** - the data directory holds the auxiliary data related to
your IFC model. Examples include related property definitions, documents, and
classification systems. Each project should have its own data directory. It
defaults to the data directory in the
``{{BLENDER_ADDONS_DIR}}/bonsai/data/`` folder, which comes with some
example preset data. You are encouraged to copy this template and set your
own. This is known as the ``{DATA_DIR}``.
Software Identity
^^^^^^^^^^^^^^^^^
* **GlobalId** - this field let's you enter an IFC element's ``GlobalId``. It
must be in the 22-character encoded form.
* **Select GlobalId** - this will select an element that has the same
``GlobalId`` attribute as what you have specified, based on what is currently
visible in the scene.
IFC Categorisation
^^^^^^^^^^^^^^^^^^
* **IFC Class** - this dropdown lets you pick from a list of all non-abstract
children of ``IfcElement`` and ``IfcSpatialStructureElement``
* **IFC Predefined Type** - this dropdown lets you pick from an enumeration of
valid ``PredefinedType`` values for the currently selected *IFC Class*. It
changes dynamically with the currently selected *IFC Class*.
* **IFC Userdefined Type** - this field lets you enter a value for a user
defined type. It is stored as the ``ObjectType`` attribute of an
``IfcProduct``. It is only set when the **IFC Predefined Type** is set to
``USERDEFINED``, otherwise it is ignored. It is recommended to make this
value uppercase and alphabetic, to match the conventions for the
``PredefinedType`` enumeration.
* **Assign Class** - this applies the active *IFC Class*, *IFC Predefined Type*
and *IFC Userdefined Type* to any selected objects.
* **Select Class** - this will select any objects that are currently visible
that also have the same IFC class as the currently active *IFC Class* dropdown.
* **Select Type** - same as *Select Class*, but it also filters by the
currently active *IFC Predefined Type* dropdown, as well as the *IFC
Userdefined Type* field.
Property Sets
^^^^^^^^^^^^^
- **Pset Name** - this lets you select from a list of available property set
types. The list is derived from the folders in
``{DATA_DIR}/pset``. Each folder name corresponds to a property set name. If
you want to assign properties to an object based on an IFC standard pset,
just create a new folder with the same name as the pset. You can also create
your own custom property sets, so long as the folder name does not start with
``Pset_``, as these are reserved for official IFC property sets.
- **Pset File** - this lets you select from a list of available property set
data. The available property sets depends on the currently selected *PSet
Name* dropdown. Each property set is represented by a ``.csv`` file inside
``{DATA_DIR}/pset/{PSET_NAME}/``. You can create your own ``.csv`` files
with any software, where each line contains a property name and property
value pair. Data types are automatically converted based on the property set
templates defined in ``{SCHEMA_DIR}``. If the pset is part of an official IFC
standard, you can only use property names that are part of the IFC standard.
If you want to add your own custom properties, you will need to create your
own *PSet Name* folder first, and then you can put in your own ``.csv`` file
which contains any property names and values that you want.
- **Assign Pset** - this assigns the currently selected *Pset file* to any
selected objects. The assigned data will then be visible in the *Object
Properties*. This only assigns a link to the ``.csv`` containing the data, so
you can change the data in the ``.csv`` file and that will automatically
propagate to all assigned elements when an IFC is exported, without needing
to reassign the data.
- **Unassign Pset** - this removes the link to the property set ``.csv``
file for all currently selected objects.
Aggregates
^^^^^^^^^^
- **Aggregate Class** - this lets you select what type of class you want an
aggregate of parts to be.
- **Aggregate name** - this lets you set the name of an aggregate that you can
can create.
- **Create Aggregate** - this will create a new aggregate from one or more
currently selected objects. The selected objects will be moved out of the
spatial tree into an ``IfcRelAggregates/*`` collection. Then, a collection
instance will be created to represent the aggregation, and will be placed in
the current location of the spatial tree, and the The parts will then be
hidden so only the whole composition (i.e. the aggregate object) will be shown.
- **Explode Aggregate** - this does the opposite of *Create Aggregate*, and
will remove the aggregation.
- **Edit Aggregate** - this will hide the collection instance that represents
the aggregate object, and show all of the individual parts. This allows you
to select and modify the aggregate parts.
- **Save Aggregate** - this does the opposite of *Edit Aggregate*.
IFC Classifications Panel
-------------------------
- **Classification** - this lets you select which classification system you'd
like to use. The list of possible classification systems is derived from the
``{DATA_DIR}/class/classifications.csv`` file. By default, Bonsai comes
with Uniclass 2015 and Omniclass. If you need another classification system,
you can add it to this ``.csv`` file.
- **Reference** - this lets you select a single classification reference item,
filtered depending on the currently active *Classification*. The list is
derived from the ``{DATA_DIR}/class/references.csv`` file. Out of the box,
Bonsai only lists a single Uniclass reference as an example. It is
advised to make a list of all the references you require for a project and
add it to this ``.csv`` file.
- **Assign Classification** - this assigns the currently active *Reference* to
all of the selected objects. You can see the results in the *Object
Properties* pane.
- **Unassign Classification** - this removes the currently active *Reference*
in all of the selected objects.
IFC Owner History Panel
-----------------------
- **Person** - this lets you select who you are. The values are derived from
the ``{DATA_DIR}/owner/person.json`` file, particularly the
``Identification`` attribute, which is mandatory and a requirement in COBie
data. You are encouraged to edit this file to add your own details. This
information will be stored in the IFC file as part of the owner history to
keep track of any objects which you edit. You will also be recorded as the
author of the IFC file.
- **Organisation** - this lets you select which organisation you are part of.
The values are derived from the ``{DATA_DIR}/owner/organisation.json`` file,
in particular the ``Name`` attribute, which is mandatory and a requirement in
COBie data. You are encouraged to edit this file to add your own organisation
details. This information will be stored in the IFC file as part of the
owner history to keep track of any objects which you edit. The organisation
will also be recorded as the author of the IFC file.
IFC Geometric Representation Contexts Panel
-------------------------------------------
- **Has Model Context** - enabling this will allow you to export geometric data
related to the model view of your BIM data. This is generally 3D
representations. It may also contain wireframe representations such as an
Axis model for structural members. This defaults to being enabled, as most
people want to export model geometry.
- **Available Subcontexts** - this lets you select a possible subcontext to
be used underneath the Model context.
- **Available Target Views** - subcontexts may have a particular target view,
which you can set here.
- **Add Subcontext** - This will add a new subcontext based on the currently
selected *Available Subcontext* and *Available Target View*.
- **Subcontext Name** - for each subcontext you have added, it will show
you the subcontext name. By default, the ``Body`` subcontext is added,
as most people want to export the body geometry of products in their BIM data.
- **Subcontext Target View** - same as *Subcontext Name*, but shows the
target view. By default, the ``MODEL_VIEW`` target view is added, as most
people will be viewing the model geometry of your BIM data.
- **Remove Subcontext** - this will remove the subcontext.
- **Has Plan Context** - the same as *Has Model Context*, but it lets you add
subcontexts and target views related to the ``PLAN`` context of your BIM
data. This is usually plans, sections, RCPs, and other documentation views.
Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

@@ -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
Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

@@ -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.
+4
View File
@@ -0,0 +1,4 @@
Switch Tab
==========
Switch Tab button provides quick access to switch between the last 2 used Property panels
@@ -0,0 +1,7 @@
.. _annotation-tool:
Annotation Tool
---------------
Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`Shift` + :kbd:`7`
Use this to add various types of annotations to your model, such as text, dimensions, and markers.
@@ -0,0 +1,7 @@
.. _create-beam:
Create Beam
-----------
Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`0`
Use this tool to add structural beam elements to your model. You can define beam profiles, lengths, and materials.
@@ -0,0 +1,7 @@
.. _create-column:
Create Column
-------------
Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`9`
Use this tool to add vertical structural elements like columns or pillars to your model.
@@ -0,0 +1,7 @@
.. _covering-tool:
Covering Tool
-------------
Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`Shift` + :kbd:`0`
This tool is used for adding surface coverings to elements, such as wall finishes, flooring, and ceiling treatments.
@@ -0,0 +1,7 @@
.. _create-door:
Create Door
-----------
Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`7`
The Create Door tool allows you to insert door elements into walls. You can choose from various door types and adjust dimensions.
@@ -0,0 +1,7 @@
.. _create-duct:
Create Duct
-----------
Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`Shift` + :kbd:`2`
This tool is used for creating HVAC ductwork. You can specify duct sizes, shapes, and routing.
@@ -0,0 +1,7 @@
.. _create-element:
Create Element
--------------
Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`Shift` + :kbd:`6`
A generic tool for creating custom IFC elements. This is useful for elements that don't have a specific creation tool.
@@ -0,0 +1,52 @@
Explore Tool
============
The Explore Tool is a powerful feature in Bonsai that enhances your ability to navigate and inspect IFC models.
It introduces functionality commonly found in dedicated IFC viewers,
making Bonsai a more comprehensive native IFC authoring and viewing tool.
Shortcut
--------
:kbd:`Shift` + :kbd:`Spacebar`, :kbd:`5`
Toolbar Icon
------------
.. figure:: images/toolbar_explore-tool.png
:alt: Explore tool icon in the Bonsai toolbar
Tool Options
------------
.. figure:: images/property-editor_explore-tool.png
:alt: Explore tool options in the property editor
Key Features
------------
- **Walk Mode** (Shortcut: :kbd:`Shift` + :kbd:`W`): Navigate through your model in a first-person perspective.
- Use :kbd:`W`, :kbd:`A`, :kbd:`S`, :kbd:`D` keys or arrow keys for movement.
- Provides a game-like experience for exploring interiors.
- **Add Clipping Plane** (Shortcut: :kbd:`Shift` + :kbd:`C`): Create a cutting plane to view cross-sections of your model.
- Drag the plane to adjust its position.
- Add multiple clipping planes simultaneously for complex views.
- **Flip Clipping Plane** (Shortcut: :kbd:`Shift` + :kbd:`F`): Reverse the direction of the active clipping plane.
Usage
-----
1. Activate the tool from the toolbar or use the shortcut.
2. Select the element you want to interact with.
3. Select the desired option by pressing the corresponding shortcut.
4. Interact with your model in the 3D viewport:
* For Walk Mode, use WASD or arrow keys to move through the model.
* For Clipping Plane, drag the plane to desired position and use Shift+F to flip if needed.
The Explore Tool significantly enhances the model navigation and inspection capabilities of Bonsai.
It's particularly useful for understanding spatial relationships, inspecting building cross-sections, and navigating through complex interiors.
These features make Bonsai more comparable to dedicated IFC viewers while retaining its powerful authoring capabilities.
Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 531 KiB

+166
View File
@@ -0,0 +1,166 @@
=======
Toolbar
=======
Tool System Overview
====================
Bonsai extends Blender's tool system, which provides a consistent way to interact with the 3D viewport. Here are some key points about the tool system:
- Tools are accessed from the Toolbar, typically located on the left side of the 3D viewport.
- Only one tool can be active per Workspace and mode.
- Most tools are controlled using the Left Mouse Button (LMB), though some use modifier keys.
- Press :kbd:`Shift` + :kbd:`Spacebar` to open the tool shortcut menu for quick access.
- The Quick Favorites menu (:kbd:`Q`) allows you to gather your most-used tools for easy access.
Bonsai integrates its tools seamlessly into this system, adding BIM-specific functionality while maintaining consistency with Blender's interface.
Tool Settings Access
--------------------
.. figure:: images/toolbar_tool-settings-access.png
Tool settings can be accessed in three different locations within the Blender interface:
1. **3D Viewport**: The active tool's settings appear in the header of the 3D Viewport, providing quick access to essential options.
2. **Sidebar (N panel)**: Tool settings can also be found in the Active Tool tab of the Sidebar. Access the Sidebar by pressing :kbd:`N` in the 3D Viewport.
3. **Properties Editor**: The Tool tab in the Properties editor offers another place for viewing settings of the active tool.
These multiple access points allow you to choose the most convenient location based on your workflow and screen layout.
Tool Tab in Property Editor
---------------------------
Each tool has its own set of options and settings,
which can be found in the Tool tab of the Properties editor.
This tab dynamically updates based on the currently active tool,
providing context-specific controls and parameters.
.. seealso::
For more detailed information on Blender's tool system,
refer to the `Blender Manual <https://docs.blender.org/manual/en/latest/interface/tool_system.html>`_.
Bonsai Tools
============
The Bonsai toolbar extends Blender's built-in toolbar with additional tools specific to BIM modeling.
These tools are positioned between the Transform and Annotate sections of the standard Blender toolbar.
.. tip::
Press :kbd:`Shift` + :kbd:`Spacebar` to open the tool shortcut menu.
From there, you can quickly select any tool using its corresponding number or letter key.
.. figure:: images/toolbar_shortcut-menu.png
.. seealso::
For more information on standard Blender toolbar,
see the `Toolbar section in Blender Manual <https://docs.blender.org/manual/en/latest/scene_layout/object/tools/toolbar.html>`_.
.. container:: toc-cards
.. container:: card
:doc:`explore`
Navigate and inspect your BIM model with advanced viewing options.
.. container:: card
:doc:`wall`
Add and manipulate wall elements in your floor plan.
.. container:: card
:doc:`slab`
Create floor and roof slabs in your BIM model.
.. container:: card
:doc:`door`
Insert and customize door elements in your walls.
.. container:: card
:doc:`window`
Add and adjust window elements in your walls.
.. container:: card
:doc:`column`
Place and modify structural column elements.
.. container:: card
:doc:`beam`
Add and customize beam elements in your structure.
.. container:: card
:doc:`duct`
Design and place HVAC ductwork in your model.
.. container:: card
:doc:`element`
Add custom IFC elements to your BIM project.
.. container:: card
:doc:`annotation`
Add various types of annotations to your model and drawings.
.. container:: card
:doc:`spatial`
Define and manage spatial structures within your BIM model.
.. container:: card
:doc:`structural`
Create and edit structural elements and relationships.
.. container:: card
:doc:`covering`
Add surface coverings to elements in your model.
Click on a tool to learn more about its features and how to use it effectively in your BIM workflow.
Using the Toolbar
=================
To use any of these tools, simply select the desired tool from the toolbar.
The options and parameters for each tool will appear in the toolbar options panel at the bottom of the toolbar.
Adjust these settings as needed before applying the tool in your 3D viewport.
Remember that many of these tools interact with the IFC data structure underlying your BIM model.
Always ensure you're working within the correct IFC context when using these tools.
.. toctree::
:hidden:
:maxdepth: 1
explore
wall
slab
door
window
column
beam
duct
element
annotation
spatial
structural
covering
@@ -0,0 +1,7 @@
.. _create-slab:
Create Slab
-----------
Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`6`
Use this tool to add floor or roof slabs to your model. You can define the thickness, span, and structural properties.
@@ -0,0 +1,7 @@
.. _spatial-tool:
Spatial Tool
------------
Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`Shift` + :kbd:`8`
This tool helps in defining and managing spatial structures within your BIM model, such as buildings, stories, and spaces.
@@ -0,0 +1,7 @@
.. _structural-tool:
Structural Tool
---------------
Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`Shift` + :kbd:`9`
Use this for creating and editing structural elements beyond basic beams, such as columns, trusses, and reinforcements.
+102
View File
@@ -0,0 +1,102 @@
Create Wall
===========
The Create Wall tool in Bonsai allows you to add and manipulate wall elements in your floor plan.
It provides options for specifying wall element properties and adjusting their alignment and orientation.
Toolbar Icon
------------
.. figure:: images/toolbar_create-wall.png
:alt: Create Wall tool icon in the Bonsai toolbar
Tool Options
------------
.. figure:: images/property-editor_create-wall.png
:alt: Create Wall tool options in the property editor
Shortcut
~~~~~~~~
To access the Create Wall tool, you can use the following keyboard shortcut sequence:
:kbd:`Shift` + :kbd:`Spacebar`, ???
Key Features
~~~~~~~~~~~~
Add Wall
^^^^^^^^
- **Shortcut**: :kbd:`Shift` + :kbd:`A`
- Adds a new wall segment at the 3D cursor location.
Add or Modify Wall
^^^^^^^^^^^^^^^^^^
- **Height**: Set the wall height.
- **Length**: Set the wall length.
- **X Angle**: Adjust the angle of the wall.
Modify Wall
^^^^^^^^^^^
- **Extend** (Shortcut: :kbd:`Shift` + :kbd:`E`): Extend an existing wall to another face.
- **Butt** (Shortcut: :kbd:`Shift` + :kbd:`T`): Join wall segments end-to-end.
- **Mitre** (Shortcut: :kbd:`Shift` + :kbd:`Y`): Create a mitre joint between two wall segments.
- **Merge** (Shortcut: :kbd:`Shift` + :kbd:`M`): Merge two wall segments into one.
- **Flip** (Shortcut: :kbd:`Shift` + :kbd:`F`): Flip the direction of the wall segment.
- **Split** (Shortcut: :kbd:`Shift` + :kbd:`K`): Split a wall segment into two parts.
- **Rotate 90** (Shortcut: :kbd:`Shift` + :kbd:`R`): Rotate the wall by 90 degrees.
- **Regen** (Shortcut: :kbd:`Shift` + :kbd:`G`): Regenerate the wall geometry.
- **Add Void** (Shortcut: :kbd:`Shift` + :kbd:`O`): Create an opening in the wall for doors, windows, or other elements.
Change walls alignment or move walls
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- **Align Exterior** (Shortcut: :kbd:`Shift` + :kbd:`X`): Align wall to the exterior face.
- **Align Centerline** (Shortcut: :kbd:`Shift` + :kbd:`C`): Align wall to the centerline.
- **Align Interior** (Shortcut: :kbd:`Shift` + :kbd:`V`): Align wall to the interior face.
- **Mirror** (Shortcut: :kbd:`Shift` + :kbd:`M`): Mirror wall.
Wall Mode
^^^^^^^^^
- **Void** (Shortcut: :kbd:`Alt` + :kbd:`O`): Create voids in the walls.
- **Decomposition** (Shortcut: :kbd:`Alt` + :kbd:`D`): Decompose wall elements.
Aggregation
^^^^^^^^^^^
- **Assign** (Shortcut: :kbd:`Ctrl` + :kbd:`P`): Assign wall elements to a specific group.
- **Unassign** (Shortcut: :kbd:`Alt` + :kbd:`P`): Remove wall elements from a group.
Calculate Quantities
^^^^^^^^^^^^^^^^^^^^
- **Calculate All Quantities** (Shortcut: :kbd:`Q`): Calculate all quantities related to the walls (e.g., area, volume).
Usage
~~~~~
To use the Create Wall tool:
1. **Activate the tool** from the toolbar or use the shortcut :kbd:`A`.
2. **Select the wall type** from the dropdown menu, or create a new wall type (which represents the wall thickness) and set other desired parameters.
3. **Set the 3D cursor** to the desired starting location for the wall by holding :kbd:`Shift` and left-clicking in the 3D viewport.
4. **Add the wall** by pressing :kbd:`Shift` + :kbd:`A`.
5. **Adjust the length** of the wall segment by dragging the "Length" parameter or entering a numeric value.
6. **Set the 3D cursor** to the new location for the next wall segment, enabling snapping to ensure the segments butt together properly.
7. **Add the next wall segment** by pressing :kbd:`Shift` + :kbd:`A` again.
8. **Rotate** the new wall segment if needed by pressing :kbd:`Shift` + :kbd:`R` and adjusting the angle.
9. **Adjust the length** of the new segment as required.
10. **Repeat steps 6-9**, setting the 3D cursor to the desired location, adding new wall segments, rotating, and adjusting lengths, until the complete wall perimeter is created.
11. **Modify wall segments** using the various shortcuts (e.g., extend, butt, mitre, merge, flip, split, rotate) as needed to refine the wall layout.
12. **Align and adjust** walls using the alignment options.
13. **Add voids** by clicking "Add Void" and placing openings where necessary.
14. **Calculate quantities** by pressing :kbd:`Q` to ensure accurate measurements.
The Create Wall tool in Bonsai enables precise and flexible wall creation and management,
enhancing your ability to develop detailed floor plans efficiently.
@@ -0,0 +1,8 @@
.. _create-window:
Create Window
-------------
Shortcut: :kbd:`Shift` + :kbd:`Spacebar`, :kbd:`8`
Similar to the door tool, this allows you to add windows to your walls. You can specify window types, sizes, and placement.
+44
View File
@@ -0,0 +1,44 @@
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.
New IFC Project
^^^^^^^^^^^^^^^
The New IFC Project submenu offers several options for creating a new IFC project:
.. figure:: images/file_new-ifc-project-submenu.png
:alt: New IFC Project submenu options
New IFC Project submenu options
- 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.
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.
BIM Workspace
-------------
Bonsai adds the **BIM** Workspace to the Topbar Workspaces tabs.
+26
View File
@@ -0,0 +1,26 @@
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