diff --git a/src/blenderbim/docs/_static/custom.css b/src/blenderbim/docs/_static/custom.css index 4ecfae2065..fd4ba76635 100644 --- a/src/blenderbim/docs/_static/custom.css +++ b/src/blenderbim/docs/_static/custom.css @@ -15,3 +15,28 @@ section img { box-shadow: rgba(0, 0, 0, 0.24) 0px 3px 8px; border-radius: 5px; } +.location-scene img { + display: inline; + border-radius: 0px; + box-shadow: none; + vertical-align: middle; + margin-top: -3px; +} +.location-scene p { + margin: 0.75rem; +} +.location-scene { + border: 1px solid var(--color-admonition-title); + background-color: var(--color-admonition-title-background); + border-radius: 5px; + font-style: italic; + color: var(--color-admonition-title); +} +img.icon { + width: auto; + height: auto; + border-radius: 0px; + box-shadow: none; + vertical-align: middle; + vertical-align: middle; +} diff --git a/src/blenderbim/docs/images/icon-EXPORT.svg b/src/blenderbim/docs/images/icon-EXPORT.svg new file mode 100644 index 0000000000..abe7386074 --- /dev/null +++ b/src/blenderbim/docs/images/icon-EXPORT.svg @@ -0,0 +1,87 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + diff --git a/src/blenderbim/docs/images/icon-FILE.svg b/src/blenderbim/docs/images/icon-FILE.svg new file mode 100644 index 0000000000..e548995553 --- /dev/null +++ b/src/blenderbim/docs/images/icon-FILE.svg @@ -0,0 +1,81 @@ + + + + + + image/svg+xml + + + + + + + + + + + + diff --git a/src/blenderbim/docs/images/icon-FILE_CACHE.svg b/src/blenderbim/docs/images/icon-FILE_CACHE.svg new file mode 100644 index 0000000000..97840119dc --- /dev/null +++ b/src/blenderbim/docs/images/icon-FILE_CACHE.svg @@ -0,0 +1,101 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + diff --git a/src/blenderbim/docs/images/icon-FILE_HIDDEN.svg b/src/blenderbim/docs/images/icon-FILE_HIDDEN.svg new file mode 100644 index 0000000000..68ac1ab108 --- /dev/null +++ b/src/blenderbim/docs/images/icon-FILE_HIDDEN.svg @@ -0,0 +1,85 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + diff --git a/src/blenderbim/docs/images/icon-FILE_TICK.svg b/src/blenderbim/docs/images/icon-FILE_TICK.svg new file mode 100644 index 0000000000..5f354ff976 --- /dev/null +++ b/src/blenderbim/docs/images/icon-FILE_TICK.svg @@ -0,0 +1,77 @@ + + + + + + image/svg+xml + + + + + + + + + + + + diff --git a/src/blenderbim/docs/images/icon-GREASEPENCIL.svg b/src/blenderbim/docs/images/icon-GREASEPENCIL.svg new file mode 100644 index 0000000000..afda5f78a1 --- /dev/null +++ b/src/blenderbim/docs/images/icon-GREASEPENCIL.svg @@ -0,0 +1,81 @@ + + + + + + image/svg+xml + + + + + + + + + + + + diff --git a/src/blenderbim/docs/images/location-breadcrumb.svg b/src/blenderbim/docs/images/location-breadcrumb.svg new file mode 100644 index 0000000000..14d00579d9 --- /dev/null +++ b/src/blenderbim/docs/images/location-breadcrumb.svg @@ -0,0 +1,76 @@ + + + + + + image/svg+xml + + + + + + + + + + + + diff --git a/src/blenderbim/docs/images/location-scene.svg b/src/blenderbim/docs/images/location-scene.svg new file mode 100644 index 0000000000..bf5a7c8cd7 --- /dev/null +++ b/src/blenderbim/docs/images/location-scene.svg @@ -0,0 +1,78 @@ + + + + + + image/svg+xml + + + + + + + + + + + + diff --git a/src/blenderbim/docs/index.rst b/src/blenderbim/docs/index.rst index b9917decf4..3fe4940c45 100644 --- a/src/blenderbim/docs/index.rst +++ b/src/blenderbim/docs/index.rst @@ -19,6 +19,7 @@ The BlenderBIM Add-on lets you analyse, create, and modify OpenBIM with Blender. users/georeferencing users/dealing_with_large_models users/other_addons + users/general_usage .. toctree:: :hidden: diff --git a/src/blenderbim/docs/users/general_usage.rst b/src/blenderbim/docs/users/general_usage.rst new file mode 100644 index 0000000000..1d61093de8 --- /dev/null +++ b/src/blenderbim/docs/users/general_usage.rst @@ -0,0 +1,12 @@ +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/ifc_project diff --git a/src/blenderbim/docs/users/general_usage/ifc_project.rst b/src/blenderbim/docs/users/general_usage/ifc_project.rst new file mode 100644 index 0000000000..5d8dbc2200 --- /dev/null +++ b/src/blenderbim/docs/users/general_usage/ifc_project.rst @@ -0,0 +1,123 @@ +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 Library 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 +------------- + +.. 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 diff --git a/src/blenderbim/docs/users/general_usage/images/ifc-project-create.png b/src/blenderbim/docs/users/general_usage/images/ifc-project-create.png new file mode 100644 index 0000000000..b061050073 Binary files /dev/null and b/src/blenderbim/docs/users/general_usage/images/ifc-project-create.png differ diff --git a/src/blenderbim/docs/users/general_usage/images/ifc-project-load.png b/src/blenderbim/docs/users/general_usage/images/ifc-project-load.png new file mode 100644 index 0000000000..61d3eb4157 Binary files /dev/null and b/src/blenderbim/docs/users/general_usage/images/ifc-project-load.png differ diff --git a/src/blenderbim/docs/users/general_usage/images/ifc-project.png b/src/blenderbim/docs/users/general_usage/images/ifc-project.png new file mode 100644 index 0000000000..9b417aca27 Binary files /dev/null and b/src/blenderbim/docs/users/general_usage/images/ifc-project.png differ