mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-05 23:41:44 +00:00
Doc tweaks [ci skip]
This commit is contained in:
Stinkfist0
committed by
Thomas Krijnen
Thomas Krijnen
parent
b058647d46
commit
06c1ea9d2c
@@ -13,14 +13,14 @@ Prerequisites
|
||||
-------------
|
||||
* Git
|
||||
* CMake (2.6 or newer)
|
||||
* Windows: [Visual Studio] 2008 or newer with C++ toolset (or [Visual C++ Build Tools]) or [MSYS2] + MinGW
|
||||
* Windows: [Visual Studio] 2008 or newer (2017 not yet officially supported) with C++ toolset (or [Visual C++ Build Tools]) or [MSYS2] + MinGW
|
||||
* *nix: GCC 4.7 or newer, or Clang (any version)
|
||||
|
||||
Dependencies
|
||||
-------------
|
||||
* [Boost](http://www.boost.org/)
|
||||
* Open Cascade - *optional*, but required for building IfcGeom
|
||||
([official](http://www.opencascade.org/getocc/download/loadocc/) or [community edition](https://github.com/tpaviot/oce))
|
||||
* [Open Cascade](http://opencascade.org) - *optional*, but required for building IfcGeom
|
||||
([official](http://www.opencascade.org/getocc/download/loadocc/), "OCCT", or [community edition](https://github.com/tpaviot/oce), "OCE")
|
||||
For converting IFC representation items into BRep solids and tesselated meshes
|
||||
* [ICU](http://site.icu-project.org/) - *optional*
|
||||
For handling code pages and Unicode in the parser
|
||||
@@ -58,6 +58,7 @@ Only) to deploy the headers and binaries into a single location if wanted/needed
|
||||
|
||||
Alternatively, one can use the utility batch file(s) to build and install the project easily from the command-line
|
||||
(installing a project will build it also, if required):
|
||||
|
||||
> install-ifcopenshell.bat
|
||||
|
||||
#### Using MSYS2 + MinGW
|
||||
@@ -84,12 +85,11 @@ meant to be used for a typical IfcOpenShell workspace setup.
|
||||
|
||||
$ sudo apt-get install git cmake gcc g++ libboost-all-dev libicu-dev
|
||||
|
||||
**2a)** Either use an Open CASCADE package from your operating system's software repository (see http://opencascade.org
|
||||
for additional information)
|
||||
**2a)** Either use an OCE package from your operating system's software repository
|
||||
|
||||
$ sudo apt-get install liboce-foundation-dev liboce-modeling-dev liboce-ocaf-dev liboce-visualization-dev liboce-ocaf-lite-dev
|
||||
|
||||
**2b)** or (if not available, or the latest code is wanted) compile Open CASCADE yourself (note that the build takes a long time):
|
||||
**2b)** or (if not available, or the latest code is wanted) compile OCE yourself (note that the build takes a long time):
|
||||
|
||||
$ sudo apt-get install libftgl-dev libtbb2 libtbb-dev libgl1-mesa-dev libfreetype6-dev
|
||||
$ git clone https://github.com/tpaviot/oce.git
|
||||
@@ -99,6 +99,8 @@ for additional information)
|
||||
$ make -j
|
||||
$ sudo make install
|
||||
|
||||
**2c)** or obtain and compile OCCT from http://www.opencascade.org/getocc/download/loadocc/
|
||||
|
||||
**3)** For building IfcConvert with COLLADA (.dae) support (on by default), OpenCOLLADA is needed:
|
||||
|
||||
$ sudo apt-get install libpcre3-dev
|
||||
|
||||
@@ -338,6 +338,7 @@ void ColladaSerializer::ColladaExporter::endDocument() {
|
||||
geometries.close();
|
||||
for (std::vector<DeferredObject>::const_iterator it = deferreds.begin(); it != deferreds.end(); ++it) {
|
||||
const std::string object_name = it->unique_id;
|
||||
/// @todo redundant information using ID as both ID and Name, maybe omit Name or allow specifying what would be used as the name
|
||||
scene.add(object_name, object_name, it->representation_id, it->material_references, it->matrix);
|
||||
}
|
||||
scene.write();
|
||||
|
||||
@@ -115,6 +115,7 @@ bool rename_file(const std::string& old_filename, const std::string& new_filenam
|
||||
static std::stringstream log_stream;
|
||||
void write_log();
|
||||
|
||||
/// @todo make the filters non-global
|
||||
IfcGeom::entity_filter entity_filter; // Entity filter is used always by default.
|
||||
IfcGeom::layer_filter layer_filter;
|
||||
const std::string NAME_ARG = "Name", GUID_ARG = "GlobalId", DESC_ARG = "Description", TAG_ARG = "Tag";
|
||||
|
||||
+15
-15
@@ -1,30 +1,30 @@
|
||||
Windows Build Tools and Scripts
|
||||
===============================
|
||||
This folder contains build tools and script for automatic building and deployment of IfcOpenShell (IFCOS)
|
||||
This folder contains build tools and script for automatic building and deployment of IfcOpenShell ("IFCOS")
|
||||
and its dependencies.
|
||||
|
||||
As a general guideline, `.cmd` files are non-standalone batch files that need to be run from command prompt or from
|
||||
another batch file, and/or while the Visual Studio environment variables set, and `.bat` files are standalone batch
|
||||
files that can also be invoked e.g. by double-clicking in the File Explorer. `.sh` files are for MSYS2 + MinGW ("MSYS"
|
||||
hereafter) compilation.
|
||||
another batch file, and/or while the Visual Studio ("MSVC") environment variables set, and `.bat` files are standalone batch
|
||||
files that can also be invoked e.g. by double-clicking in the File Explorer. `.sh` files are for MSYS**2** + MinGW ("MSYS"
|
||||
) compilation.
|
||||
|
||||
Usage Instructions
|
||||
------------------
|
||||
### MSYS2 + MinGW
|
||||
### MSYS
|
||||
|
||||
Building using MSYS is very similar to using the Visual Studio batch files, but instead the shell scripts
|
||||
Building using MSYS is very similar to using the MSVC batch files, but instead the shell scripts
|
||||
are used. Note that the MSYS support is currently a bit experimental. It is advised to check out the contents
|
||||
of the shell scripts before using them. Note that contrary to Visual Studio, with MinGW all of the dependencies are not
|
||||
of the shell scripts before using them. Note that contrary to MSVC, with MSYS all of the dependencies are not
|
||||
built or used as static libaries. Currently Release build is used for all libraries.
|
||||
|
||||
### Visual Studio
|
||||
### MSVC
|
||||
Execute `build-deps.cmd` to fetch, build and install the dependencies. The batch file will print the requirements for
|
||||
a successful execution. The script allows a few user-configurable build options which are listed in the usage
|
||||
instructions. Either edit the script file or set these values before running the script.
|
||||
|
||||
`build-deps.cmd` expects a CMake generator as `%1` and a build configuration type (`RelWithDebInfo`, `Release`,
|
||||
`MinSizeRel`, or `Debug`, defaults to `RelWithDebInfo`) as `%2`. If the generator is not provided, the generator is
|
||||
deduced from the Visual Studio environment variables. User-friendly VS generator shorthands are supported, e.g.
|
||||
deduced from the MSVC environment variables. User-friendly VS generator shorthands are supported, e.g.
|
||||
`vs2013-x86` or `vs2015-x64`, and these are converted to the appropriate CMake ones by the scripts. A build type
|
||||
(`Build`, `Rebuild`, or `Clean`, defaults to `Build`) can be provided as `%3`. See `vs-cfg.cmd` if you wish to change
|
||||
the defaults. The batch file will create `deps\` and `deps-vs<VERSION>-<ARCHITECTURE>-installed\` directories to the
|
||||
@@ -44,7 +44,7 @@ the generator must be always passed as the first option:
|
||||
|
||||
**If you wish to use any library from a custom location, modify the paths in `run-cmake.bat` accordingly**. The batch
|
||||
script will create a folder of form `build-vs<VERSION>-<ARCHITECTURE>\` which will contain the solution and project
|
||||
files for Visual Studio.
|
||||
files for MSVC.
|
||||
|
||||
Note that building IfcOpenShell as 64-bit is recommended as many of real life IFC files has been observed to take
|
||||
easily more than 2 GBs of RAM while converting.
|
||||
@@ -103,16 +103,16 @@ Directory Structure
|
||||
+---installed-* - Created by installing the IFCOS project, specific for a certain compiler and target architecture
|
||||
\---win
|
||||
| build-all.cmd - Runs all of the build scripts for IFCOS and it dependencies in a row without pauses
|
||||
| build-deps.cmd - Fetches and builds all needed dependencies for IFCOS using Visual Studio
|
||||
| build-deps.cmd - Fetches and builds all needed dependencies for IFCOS using MSVC
|
||||
| build-deps.sh - Fetches and builds all needed dependencies for IFCOS using MSYS
|
||||
| BuildDepsCache-<ARCH>.txt - Cache file created by build-deps.cmd
|
||||
| build-ifcopenshell.bat - Builds IFCOS using Visual Studio
|
||||
| build-ifcopenshell.bat - Builds IFCOS using MSVC
|
||||
| build-ifcopenshell.sh - Builds IFCOS using MSYS
|
||||
| build-type-cfg.cmd - Utility file used by the build scripts
|
||||
| install-ifcopenshell.bat - Installs/deployes IFCOS using Visual Studio.
|
||||
| install-ifcopenshell.sh - Installs/deployes IFCOS using MSYS.
|
||||
| install-ifcopenshell.bat - Installs/deploys IFCOS using MSVC.
|
||||
| install-ifcopenshell.sh - Installs/deploys IFCOS using MSYS.
|
||||
| readme.md - This file
|
||||
| run-cmake.bat - Sets environment variables for the dependencies and runs CMake for IFCOS using Visual Studio
|
||||
| run-cmake.bat - Sets environment variables for the dependencies and runs CMake for IFCOS using MSVC
|
||||
| run-cmake.sh - Sets environment variables for the dependencies and runs CMake for IFCOS using MSYS
|
||||
| set-python-to-path.bat - Utility for setting PYTHONHOME (read from BuildDepsCache-<ARCH>.txt) to PATH
|
||||
| vs-cfg.cmd - Utility file used by the build scripts
|
||||
|
||||
Reference in New Issue
Block a user