Merge pull request #371 from louis-langholtz/updates-20201102

Updates for release 0.12.0

Author: louis-langholtz

Benchmark/BenchmarkMain.cpp

@@ -44,6 +44,7 @@
 #include <atomic>
 #include <ctime>
 #include <map>
+#include <optional>
 #include <type_traits>
 #include <functional>
 
@@ -54,7 +55,6 @@
 
 #include <PlayRho/Common/Math.hpp>
 #include <PlayRho/Common/Intervals.hpp>
-#include <PlayRho/Common/OptionalValue.hpp> // for Optional
 
 #include <PlayRho/Dynamics/World.hpp>
 #include <PlayRho/Dynamics/WorldBody.hpp> // for GetAwakeCount
@@ -693,7 +693,7 @@ class Concurrent
     }
 
 private:
-    playrho::Optional<T> m_element;
+    std::optional<T> m_element;
     std::mutex m_mutex;
     std::condition_variable m_cond;
 };

Build/xcode5/PlayRho.xcodeproj/project.pbxproj

@@ -63,8 +63,6 @@
 		4731DE641DEF841600E7F931 /* SeparationScenario.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 4731DE631DEF841600E7F931 /* SeparationScenario.cpp */; };
 		4731DE671DF0A73000E7F931 /* Manifold.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 4731DE661DF0A73000E7F931 /* Manifold.cpp */; };
 		473273211F44AB9B00E22AE2 /* ContactImpulsesList.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 473273201F44AB9B00E22AE2 /* ContactImpulsesList.cpp */; };
-		473273251F476C1D00E22AE2 /* OptionalValue.hpp in Headers */ = {isa = PBXBuildFile; fileRef = 473273231F476C1D00E22AE2 /* OptionalValue.hpp */; };
-		473273271F47760D00E22AE2 /* OptionalValue.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 473273261F47760D00E22AE2 /* OptionalValue.cpp */; };
 		47327E751E9F1E2A0048FCD8 /* TargetJoint.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 47327E741E9F1E2A0048FCD8 /* TargetJoint.cpp */; };
 		47327E801EA585790048FCD8 /* Defines.hpp in Headers */ = {isa = PBXBuildFile; fileRef = 47327E7D1EA585790048FCD8 /* Defines.hpp */; };
 		4734B2191DC00AFD00F15E29 /* ArrayList.hpp in Headers */ = {isa = PBXBuildFile; fileRef = 4734B2161DC00AFD00F15E29 /* ArrayList.hpp */; };
@@ -455,8 +453,6 @@
 		4731DE631DEF841600E7F931 /* SeparationScenario.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = SeparationScenario.cpp; sourceTree = "<group>"; };
 		4731DE661DF0A73000E7F931 /* Manifold.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = Manifold.cpp; sourceTree = "<group>"; };
 		473273201F44AB9B00E22AE2 /* ContactImpulsesList.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = ContactImpulsesList.cpp; sourceTree = "<group>"; };
-		473273231F476C1D00E22AE2 /* OptionalValue.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = OptionalValue.hpp; sourceTree = "<group>"; };
-		473273261F47760D00E22AE2 /* OptionalValue.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = OptionalValue.cpp; sourceTree = "<group>"; };
 		47327E741E9F1E2A0048FCD8 /* TargetJoint.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = TargetJoint.cpp; sourceTree = "<group>"; };
 		47327E7D1EA585790048FCD8 /* Defines.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Defines.hpp; sourceTree = "<group>"; };
 		4734B2161DC00AFD00F15E29 /* ArrayList.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = ArrayList.hpp; sourceTree = "<group>"; };
@@ -878,7 +874,6 @@
 				473971A71D9D9B4C00F7137F /* Math.cpp */,
 				470F9B531EF9666B007EF7B6 /* MotorJoint.cpp */,
 				47D61F7B1F21112000E702BD /* MultiShape.cpp */,
-				473273261F47760D00E22AE2 /* OptionalValue.cpp */,
 				474BC3FF1D41278800447DCD /* PolygonShape.cpp */,
 				47FFD0FC1DAC6235000D6D0E /* PositionConstraint.cpp */,
 				47AFC3041DAEBC120023E9D1 /* PositionSolverManifold.cpp */,
@@ -1042,7 +1037,6 @@
 				4764085025042BD00090F711 /* NonNegative.hpp */,
 				4764085825047FA10090F711 /* NonPositive.hpp */,
 				47640854250475860090F711 /* NonZero.hpp */,
-				473273231F476C1D00E22AE2 /* OptionalValue.hpp */,
 				470F9B0F1EDF2890007EF7B6 /* Position.hpp */,
 				4764085A2504822F0090F711 /* Positive.hpp */,
 				4764085E2507FBFF0090F711 /* propagate_const.hpp */,
