Merge branch 'GUI' into 'master'

Merge of the GUI branch

See merge request !102

.gitignore

@@ -44,3 +44,7 @@ CMakeLists.txt.user*
 
 # Documentation files generated by Doxygen
 /html
+
+# UMANS simulation output
+/output
+/screenshots
\ No newline at end of file

CMakeLists.txt

@@ -18,21 +18,24 @@
 # Website: https://project.inria.fr/crowdscience/
 # See the file AUTHORS.md for a list of all contributors.
 
-cmake_minimum_required( VERSION 2.8 )
+cmake_minimum_required( VERSION 3.10 )
 project( UMANS )
 set (CMAKE_CXX_STANDARD 17)
 
 #set(EXECUTABLE_OUTPUT_PATH bin/${CMAKE_BUILD_TYPE})
 
-# === Include 3rd-party code
+file( GLOB_RECURSE src_All src/*)
+file( GLOB_RECURSE src_Engine src/Engine/* src/3rd-party/* )
+file( GLOB_RECURSE src_Library src/Library/* )
+file( GLOB_RECURSE src_ConsoleApplication src/ConsoleApplication/* )
+file( GLOB_RECURSE src_GUI src/GUI/* )
 
-include_directories( ./include )
-include_directories(./3rd-party/tinyxml/ ./3rd-party/nanoflann/ ./3rd-party/ORCA/)
+# --- ensure that certain directories are recognized in "#include <...>" lines
+include_directories( ./src/ ./src/Engine/ )
 
-#link_directories( ./lib/${CMAKE_BUILD_TYPE} )
+# === Include the GUI application (which requires Qt)?
 
-file( GLOB_RECURSE source_files src/* include/*)
-file( GLOB_RECURSE 3rd_party 3rd-party/*)
+option(UMANS_USE_GUI_APPLICATION "Include a GUI demo application (which relies on Qt)" ON)
 
 # === Use multithreading?
 
@@ -53,31 +56,66 @@ endif()
 
 # === Engine project: a static library that performs the simulation
 
-add_library(Engine STATIC ${source_files} ${3rd_party})
+add_library(Engine STATIC ${src_Engine})
 
 # === Console application
 
 if (WIN32)
-	add_executable(UMANS_ConsoleApplication_Windows main.cpp)
-	target_link_libraries(UMANS_ConsoleApplication_Windows Engine)
+	add_executable(UMANS-ConsoleApplication-Windows ${src_ConsoleApplication})
+	target_link_libraries(UMANS-ConsoleApplication-Windows Engine)
 else()
-	add_executable(UMANS_ConsoleApplication_Linux main.cpp)
-	target_link_libraries(UMANS_ConsoleApplication_Linux Engine)
+	add_executable(UMANS-ConsoleApplication-Linux  ${src_ConsoleApplication})
+	target_link_libraries(UMANS-ConsoleApplication-Linux Engine)
 endif()
 
 # === Dynamic library (e.g. a DLL on Windows) to include into other programs
 
-add_library(UMANS_Library SHARED "APIFunctions.h" "APIFunctions.cpp")
-target_link_libraries(UMANS_Library Engine)
+add_library(UMANS-Library SHARED ${src_Library})
+target_link_libraries(UMANS-Library Engine)
+
+# === Qt demo project (if enabled)
+
+if (UMANS_USE_GUI_APPLICATION)
+
+	# necessary: gives the path to GUI src files to qt autogen files
+	include_directories( ./src/GUI/ )
+
+	# set autogen variables for qt
+	set(CMAKE_INCLUDE_CURRENT_DIR ON)
+	set(CMAKE_AUTOUIC ON)
+	set(CMAKE_AUTOMOC ON)
+	set(CMAKE_AUTORCC ON)
+	
+	# find relevant packages
+	find_package(Qt5Core REQUIRED)
+	find_package(Qt5Widgets REQUIRED)
+	find_package(OpenGL REQUIRED)
+
+	# --- include the Qt resources, so that the application icon gets shown
+	set(UI_RESOURCES src/GUI/UMANSQtGuiApplication.qrc)
+	qt5_add_resources(UI_RESOURCES_RCC ${UI_RESOURCES})
+	
+	# --- define the project itself
+	add_executable(UMANS-GUI src/GUI/main.cpp ${src_GUI} ${UI_RESOURCES_RCC} ${UI_HEADERS})
+
+	# --- the project depends on some libraries
+	target_link_libraries(UMANS-GUI Engine Qt5::Core Qt5::Widgets ${OPENGL_LIBRARIES})
+
+	# --- post-build command: copy the required Qt DLLs, to prevent runtime errors
+	add_custom_command(TARGET UMANS-GUI POST_BUILD
+		COMMAND ${CMAKE_COMMAND} -E copy_if_different $<TARGET_FILE:Qt5::Core> $<TARGET_FILE_DIR:UMANS-GUI>
+		COMMAND ${CMAKE_COMMAND} -E copy_if_different $<TARGET_FILE:Qt5::Gui> $<TARGET_FILE_DIR:UMANS-GUI>
+		COMMAND ${CMAKE_COMMAND} -E copy_if_different $<TARGET_FILE:Qt5::Widgets> $<TARGET_FILE_DIR:UMANS-GUI>
+		)
+
+endif (UMANS_USE_GUI_APPLICATION)
 
 # === Clean up the project's directory structure
 
-foreach(_source IN ITEMS ${source_files})
+foreach(_source IN ITEMS ${src_All})
     get_filename_component(_source_path "${_source}" PATH)
-    file(RELATIVE_PATH _source_path_rel "${CMAKE_CURRENT_SOURCE_DIR}" "${_source_path}")
-	string(REPLACE "include/" "" _source_path_rel ${_source_path_rel})
-	string(REPLACE "src/" "" _source_path_rel ${_source_path_rel})
+    file(RELATIVE_PATH _source_path_rel "${CMAKE_CURRENT_SOURCE_DIR}/src/" "${_source_path}")
     string(REPLACE "/" "\\" _group_path "${_source_path_rel}")
     source_group("${_group_path}" FILES "${_source}")
 endforeach()
-source_group("3rd-party" FILES ${3rd_party})
+

README.md

@@ -36,27 +36,35 @@ Please cite this publication when referring to UMANS in your work.
 To start using UMANS, perform the following steps:
 
 1. Clone or download the code from [our GitLab repository](https://gitlab.inria.fr/OCSR/UMANS/).
-2. Download and install [CMake](https://cmake.org/).
+2. Download and install [Qt](https://www.qt.io/) (optional) and [CMake](https://cmake.org/) (required).
+(Qt is only needed if you want to compile the *UMANS-GUI* application.)
 3. Use CMake to turn the codebase into a programming project for your IDE/compiler of choice. 
+(You can also disable the UMANS-GUI project here. If you disable it, you do not need a Qt installation.)
 4. Compile the code in your IDE/compiler.
-This should build two applications (see the [Main projects](#main-projects) section).
-5. Test the UMANS console application by running it from the command line, with the desired arguments.
+This should build several applications (see the [Main projects](#main-projects) section).
+5. If you have compiled the UMANS-GUI program, run it and see an example simulation in action!
+6. Test the UMANS console application by running it from the command line, with the desired arguments.
 If you run the program without any arguments, it will print more detailed usage instructions.
-6. Inspect the CSV files that the application has produced as output. 
+7. Inspect the CSV files that the application has produced as output. 
 Each CSV file contains the trajectory of one agent in the crowd.
 You could consider using the [ChAOS](https://gitlab.inria.fr/OCSR/ChAOS/) software to visualize the crowd in 3D.
 
 # Main projects
 
 In the source code of UMANS, the simulation engine itself is contained in a static library named *Engine*.
-This library can be used to compile two main applications:
+This library is used by three main applications:
 
 - *UMANS-ConsoleApplication*: A command-line-only program that can run a crowd-simulation scenario and report the results in various ways.
 - *UMANS-Library*: A dynamic library with an API that can be integrated into other software (e.g. as a DLL).
+- *UMANS-GUI*: A demo program with a (Qt) GUI, in which users can change the simulation with basic mouse and keyboard interaction.
 
 # Third-party code / licenses
 
-UMANS includes the following third-party code:
+UMANS relies on the following third-party code:
+
+### Qt
+- Website: https://www.qt.io/
+- License: Open Source (https://doc.qt.io/Qt-5/opensourcelicense.html)
 
 ### nanoflann (kd-trees)
 - Source code: https://github.com/jlblancoc/nanoflann
@@ -69,6 +77,10 @@ UMANS includes the following third-party code:
 ### ORCA (one of the collision-avoidance algorithms in UMANS)
 - Source code: https://github.com/snape/RVO2
 - License: Apache (https://github.com/snape/RVO2/blob/master/LICENSE)
+  
+### earcut (Polygon triangulation)
+- Source code: https://github.com/mapbox/earcut.hpp
+- License: ISC (https://github.com/mapbox/earcut.hpp/blob/master/LICENSE)
 
 # Copyright statement
 

src/3rd-party/earcut/LICENSE-earcut

+ISC License
+
+Copyright (c) 2015, Mapbox
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.
\ No newline at end of file

main.cpp → src/ConsoleApplication/main.cpp

@@ -104,7 +104,7 @@ int main( int argc, char * argv[] )
 	if (cs != nullptr)
 	{
 		if (outputFolder != "")
-			cs->SetCSVOutputDirectory(outputFolder);
+			cs->StartCSVOutput(outputFolder, false); // false = don't save any files until the simulation ends
 		cs->RunSimulationUntilEnd();
 	}
 

src/CostFunctions/FOEAvoidance.cpp → src/Engine/CostFunctions/FOEAvoidance.cpp

@@ -23,6 +23,7 @@
 #include <core/agent.h>
 #include <core/worldBase.h>
 #include <tools/Matrix.h>
+#include <tools/HelperFunctions.h>
 
 using namespace std;
 
@@ -42,7 +43,7 @@ float Importance(float ttc)
 
 	float t0 = 5, I0 = 10, a = -I0 / t0;
 	float I = a * ttc + I0;
-	return v2D_clamp(I, 0.1f, 10.f);
+	return HelperFunctions::Clamp<float>(I, 0.1f, 10.f);
 	//return 1;
 }
 
@@ -133,9 +134,9 @@ Vector2D FOEAvoidance::GetGradient(const Vector2D& velocity, Agent* agent, const
 	// TODO: check neighboring obstacles
 	// ...
 
-	gradtheta = v2D_clamp(gradtheta, -0.1f, 0.1f);
+	gradtheta = HelperFunctions::Clamp(gradtheta, -0.1f, 0.1f);
 	//gradtheta = -gradtheta;
-	//gradv = v2D_clamp(gradv, -1.f, 1.f);
+	//gradv = HelperFunctions::Clamp(gradv, -1.f, 1.f);
 	//gradv = 0;
 
 	return -1 * R*(velocity.magnitude()*Vector2D(sin(gradtheta), 1 - cos(gradtheta)) + Vector2D(0, gradv));