- VS 2015 or VS 2017 (Windows)
- Xcode 11.3.1 (macOS)
- GCC 7.4.0 (Linux)
- Qt 5.x (64-bit)
- HOOPS Visualize 20xx
- Sprocket compatible version of HOOPS Exchange 20xx
In order to proceed with any of the build options, you must first specify the locations of HOOPS Visualize and HOOPS Exchange.
- Copy
creeper/build/qmake/config-local.sample
tocreeper/build/qmake/config-local.pri
. - Edit
creeper/build/qmake/config-local.pri
and update the locations of the HOOPS Platform Toolkits to reflect your local folders.
Building creeper using the native Qt build tools is straightforward and similar on each platform. Differences for each platform are noted. Options also exist for Visual Studio and XCode.
- Launch QtCreator
- Choose Open Project and select
creeper/build/qmake/creeper.pro
. - Click "Configure Project" after making any desired changes in the window that appears.
- Click the "Build" button.
-
Open a command line window/terminal. Ensure prerequisite tools (Qt, compiler) are available in your
PATH
.- On Windows, ensure this is a Visual Studio 64-bit compiler command prompt. Execute
qtenv2.bat
to add Qt variables. To verify your command prompt is configured, runqmake.exe
, and you should see the command line usage printed. In addition, runcl.exe
, and you should see the command line usage printed. - On macOS and Linux, manually add the Qt
bin
folder to yourPATH
.
- On Windows, ensure this is a Visual Studio 64-bit compiler command prompt. Execute
-
Change directory to
creeper/build/qmake
. -
Generate the
Makefile
by executingqmake creeper.pro
. You should not see any errors or warnings. If you do, hopefully the messages are self-explanatory. -
Compile by executing
nmake
on Windows, ormake
on Linux and macOS. You should not see any warnings or errors. -
Verify the build product
viewer.exe
(Windows) orviewer
is present in thebin
folder.
- Follow steps 1 and 2 of Option 2 above.
- Generate the Visual Studio project file by executing
qmake -tp vc creeper.pro
. You should not see any errors or warnings. - Add the HOOPS Visualize DLL folders are in your
PATH
.- For example,
set PATH=%PATH%;C:\ts3d\HOOPS_Visualize_2020\bin\win64_v140d
.
- For example,
- Open the project by typing
devenv viewer.vcxproj
.
- Follow steps 1 and 2 of Option 2 above.
- Generate the Visual Studio project file by executing
qmake -spec macx-xcode creeper.pro
. You should not see any errors or warnings. - Open the project by typing
open viewer.xcodeproj
.
In order to run the application, it needs to locate the HOOPS Visualize and HOOPS Exchange dynamic libraries. HOOPS Visualize is a linktime dependency so its dynamic libraries are loaded as the executable is launched.
- [Windows] The
PATH
environment variable must contain thebin/<arch>
debug folder. - [macOS, Linux] The application is linked with an
rpath
specification. No additional runtime configuration is needed for Visualize.
The Exchange dynamic libraries are loaded using dlopen
or LoadLibraryEx
once the application starts. By default, the application will attempt to use the folder you specified for the build settings. You can override this location by using the command line option -x
.
These steps describe how to specify the required variables and arguments to run Creeper from within QtCreator.
- [Windows] Add the Visualize bin directory to the
PATH
environment variable.- Click on the
Projects
button in the vertical tool ribbon on the left of the window. - Click on the
Run
button located in theActive Project
,Build & Run
section of the main window that appears. - At the bottom of the
Run Settings
window, edit theRun Environment
. - Add the variable
PATH
and specify the Visualize debug DLL folder for your architecture.
- Click on the
- Build and Debug as normal.
- [Windows] Add the HOOPS Visualize DLL folders are in your
PATH
.- For example,
set PATH=%PATH%;C:\ts3d\HOOPS_Visualize_2020\bin\win64_v140d
.
- For example,
- Execute
bin/viewer.exe
(Windows),bin/viewer
(Linux), oropen bin/viewer.app
(macOS).
- If you followed the Build instructions correctly, you have already set your
PATH
environment variable. - Build and Debug as normal.
- As noted previously, macOS makes use of the
rpath
mechanism. No additional settings are required. - Build and Debug as normal.
In order to generate a build configuration for an optimized application without debugging information, you must re-reun qmake
with options to specify the release configuration.
- QtCreator is configured with options for Release builds automatically. Just use the selector to pick the configuration.
- Use the command
qmake "CONFIG += release" -after
.
- Use the command
qmake "CONFIG += release" -after -tp vc
.
- Use the command
qmake "CONFIG += release" -after -spec macx-xcode
.
- Examine the folder structure within
src
. It will be evident how to organize any files you may want to add. - Start by creating the files inside
src
folder. - Edit
build/qmake/src.pro
and add the base filename to the list. - Re-run
qmake
,qmake -tp vc
, orqmake -spec macx-xcode
to regenerateMakefile
or the workspace.