@@ -1410,7 +1404,6 @@
 				47E36F501FE8477000C10B79 /* FixedLimits.hpp in Headers */,
 				47E36F541FE8534500C10B79 /* FixedMath.hpp in Headers */,
 				470F9B301EDF5165007EF7B6 /* Velocity.hpp in Headers */,
-				473273251F476C1D00E22AE2 /* OptionalValue.hpp in Headers */,
 				4764086D250E9E2B0090F711 /* FixtureID.hpp in Headers */,
 				80BB89A6141C3E5900F1753A /* Settings.hpp in Headers */,
 				4764085D250484830090F711 /* Negative.hpp in Headers */,
@@ -1656,7 +1649,6 @@
 				475A94541D930503000CA9A8 /* BlockAllocator.cpp in Sources */,
 				47B58F601F5B791500354C34 /* FlagGuard.cpp in Sources */,
 				4731DDFC1DC8FBEE00E7F931 /* Island.cpp in Sources */,
-				473273271F47760D00E22AE2 /* OptionalValue.cpp in Sources */,
 				474BC4341D413DC200447DCD /* Manifold.cpp in Sources */,
 				475A945B1D9593A4000CA9A8 /* Shape.cpp in Sources */,
 				474BC4351D413DC200447DCD /* Mat33.cpp in Sources */,

CMakeLists.txt

@@ -2,8 +2,11 @@
 # Top level docs for 3.1.3 at: https://cmake.org/cmake/help/v3.1/
 # Commands herein described at: https://cmake.org/cmake/help/v3.1/manual/cmake-commands.7.html
 
-# Minimally require CMake version 3.1...
-cmake_minimum_required(VERSION 3.1)
+# Minimally require a CMake version that can handle what's necessary...
+# According to the following link, support for cxx_std_17 first became available in CMake 3.8.
+# https://github.com/Kitware/CMake/blob/07cfb18f9d29cfc0588ede928846a03ec5599c48/Help/release/3.8.rst
+# It's not clear that CMake 3.8 is enough though. So 3.10 is picked in hopes that dust settled then.
+cmake_minimum_required(VERSION 3.10)
 
 # Require C++17...
 set(CMAKE_CXX_STANDARD 17)
