webxr: Inital example code

Signed-off-by: Squareys <[email protected]>

CMakeLists.txt

@@ -59,6 +59,7 @@ option(WITH_TRIANGLE_VULKAN_EXAMPLE "Build Vulkan Triangle example" OFF)
 option(WITH_VIEWER_EXAMPLE "Build Viewer example (requires the AnySceneImporter plugin)" OFF)
 if(CORRADE_TARGET_EMSCRIPTEN)
     option(WITH_WEBVR_EXAMPLE "Build WebVR example" OFF)
+    option(WITH_WEBXR_EXAMPLE "Build WebXR example" OFF)
 endif()
 
 # A single output location. After a decade of saying NO THIS IS A NON-SOLUTION

doc/changelog-examples.dox

@@ -37,6 +37,8 @@ namespace Magnum {
 -   New @ref examples-fluidsimulation3d example (see
     [mosra/magnum-examples#69](https://github.com/mosra/magnum-examples/pull/69),
     [mosra/magnum-examples#70](https://github.com/mosra/magnum-examples/pull/70))
+-   New @ref examples-webxr example (see
+    [mosra/magnum-examples#73](https://github.com/mosra/magnum-examples/pull/73)
 
 @subsection changelog-examples-latest-changes Changes and improvements
 

doc/credits.dox

@@ -47,7 +47,8 @@ namespace Magnum {
     fixes
 -   **Jonathan Hale** ([\@Squareys](https://github.com/Squareys)) --- the
     @ref examples-ovr, @ref examples-audio, @ref examples-arealights,
-    @ref examples-webvr, @ref examples-leapmotion and @ref examples-imgui
+    @ref examples-webvr, @ref examples-leapmotion, @ref examples-imgui and
+    @ref examples-webxr
     examples, porting to @ref Platform::EmscriptenApplication
 -   **Konstantinos Chatzilygeroudis** ([\@costashatz](https://github.com/costashatz))
     --- the @ref examples-dart example

doc/webxr.dox

@@ -0,0 +1,72 @@
+/*
+    This file is part of Magnum.
+
+    Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019
+              Vladimír Vondruš <[email protected]>
+    Copyright © 2019 Jonathan Hale <[email protected]>
+
+    Permission is hereby granted, free of charge, to any person obtaining a
+    copy of this software and associated documentation files (the "Software"),
+    to deal in the Software without restriction, including without limitation
+    the rights to use, copy, modify, merge, publish, distribute, sublicense,
+    and/or sell copies of the Software, and to permit persons to whom the
+    Software is furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included
+    in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+    DEALINGS IN THE SOFTWARE.
+*/
+
+namespace Magnum {
+/** @page examples-webxr WebXR
+@brief Basic WebXR application.
+
+@m_footernavigation
+
+@image html webxr.png
+
+This example is a basic demonstration of how to use the
+[Emscripten WebXR library](https://github.com/VhiteRabbit/emscripten-webxr)
+with Magnum.
+
+For the full experience, this example requires a WebXR 1.0 capable browser and
+a VR headset. Before Chrome 79 or Oculus Browser 7.0 you may need to enable WebXR
+support explicitly on your browser --- on Chrome go into `chrome://flags` and
+search for WebXR. Works on Android as well.
+
+@m_div{m-button m-primary} <a href="https://magnum.graphics/showcase/webxr/">@m_div{m-big} Live web demo @m_enddiv @m_div{m-small} uses WebAssembly & WebGL @m_enddiv </a> @m_enddiv
+
+Note that there is also a @ref examples-webvr "WebVR example", a
+@ref examples-ovr "Oculus VR example" and a
+@ref examples-leapmotion "Leap Motion example".
+
+@section examples-webxr-controls Controls
+
+-   @m_class{m-label m-default} **Mouse click** --- enter VR
+-   @m_class{m-label m-default} **Esc** --- exit VR
+
+@section examples-webxr-credits Credits
+
+This example was originally contributed by [Jonathan Hale](https://github.com/Squareys) from
+[Vhite Rabbit](https://github.com/VhiteRabbit).
+
+@section examples-webxr-source Source
+
+Full source code is linked below and together with assets also available in the
+[magnum-examples GitHub repository](https://github.com/mosra/magnum-examples/tree/master/src/webxr).
+
+-   @ref webxr/CMakeLists.txt "CMakeLists.txt"
+-   @ref webxr/WebVrExample.cpp "WebXrExample.cpp"
+
+@example webxr/CMakeLists.txt @m_examplenavigation{examples-webxr,webxr/} @m_footernavigation
+@example webxr/WebXrExample.cpp @m_examplenavigation{examples-webxr,webxr/} @m_footernavigation
+
+*/
+}

package/ci/travis-emscripten.sh

@@ -136,6 +136,7 @@ cmake .. \
     -DWITH_TRIANGLE_SOKOL_EXAMPLE=OFF \
     -DWITH_VIEWER_EXAMPLE=OFF \
     -DWITH_WEBVR_EXAMPLE=ON \
+    -DWITH_WEBXR_EXAMPLE=ON \
     -G Ninja
 # Otherwise the job gets killed (probably because using too much memory)
 ninja -j4

src/CMakeLists.txt

@@ -5,6 +5,7 @@
 #
 #       2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 —
 #           Vladimír Vondruš <[email protected]>
+#       2019 — Jonathan Hale <[email protected]>
 #
 #   This is free and unencumbered software released into the public domain.
 #
@@ -129,3 +130,7 @@ endif()
 if(WITH_WEBVR_EXAMPLE)
     add_subdirectory(webvr)
 endif()
+
+if(WITH_WEBXR_EXAMPLE)
+    add_subdirectory(webxr)
+endif()

src/webxr/CMakeLists.txt

@@ -0,0 +1,114 @@
+#
+#   This file is part of Magnum.
+#
+#   Original authors — credit is appreciated but not required:
+#
+#       2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 —
+#           Vladimír Vondruš <[email protected]>
+#       2019 — Jonathan Hale <[email protected]>
+#
+#   This is free and unencumbered software released into the public domain.
+#
+#   Anyone is free to copy, modify, publish, use, compile, sell, or distribute
+#   this software, either in source code form or as a compiled binary, for any
+#   purpose, commercial or non-commercial, and by any means.
+#
+#   In jurisdictions that recognize copyright laws, the author or authors of
+#   this software dedicate any and all copyright interest in the software to
+#   the public domain. We make this dedication for the benefit of the public
+#   at large and to the detriment of our heirs and successors. We intend this
+#   dedication to be an overt act of relinquishment in perpetuity of all
+#   present and future rights to this software under copyright law.
+#
+#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+#   THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+#   IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+#   CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+cmake_minimum_required(VERSION 3.1)
+
+project(MagnumWebXrExample)
+
+# Add module path in case this is project root
+if(PROJECT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
+    set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/../../modules/" ${CMAKE_MODULE_PATH})
+endif()
+
+include(CheckSymbolExists)
+
+# Download required emscripten-webxr files
+# You might want to add https://github.com/VhiteRabbit/emscripten-webxr as a
+# submodule instead for your own project.
+if(NOT EMSCRIPTEN_WEBXR_COMMIT)
+    # Commit from which to download the emscripten-webxr files
+    set(EMSCRIPTEN_WEBXR_COMMIT e101ce7cfc3c92962a65771f43c2d61775edd348)
+endif()
+
+# The cache prevents downloading of the emscripten-webxr files every configure
+set(_USE_CACHE ON)
+if(NOT ${_EMSCRIPTEN_WEBXR_COMMIT} STREQUAL ${EMSCRIPTEN_WEBXR_COMMIT})
+    set(_USE_CACHE OFF)
+endif()
+
+# TODO: @mosra How to handle the license (MIT)? Download that also?
+message(STATUS "Downloading emscripten-webxr")
+foreach(_FILE library_webxr.js;webxr.h)
+    set(_TARGET_FILE ${CMAKE_CURRENT_BINARY_DIR}/${_FILE})
+
+    if(NOT EXISTS ${_TARGET_FILE} OR NOT _USE_CACHE)
+        message(STATUS "> Downloading ${_FILE}")
+        file(DOWNLOAD https://raw.githubusercontent.com/VhiteRabbit/emscripten-webxr/${EMSCRIPTEN_WEBXR_COMMIT}/${_FILE}
+            ${_TARGET_FILE})
+        set(_EMSCRIPTEN_WEBXR_COMMIT ${EMSCRIPTEN_WEBXR_COMMIT} CACHE STRING "Commit of emscripten-webxr that has been downloaded last")
+    else()
+        message(STATUS "> Using cached ${_FILE}")
+    endif()
+endforeach()
+unset(_USE_CACHE)
+unset(_TARGET_FILE)
+
+find_package(Magnum REQUIRED
+    GL
+    MeshTools
+    Primitives
+    Shaders
+    EmscriptenApplication)
+
+set_directory_properties(PROPERTIES CORRADE_USE_PEDANTIC_FLAGS ON)
+
+add_executable(magnum-webxr WebXrExample.cpp)
+target_link_libraries(magnum-webxr PRIVATE
+    Magnum::Application
+    Magnum::GL
+    Magnum::Magnum
+    Magnum::MeshTools
+    Magnum::Primitives
+    Magnum::Shaders)
+target_include_directories(magnum-webxr PUBLIC ${CMAKE_CURRENT_BINARY_DIR} ${EMSCRIPTEN_TOOLCHAIN_PATH})
+target_link_options(magnum-webxr PRIVATE
+    "SHELL:--js-library ${CMAKE_CURRENT_BINARY_DIR}/library_webxr.js")
+
+# Copy the boilerplate next to the executable so it can be run directly from
+# the build dir; provide an install target as well
+add_custom_command(TARGET magnum-webxr POST_BUILD
+    COMMAND ${CMAKE_COMMAND} -E copy_if_different
+        ${MAGNUM_EMSCRIPTENAPPLICATION_JS}
+        ${MAGNUM_WEBAPPLICATION_CSS}
+        $<TARGET_FILE_DIR:magnum-webxr>
+    COMMAND ${CMAKE_COMMAND} -E copy_if_different
+        ${CMAKE_CURRENT_SOURCE_DIR}/webxr.html
+        $<TARGET_FILE_DIR:magnum-webxr>/magnum-webxr.html)
+
+install(FILES webxr.html DESTINATION ${MAGNUM_DEPLOY_PREFIX}/webxr RENAME index.html)
+install(TARGETS magnum-webxr DESTINATION ${MAGNUM_DEPLOY_PREFIX}/webxr)
+install(FILES
+    ${MAGNUM_EMSCRIPTENAPPLICATION_JS}
+    ${MAGNUM_WEBAPPLICATION_CSS}
+    DESTINATION ${MAGNUM_DEPLOY_PREFIX}/webxr)
+install(FILES
+    ${CMAKE_BINARY_DIR}/bin/magnum-webxr.js.mem
+    ${CMAKE_BINARY_DIR}/bin/magnum-webxr.wasm
+    DESTINATION ${MAGNUM_DEPLOY_PREFIX}/webxr OPTIONAL)