Skip to content

Latest commit

 

History

History
164 lines (117 loc) · 6.45 KB

build_guide.md

File metadata and controls

164 lines (117 loc) · 6.45 KB
Raw

Build Guide

Build pass on:

  • Windows 10 x64 + VS2015 + Qt 5.11.1 + osgEarth 2.10 + osg 3.6.1
  • Ubuntu 16.04 x64 + g++ 5 + Qt 5.11.0 + osgEarth 2.9 + osg 3.6.0
  • Fedora 28 + Qt 5 + osgEarth 2.9 + osg 3.4

Dependency list (indirect or redundant dependencies not listed):

  • gdal
  • libjpeg
  • libpng
  • libtiff
  • libgeotiff
  • giflib
  • freetype
  • optional: geos
  • optional: sqlite3
  • optional: openvr
  • optional: ffmpeg
  • optional: liblas (requiring boost)
  • optional: python3-gdal
  • optional: FBX (it required 1GB of space to install)

Linux

Dependencies

At lease, you should meet these requirements:

  • g++ 5+
  • cmake-gui 3.4+
  • Qt 5.6+
  • OpenSceneGraph 3.4+
  • osgQt
  • osgEarth 2.9+ (better build by yourself)

If you want full functionalities, build OpenSceneGraph and osgEarth by yourself using all the dependencies in the previous section.

Build

git clone https://github.com/tqjxlm/Atlas.git
cd Atlas

mkdir build
cd build

cmake-gui ../ #Select Plugins
make

The default runtime directory is build/dist

Windows

Choose your way

You can install our recommended environment and use the dev pack to quick start.

Or you can prepare dependencies by yourself.

Prepare dependencies using dev pack

Prebuilt pack with full plugins (only for VS2015 + Win10 + Qt5.11.x_x64):

Extract them to separate dirs, and add them as OSG_ROOT and THIRD_PARTY_DIR to system environment variables, respectively.

Then you can jump to Build Atlas directly.

Prepare dependencies by yourself

If your want to prepare by yourself or to use a different version of MSVC, read on. The whole process will cost half to a whole day, depending on your hardware and your familiarity of the tools.

Important: No matter how you prepare the dependencies, please export the final libs to a separate folder, and add it as THIRD_PARTY_DIR to system environment variables. It is ugly but it is the only way, until we finish CMake integration for Windows.

When a dependency is missing

For any missing package, use vcpkg to compile them from source. Remember to compile the x64 version. For example

.\vcpkg install gdal:x64-windows

After packages are installed, you can find them at VCPKG_ROOT\installed\x64-windows. copy the /bin /include /lib dirs to [THIRD_PARTY_DIR]

Build OSG

  1. Get OpenSceneGraph source code, extract it to an arbitrary folder (referred to as OSG_SRC in the following)
  2. Open CMake, choose the source position as [OSG_SRC], and the build position as [OSG_SRC]/build
  3. Choose Grouped and Advanced, click Configure, choose Visual Studio 2015 x64, confirm
  4. Search and set ACTUAL_3RDPARTY_DIR as [THIRD_PARTY_DIR]
  5. Click Configure again
  6. For every "Could Not find" warning, check if the missing lib is required. If so, go to the corresponding section in CMake and specify it manually, or install it if you haven't. (Don't mind those "Debug version not found" warnings. Don't mind when the lib is not listed in the previous section)
  7. If you have any other need of dependency, just get them by yourself and specify the path in CMake
  8. Configure until not error is shown (leave alone warnings)
  9. Optional: search and choose WIN32_USE_MP, BUILD_OSG_EXAMPLES
  10. Search and set CMAKE_INSTALL_PREFIX as your target library path. It should be seperated from [OSG_SRC]
  11. Configure & Generate. Open the generated solution (OpenSceneGraph.sln)
  12. Build ALL_BUILD and INSTALL projects for both Debug and Release
  13. Add the output directory as OSG_ROOT in your system environment variables

Build OSGQt

  1. Download OSGQt source code, choose the newest release even though it is named "Qt4"
  2. Open CMake, set source dir as the OSGQt extracted folder, set build dir as /build folder under OSGQt (it may not exist), click Configure
  3. Set OSG_INCLUDE_DIR to [OSG_ROOT]/include. click Configure
  4. Set QT5_DIR to [QT_DIR]/msvc2015_64/lib/cmake/Qt5. click Configure
  5. Set CMAKE_INSTALL_PREFIX to [OSG_ROOT]. Set EXECUTABLE_OUTPUT_PATH to [OSG_ROOT]/bin. Set LIBRARY_OUTPUT_PATH to [OSG_ROOT]/lib
  6. Configure & Generate. Open the generated solution (OSGQt.sln)
  7. Remove optimized.lib and debug.lib from the link input of the Release version project OsgQt
  8. Build ALL_BUILD and INSTALL projects for Debug ad Release

Build osgEarth

  1. Download osgEarth source code. Extract. And use CMake to configure it just as the previous sections
  2. Set OSG_DIR to [OSG_ROOT]
  3. Set THIRD_PARTY_DIR to [THIRD_PARTY_DIR]
  4. Configure. And set other dependencies that are not detected automatically. The missing ones are:
    • OsgQt
    • GDAL
    • zlib
    • sqlite3
    • geos
  5. Choose INSTALL_TO_OSG_DIR, OSGEARTH_QT_BUILD. You may have to specify some Qt directories (found in [QTDIR]/msvc2015_64/lib/cmake)
  6. Set CMAKE_INSTALL_PREFIX to OSG_ROOT
  7. Optional: choose WIN32_USE_MP, BUILD_OSGEARTH_EXAMPLES
  8. Configure & Generate. Open generated solution
  9. Build ALL_BUILD and INSTALL projects for Debug and Release

Build atlas

  1. Clone this project
  2. Make sure you have added OSG_ROOT and THIRD_PARTY_DIR to system environment variables
  3. Open [ProjectRoot]/Atlas.sln
  4. Build ALL_BUILD project, or simply build the solution

Run program

Debug

  1. Open Atlas project properties
  2. Add $(OSG_ROOT)\bin and $(THIRD_PARTY_DIR)\bin to Debugging -> Environment
  3. Press F5 to start debugging

Deploy

In cmd, run

[ProjectRoot]/deploy.bat [output dir] [release dir] [qt dir]

For example:

.\deploy.bat .\deploy .\x64\Release C:\Qt\Qt5.11.1\5.11.1\msvc2015_64

If you have any dependency problem that shows up after deployment (or running Release build), try to find out which dll is missing, and add it to deploy.bat. The batch is quite self-explaining. You can use depends.exe to help.