@@ -46,7 +49,7 @@ option(PLAYRHO_BUILD_BENCHMARK "Build PlayRho Benchmark console application." OF
 option(PLAYRHO_BUILD_TESTBED "Build PlayRho Testbed GUI application." OFF)
 option(PLAYRHO_ENABLE_COVERAGE "Enable code coverage generation." OFF)
 
-set(PLAYRHO_VERSION 0.9.0)
+set(PLAYRHO_VERSION 0.12.0)
 set(LIB_INSTALL_DIR lib${LIB_SUFFIX})
 
 # Tell Microsoft Visual C (MSVC) to enable unwind semantics since it doesn't by default.

Documentation/Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = PlayRho
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 0.11.1
+PROJECT_NUMBER         = 0.12.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

INSTALL.md

@@ -13,7 +13,7 @@ Additionally, PlayRho provides some demo/test applications which may provide ext
 ## Prerequisite Tasks
 
 1. Make sure you have the tools that will be needed.
-  - **CMake**: If you don't already have CMake installed on your system, it can be obtained from https://cmake.org/.
+  - **CMake**: If you don't have version 3.16 or higher of CMake installed on your system, the latest releases of CMake can be obtained from https://cmake.org/.
   - **A C++17 compiler suite**: That could be Microsoft's Visual C++, GNU's GCC, or LLVM's Clang. On Microsoft Windows platforms, you can get a complete C++17 compiler suite by getting Microsoft's Visual Studio 2017 from https://www.visualstudio.com/downloads/.
   - **git**: Needed only if you want to do development work. If you don't already have Git installed but you want to install it, you can get it from: https://git-scm.com/downloads.
 2. Decide where you want to put the source code.
@@ -42,29 +42,32 @@ From a command prompt like a Bash Shell, enter code such as the following where
 
 This should download the sources into the `${YOUR_CHOSEN_PATH}` directory under the sub-directory of `PlayRho`.
 
-## Building On Linux Systems
-
-### Using CMake
+## Building From A Bash Shell Using CMake and Make
 
 This folder contains a CMake configuration file `CMakeLists.txt`. It can be used by `cmake` to build the library and all of the application targets on Linux platforms with either GCC C++ or Clang C++. This is the currently suggested way to build things for Linux. Simply run `cmake . && make`. To install the built targets, then run `make install`. This may require a tool like `sudo` to escalate your privileges in order to be able to install into the established folders. The CMake configuration file has a few options that can be modified to build different targets.
 
 Note: if you have trouble building with these instructions, you can also see how PlayRho gets built on the [Travis](https://travis-ci.org) Continuous Integration (CI) system, by looking at the [`.travis.yml`](.travis.yml) file's `script` definition.
 
-## Building On Mac OS X
-
-### Using Xcode
+## Building On Mac OS X Using Xcode
 
 The [`Build/xcode5`](Build/xcode5) folder contains project files for Xcode. The Xcode project file can be used to build the library and all of the application targets on and for the Mac OS X platform.
 
-### Using CMake
-
-Instructions coming.
-
-## Building On Windows
-
-### Using CMake
+## Building On Windows Using CMake-GUI and Visual Studio
 
 Start CMake up with the location of the source code identified for it. By default, only `PLAYRHO_BUILD_STATIC` has a defined value and that should be all that's necessary for simply building the library itself.
+Other `PLAYRHO_BUILD_*` CMake variables can be used to build additional things like the `UnitTest` or `Testbed` applications.
+Press *Configure* or *Generate*.
+If you haven't run CMake before for this project, CMake won't already have a cache of settings,
+and will ask you some additional information like which generator to use.
+Select Visual Studio 15 2017 or newer to generate the project and solution files for that version of Visual Studio and to invoke that version whenever you press the *Open Project* button.
+If you want 64-bit support, you'll need to choose the optional platform generator for your system - that would be `x64` to build for 64-bit Intel X64 platforms.
+Use the default native compilers.
+Then press the *Finish* button.
+CMake may create new variables or need your help especially if you want to also build an optional application like the `Testbed`.
+If you change any CMake variables, be sure to press the Generate button.
+Finally, press the *Open Project* button. This will open up Visual Studio.
+
+From within Visual Studio, select "Release" and initiate a build.
 
 Note: if you have trouble building with these instructions, you can also see how PlayRho gets built on the [AppVeyor](https://ci.appveyor.com/) Continuous Integration (CI) system, by looking at the [`appveyor.yml`](appveyor.yml) file's `build_script` definition.
 
@@ -101,17 +104,3 @@ where this file is located):
 
 You might want to add `-DCMAKE_INSTALL_PREFIX=/opt/PlayRho` or similar to the cmake call to change
 the installation location. make install might need sudo.
-
-### No Longer Supported: premake
-
-For other platforms you may be able to run `premake` in this directory.
-Premake can be obtained from:
-http://industriousone.com/premake
-
-For example, on Linux, you would type:
-
-    premake4 gmake
-
-This will create a gmake folder in the Build directory. From there you can run:
-
-    make config="debug"

PlayRho/CMakeLists.txt

@@ -71,6 +71,7 @@ if(PLAYRHO_BUILD_SHARED)
 		${PLAYRHO_Rope_SRCS}
 		${PLAYRHO_Rope_HDRS}
 	)
+	target_compile_features(PlayRho PUBLIC cxx_std_17)
 	set_target_properties(PlayRho_shared PROPERTIES
 		OUTPUT_NAME "PlayRho"
 		CLEAN_DIRECT_OUTPUT 1
@@ -96,6 +97,7 @@ if(PLAYRHO_BUILD_STATIC)
 		${PLAYRHO_Rope_SRCS}
 		${PLAYRHO_Rope_HDRS}
 	)
+	target_compile_features(PlayRho PUBLIC cxx_std_17)
 	set_target_properties(PlayRho PROPERTIES
 		CLEAN_DIRECT_OUTPUT 1
 		VERSION ${PLAYRHO_VERSION}

PlayRho/Collision/RayCastOutput.hpp

@@ -26,12 +26,13 @@
 /// Declaration of the RayCastOutput structure and related free functions.
 
 #include <PlayRho/Common/UnitInterval.hpp>
-#include <PlayRho/Common/OptionalValue.hpp>
 #include <PlayRho/Collision/RayCastInput.hpp>
 
 #include <PlayRho/Dynamics/BodyID.hpp>
 #include <PlayRho/Dynamics/FixtureID.hpp>
 
+#include <optional>
+
 namespace playrho {
 namespace detail {
 
@@ -85,8 +86,8 @@ struct RayCastHit
 
 /// @brief Ray cast output.
 /// @details This is a type alias for an optional <code>RayCastHit</code> instance.
-/// @see RayCast, Optional, RayCastHit
-using RayCastOutput = Optional<RayCastHit>;
+/// @see RayCast, RayCastHit
+using RayCastOutput = std::optional<RayCastHit>;
 
 /// @brief Ray cast callback function.
 /// @note Return 0 to terminate ray casting, or > 0 to update the segment bounding box.