Skip to content

A C++ library providing 3D Repo Scene Graph definition, repository management logic and manipulation logic. It is is essentially the refactored 3DRepoCore and (parts of) 3DRepoGUI

License

hyhylee/3drepobouncer

 
 

Repository files navigation

3drepobouncer Build Status Coverage Status

3DRepoBouncer is essentially the refactored 3DRepoCore and (parts of) 3DRepoGUI. It is a C++ library providing 3D Repo Scene Graph definition, repository management and manipulation logic as well as direct MongoDB databse access.

Licenses

This project is Copyright of 3D Repo Ltd, a company registered in England and Wales No. 09014101, and is released under the open source GNU Affero General Public License v3. Should you require a commercial license, please contact support@3drepo.org. All contributors are required to sign either the 3D Repo Individual or the 3D Repo Entity Contributor License Agreement (CLA).

Contributing

We very much encourage contributions to the 3D Repo project. Firstly, fork the desired repository and commit your modifications there. Once happy with the changes, you can generate a pull request and our team will integrate it upstream after a review.

Your pull requests should:

  1. Follow the style of the existing code
  2. One commit should just do one thing, and one thing only
  3. Work in a branch assigned to a specific issue number, e.g. branch called "ISSUE_138"
  4. Each commit message should be prefixed with the issue number, e.g. "#138 Fixing bug xyz..."
  5. Rebase your branch against upstream's master so that we don't pull redundant commits
  6. Sign our 3D Repo Individual CLA or if you are representing a legal entity, sign the 3D Repo Entity CLA

Dependencies

3DRepoBouncer relies on the following libraries:

To compile and install the library, the following are used:

Compilation (Qt)

See instructions at 3drepo#9 (comment)

Compilation (Windows)

Ensure Mongo CXX Driver, Boost and ASSIMP libraries are installed.

The following instruction is for compiling a 64bit library using Visual Studio 12's tools. Change the pathing/cmake option appropriately if you are using another version of Visual Studio or compiling with a different compiler.

In command line prompt: set the following environmental variables to the directories of your installations:

  • $env:BOOST_ROOT = path_to_boost
  • $env:BOOST_LIBRARYDIR = path_to_boost_libraries (i.e path_to_boost\lib64-msvc-12.0) (NOT REQUIRED if libraries are in $BOOST_ROOT/lib)
  • $env:MONGO_ROOT = path_to_mongo_cxx_driver
  • $env:ASSIMP_ROOT = path_to_assimp
  1. Clone the repository: git clone https://github.com/3drepo/3drepobouncer.git
  2. Change directory: cd 3drepobouncer
  3. Update CMake files: python updateSources.py
  4. Create off-source build directory: mkdir build
  5. Change directory: cd build
  6. Configure build with CMAKE: cmake -G "Visual Studio 12 Win64" ../
  7. Build the library: msbuild 3drepobouncer.vcxproj

Compilation (Linux)

Ensure Mongo CXX Driver, Boost and ASSIMP libraries are installed.

If the libraries are not installed in /usr, /usr/local, /opt/local, set the following environmental variables:

  • export BOOST_ROOT = path_to_boost
  • export MONGO_ROOT = path_to_mongo_cxx_driver
  • export ASSIMP_ROOT = path_to_assimp
  1. Clone the repository: git clone https://github.com/3drepo/3drepobouncer.git
  2. Change directory: cd 3drepobouncer
  3. Update CMake files: python updateSources.py
  4. Create off-source build directory: mkdir build
  5. Change directory: cd build
  6. Configure build with CMAKE: cmake ../
  7. Build the library: make

Recompiling with changes

Apart from the CMakeLists.txt at root level, every other cmake file is automatically generated. If you have moved/created any source/header files, please run python updateSources.py to update the CMakeLists.txt files within the subdirectories before compiling.

Do NOT modify any CMakeLists.txt files within src folder as any changes will be overwritten when updateSources.py is executed!

Contact

If you need any help or want to contribute please contact: support@3drepo.org We look forward to hearing from you.

About

A C++ library providing 3D Repo Scene Graph definition, repository management logic and manipulation logic. It is is essentially the refactored 3DRepoCore and (parts of) 3DRepoGUI

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C++ 96.2%
  • CMake 2.6%
  • Other 1.2%