diff --git a/src/blenderbim/docs/users/blenderbim-layout.png b/src/blenderbim/docs/users/blenderbim-layout.png new file mode 100644 index 0000000000..574874d3cc Binary files /dev/null and b/src/blenderbim/docs/users/blenderbim-layout.png differ diff --git a/src/blenderbim/docs/users/example-project.png b/src/blenderbim/docs/users/example-project.png new file mode 100644 index 0000000000..4686b0a294 Binary files /dev/null and b/src/blenderbim/docs/users/example-project.png differ diff --git a/src/blenderbim/docs/users/exploring_an_ifc_model.rst b/src/blenderbim/docs/users/exploring_an_ifc_model.rst index e69de29bb2..fc3a4cfe3a 100644 --- a/src/blenderbim/docs/users/exploring_an_ifc_model.rst +++ b/src/blenderbim/docs/users/exploring_an_ifc_model.rst @@ -0,0 +1,81 @@ +Exploring an IFC model +====================== + +We're going to load an existing IFC model and explore some common properties +most users will be interested in. + +If you don't have an IFC model available, here's a small one for your +convenience provided by the Institute for Automation and Applied Informatics +(IAI) / Karlsruhe Institute of Technology. It's in German, so you may need to +use some creativity when reading the data. + +.. container:: blockbutton + + `Download sample IFC `__ + +.. seealso:: + + You can find more sample models online in the `OSArch Open Data Directory + `__ + +Loading a model +--------------- + +Blender's interface is divided into panels. The main **Viewport** panel shows 3D +geometry. The top right **Outliner** panel shows a tree of geometric objects. +The bottom right **Properties** panel shows data and relationships. + +.. image:: blenderbim-layout.png + +The **Properties** panel has tabs to switch between different types of +properties. Make sure you have the **Scene Properties** tab activated, and find +the **IFC Project** subpanel. Click on the **Load Project** and browse to your +``.ifc`` file. + +.. image:: properties-loadproject.png + +After loading, you will see the model appear in the **Viewport** panel. + +.. image:: example-project.png + +Let's take a look at the **IFC Project** subpanel again. It shows the loaded +filename, as well as the **IFC Schema**. There are two commonly seen **IFC +Schema** versions: IFC2X3 and IFC4. Checking the **IFC Schema** is important +because it has an impact on what BIM data may be stored. IFC4 is the newer +version and it is recommended to use IFC4 models as it has significantly more +BIM capabilities compared to IFC2X3. + +.. tip:: + + Blender's interface is highly customisable. Panels, panel types, colours, + sizes, and tabs may be edited to suit your workflow. + +Navigating a model in 3D +------------------------ + +TODO + +Overview of all objects +----------------------- + +TODO + +Viewing element classes +----------------------- + +TODO + +Viewing attributes and properties +--------------------------------- + +TODO + +Viewing construction types +-------------------------- + +TODO + +Viewing materials +----------------- + +TODO diff --git a/src/blenderbim/docs/users/installation.rst b/src/blenderbim/docs/users/installation.rst index bf6b050118..26a64468a8 100644 --- a/src/blenderbim/docs/users/installation.rst +++ b/src/blenderbim/docs/users/installation.rst @@ -10,7 +10,7 @@ Installation `Download Blender `__ -.. note:: +.. tip:: No administrator rights on Windows? Choose the "Portable .zip" option when downloading from the Blender website. @@ -23,7 +23,7 @@ Installation `Download BlenderBIM Add-on `__ -.. caution:: +.. warning:: If you are not using Blender version >=3.1, please follow the **Unstable installation** instructions. :doc:`Read more <../devs/installation>` @@ -38,7 +38,7 @@ Installation .. image:: install-blenderbim-2.png - .. caution:: + .. warning:: You do not need to unzip the add-on file. You should install it as a zipped file. @@ -103,7 +103,7 @@ button in the Blender preferences window. Alternatively, you may uninstall manually by deleting the ``blenderbim/`` directory in your Blender add-ons directory. -.. caution:: +.. warning:: It is important to follow the sequence of disabling, restarting, then removing. If you do not restart Blender, the add-on will fail to remove correctly, and you diff --git a/src/blenderbim/docs/users/introduction_to_bim.rst b/src/blenderbim/docs/users/introduction_to_bim.rst index 0ffea5938f..0b5e6fa0a6 100644 --- a/src/blenderbim/docs/users/introduction_to_bim.rst +++ b/src/blenderbim/docs/users/introduction_to_bim.rst @@ -12,9 +12,9 @@ described are: - **Actors**, like occupants, clients, architects, and liable parties - **Groups**, like systems, inventories, or zones -These objects may have lots of data and relationships. The data might be a -classification system, physical material, associated documents, simulation -results, construction types, or location. The data may be relevant to multiple +These objects may have lots of data and relationships. Examples of data might be +classification systems, physical materials, associated documents, simulation +results, and construction types. The data may be relevant to multiple disciplines, such a architecture, engineering, and construction. .. note:: @@ -26,7 +26,7 @@ disciplines, such a architecture, engineering, and construction. **Industry Foundation Classes**, or **IFC**, is an international standard for **BIM**. **IFC** is the most well-established open digital language for our built environment. Most software will be able to describe their **BIM** data -using **IFC**. +using **IFC**. Most commonly, **IFC** models will be shared as a ``.ifc`` file. For example, **IFC** will define a wall as an object that can have a name, construction type, and quantities. **IFC** will also describe that a wall that diff --git a/src/blenderbim/docs/users/properties-loadproject.png b/src/blenderbim/docs/users/properties-loadproject.png new file mode 100644 index 0000000000..8c38af054f Binary files /dev/null and b/src/blenderbim/docs/users/properties-loadproject.png differ