AppEmscripten.cpp File Reference

App::run implementation from App.h for the Emscripten platform. More...

#include <App.h>
#include <SLGLState.h>
#include <SLEnums.h>
#include <SLInterface.h>
#include <AppCommon.h>
#include <SLAssetManager.h>
#include <SLScene.h>
#include <SLSceneView.h>
#include <CVCapture.h>
#include <Profiler.h>
#include <SLAssetLoader.h>
#include <emscripten.h>
#include <emscripten/em_asm.h>
#include <emscripten/html5.h>
#include <emscripten/val.h>

Include dependency graph for AppEmscripten.cpp:

Go to the source code of this file.

Functions
static SLbool	onPaint ()
	Paint event handler that passes the event to the slPaintAllViews function. More...
static void	updateCanvas ()
static void	onLoadingCoreAssets ()
static EM_BOOL	onAnimationFrame (double time, void *userData)
static EMSCRIPTEN_RESULT	onMousePressed (int eventType, const EmscriptenMouseEvent *mouseEvent, void *userData)
static EM_BOOL	onMouseReleased (int eventType, const EmscriptenMouseEvent *mouseEvent, void *userData)
static EM_BOOL	onMouseDoubleClicked (int eventType, const EmscriptenMouseEvent *mouseEvent, void *userData)
static EM_BOOL	onMouseMove (int eventType, const EmscriptenMouseEvent *mouseEvent, void *userData)
static EM_BOOL	onMouseWheel (int eventType, const EmscriptenWheelEvent *wheelEvent, void *userData)
static EM_BOOL	onKeyPressed (int eventType, const EmscriptenKeyboardEvent *keyEvent, void *userData)
static EM_BOOL	onKeyReleased (int eventType, const EmscriptenKeyboardEvent *keyEvent, void *userData)
static EM_BOOL	onTouchStart (int eventType, const EmscriptenTouchEvent *touchEvent, void *userData)
static EM_BOOL	onTouchEnd (int eventType, const EmscriptenTouchEvent *touchEvent, void *userData)
static EM_BOOL	onTouchMove (int eventType, const EmscriptenTouchEvent *touchEvent, void *userData)
static const char *	onUnload (int eventType, const void *reserved, void *userData)
static SLint	convertToCanvasCoordinate (SLint coordinate)
static SLKey	mapKeyToSLKey (unsigned long key)
static SLKey	mapModifiersToSLModifiers (bool shiftDown, bool ctrlDown, bool altDown)
static SLKey	mapModifiersToSLModifiers (const EmscriptenMouseEvent *mouseEvent)
static SLKey	mapModifiersToSLModifiers (const EmscriptenKeyboardEvent *keyEvent)

Variables
static SLint	svIndex
	Scene view index. More...
static SLint	startX
	start position x in pixels More...
static SLint	startY
	start position y in pixels More...
static SLint	mouseX
	Last mouse position x in pixels. More...
static SLint	mouseY
	Last mouse position y in pixels. More...
static SLVec2i	touch2
	Last finger touch 2 position in pixels. More...
static SLVec2i	touchDelta
	Delta between two fingers in x. More...
static SLint	lastWidth
	Last window width in pixels. More...
static SLint	lastHeight
	Last window height in pixels. More...
static int	canvasWidth
	Width of the HTML canvas. More...
static int	canvasHeight
	Height of the HTML canvas. More...
static int	lastTouchDownX
	X coordinate of last touch down. More...
static int	lastTouchDownY
	Y coordinate of last touch down. More...
static double	lastTouchDownTimeMS
	Time of last touch down in milliseconds. More...
static long	animationFrameID = 0
	ID of the current JavaScript animation frame. More...
static SLbool	coreAssetsLoaded = false
	Indicates whether core assets can be used. More...

Detailed Description

App::run implementation from App.h for the Emscripten platform.

Date

June 2024

The functions implement mostly the callbacks for the platform that are forwarded to the C interface in SLInterface. For more info on how to create a new app with SLProject see: https://github.com/cpvrlab/SLProject4/wiki/Creating-a-New-App For more info about App framework see: https://cpvrlab.github.io/SLProject4/app-framework.html For more info about the Emscripten platform see: https://cpvrlab.github.io/SLProject4/emscripten.html For more info on how to set up the Emscripten platform see: https://github.com/cpvrlab/SLProject4/wiki/Build-for-the-web-with-Emscripten

Authors

Marino von Wattenwyl

Copyright

http://opensource.org/licenses/GPL-3.0

Remarks

Please use clangformat to format the code. See more code style on https://github.com/cpvrlab/SLProject4/wiki/SLProject-Coding-Style

Definition in file AppEmscripten.cpp.

Function Documentation

convertToCanvasCoordinate()

static SLint convertToCanvasCoordinate ( SLint  coordinate )

static

Definition at line 534 of file AppEmscripten.cpp.

{
    return (SLint)((double)coordinate * EM_ASM_DOUBLE(return window.devicePixelRatio));
}

mapKeyToSLKey()

static SLKey mapKeyToSLKey ( unsigned long  key )

static

Definition at line 539 of file AppEmscripten.cpp.

{
    switch (key)
    {
        case 8: return K_backspace;
        case 9: return K_tab;
        case 13: return K_enter;
        case 16: return K_shift;
        case 17: return K_ctrl;
        case 18: return K_alt;
        case 27: return K_esc;
        case 32: return K_space;
        case 33: return K_pageUp;
        case 34: return K_pageDown;
        case 35: return K_end;
        case 36: return K_home;
        case 37: return K_left;
        case 38: return K_up;
        case 39: return K_right;
        case 40: return K_down;
        case 45: return K_insert;
        case 46: return K_delete;
        case 96: return K_NP0;
        case 97: return K_NP1;
        case 98: return K_NP2;
        case 99: return K_NP3;
        case 100: return K_NP4;
        case 101: return K_NP5;
        case 102: return K_NP6;
        case 103: return K_NP7;
        case 104: return K_NP8;
        case 105: return K_NP9;
        case 106: return K_NPMultiply;
        case 107: return K_NPAdd;
        case 109: return K_NPSubtract;
        case 110: return K_NPDecimal;
        case 111: return K_NPDivide;
        case 112: return K_F1;
        case 113: return K_F2;
        case 114: return K_F3;
        case 115: return K_F4;
        case 116: return K_F5;
        case 117: return K_F6;
        case 118: return K_F7;
        case 119: return K_F8;
        case 120: return K_F9;
        case 121: return K_F10;
        case 122: return K_F11;
        case 123: return K_F12;
        default: return (SLKey)key;
    }
}

mapModifiersToSLModifiers() [1/3]

SLKey mapModifiersToSLModifiers ( bool  shiftDown, bool  ctrlDown, bool  altDown  )

static

Definition at line 592 of file AppEmscripten.cpp.

{
    int modifiers = 0;
    if (shiftDown) modifiers |= K_shift;
    if (ctrlDown) modifiers |= K_ctrl;
    if (altDown) modifiers |= K_alt;
    return (SLKey)modifiers;
}

mapModifiersToSLModifiers() [2/3]

SLKey mapModifiersToSLModifiers ( const EmscriptenKeyboardEvent *  keyEvent )

static

Definition at line 608 of file AppEmscripten.cpp.

{
    return mapModifiersToSLModifiers(keyEvent->shiftKey,
                                     keyEvent->ctrlKey,
                                     keyEvent->altKey);
}

mapModifiersToSLModifiers() [3/3]

SLKey mapModifiersToSLModifiers ( const EmscriptenMouseEvent *  mouseEvent )

static

Definition at line 601 of file AppEmscripten.cpp.

{
    return mapModifiersToSLModifiers(mouseEvent->shiftKey,
                                     mouseEvent->ctrlKey,
                                     mouseEvent->altKey);
}

onAnimationFrame()

static EM_BOOL onAnimationFrame ( double  time, void *  userData  )

static

Definition at line 230 of file AppEmscripten.cpp.

{
    if (coreAssetsLoaded)
        onPaint();
    else
        onLoadingCoreAssets();
 
    // Request another animation frame from the browser to run the next iteration of `update`.
    animationFrameID = emscripten_request_animation_frame(onAnimationFrame, nullptr);
 
    return EM_TRUE;
}

onKeyPressed()

static EM_BOOL onKeyPressed ( int  eventType, const EmscriptenKeyboardEvent *  keyEvent, void *  userData  )

static

Definition at line 400 of file AppEmscripten.cpp.

{
    if (keyEvent->repeat)
        return EM_TRUE;
 
    SLKey key       = mapKeyToSLKey(keyEvent->keyCode);
    SLKey modifiers = mapModifiersToSLModifiers(keyEvent);
    slKeyPress(svIndex, key, modifiers);
 
    return EM_FALSE;
}

onKeyReleased()

static EM_BOOL onKeyReleased ( int  eventType, const EmscriptenKeyboardEvent *  keyEvent, void *  userData  )

static

Definition at line 414 of file AppEmscripten.cpp.

{
    SLKey key       = mapKeyToSLKey(keyEvent->keyCode);
    SLKey modifiers = mapModifiersToSLModifiers(keyEvent);
    slKeyRelease(svIndex, key, modifiers);
 
    return EM_FALSE;
}

onLoadingCoreAssets()

static void onLoadingCoreAssets ( )

static

Definition at line 204 of file AppEmscripten.cpp.

{
    if (AppCommon::assetLoader->isLoading())
    {
        AppCommon::assetLoader->checkIfAsyncLoadingIsDone();
        return;
    }
 
    coreAssetsLoaded = true;
 
    slCreateSceneView(AppCommon::assetManager,
                      AppCommon::scene,
                      canvasWidth,
                      canvasHeight,
                      (int)(142.0 * EM_ASM_DOUBLE(return window.devicePixelRatio)),
                      App::config.startSceneID,
                      reinterpret_cast<void*>(onPaint),
                      nullptr,
                      reinterpret_cast<void*>(App::config.onNewSceneView),
                      reinterpret_cast<void*>(App::config.onGuiBuild),
                      reinterpret_cast<void*>(App::config.onGuiLoadConfig),
                      reinterpret_cast<void*>(App::config.onGuiSaveConfig));
 
    EM_ASM(document.querySelector("#loading-overlay").style.opacity = 0);
}

onMouseDoubleClicked()

static EM_BOOL onMouseDoubleClicked ( int  eventType, const EmscriptenMouseEvent *  mouseEvent, void *  userData  )

static

Definition at line 326 of file AppEmscripten.cpp.

{
    SLint x         = convertToCanvasCoordinate(mouseEvent->targetX);
    SLint y         = convertToCanvasCoordinate(mouseEvent->targetY);
    SLKey modifiers = mapModifiersToSLModifiers(mouseEvent);
 
    switch (mouseEvent->button)
    {
        case 0:
            slDoubleClick(svIndex,
                          MB_left,
                          x,
                          y,
                          modifiers);
            break;
        case 1:
            slDoubleClick(svIndex,
                          MB_middle,
                          x,
                          y,
                          modifiers);
            break;
        case 2:
            slDoubleClick(svIndex,
                          MB_right,
                          x,
                          y,
                          modifiers);
            break;
        default: break;
    }
 
    return EM_TRUE;
}

onMouseMove()

static EM_BOOL onMouseMove ( int  eventType, const EmscriptenMouseEvent *  mouseEvent, void *  userData  )

static

Definition at line 363 of file AppEmscripten.cpp.

{
    mouseX = convertToCanvasCoordinate(mouseEvent->targetX);
    mouseY = convertToCanvasCoordinate(mouseEvent->targetY);
 
    if (mouseEvent->altKey && mouseEvent->ctrlKey)
        slTouch2Move(svIndex,
                     mouseX - 20,
                     mouseY,
                     mouseX + 20,
                     mouseY);
    else
        slMouseMove(svIndex,
                    mouseX,
                    mouseY);
 
    return EM_TRUE;
}

onMousePressed()

static EMSCRIPTEN_RESULT onMousePressed ( int  eventType, const EmscriptenMouseEvent *  mouseEvent, void *  userData  )

static

Definition at line 243 of file AppEmscripten.cpp.

{
    SLint x         = convertToCanvasCoordinate(mouseEvent->targetX);
    SLint y         = convertToCanvasCoordinate(mouseEvent->targetY);
    SLKey modifiers = mapModifiersToSLModifiers(mouseEvent);
 
    startX = x;
    startY = y;
 
    switch (mouseEvent->button)
    {
        case 0:
            if (modifiers & K_alt && modifiers & K_ctrl)
                slTouch2Down(svIndex, x - 20, y, x + 20, y);
            else
                slMouseDown(svIndex,
                            MB_left,
                            x,
                            y,
                            modifiers);
            break;
        case 1:
            slMouseDown(svIndex,
                        MB_middle,
                        x,
                        y,
                        modifiers);
            break;
        case 2:
            slMouseDown(svIndex,
                        MB_right,
                        x,
                        y,
                        modifiers);
            break;
        default: break;
    }
 
    return EM_TRUE;
}

onMouseReleased()

static EM_BOOL onMouseReleased ( int  eventType, const EmscriptenMouseEvent *  mouseEvent, void *  userData  )

static

Definition at line 286 of file AppEmscripten.cpp.

{
    SLint x         = convertToCanvasCoordinate(mouseEvent->targetX);
    SLint y         = convertToCanvasCoordinate(mouseEvent->targetY);
    SLKey modifiers = mapModifiersToSLModifiers(mouseEvent);
 
    startX = -1;
    startY = -1;
 
    switch (mouseEvent->button)
    {
        case 0:
            slMouseUp(svIndex,
                      MB_left,
                      x,
                      y,
                      modifiers);
            break;
        case 1:
            slMouseUp(svIndex,
                      MB_middle,
                      x,
                      y,
                      modifiers);
            break;
        case 2:
            slMouseUp(svIndex,
                      MB_right,
                      x,
                      y,
                      modifiers);
            break;
        default: break;
    }
 
    return EM_TRUE;
}

onMouseWheel()

static EM_BOOL onMouseWheel ( int  eventType, const EmscriptenWheelEvent *  wheelEvent, void *  userData  )

static

Definition at line 384 of file AppEmscripten.cpp.

{
    // Invert the sign because the scroll value is inverted
    double deltaY = -wheelEvent->deltaY;
 
    // Make sure the delta is at least one integer
    if (std::abs(deltaY) < 1) deltaY = Utils::sign(wheelEvent->deltaY);
 
    SLKey modifiers = mapModifiersToSLModifiers(&wheelEvent->mouse);
    slMouseWheel(svIndex, (int)deltaY, modifiers);
 
    return EM_TRUE;
}

onPaint()

static SLbool onPaint ( )

static

Paint event handler that passes the event to the slPaintAllViews function.

Definition at line 152 of file AppEmscripten.cpp.

{
    if (AppCommon::sceneViews.empty())
        return false;
 
    SLSceneView* sv = AppCommon::sceneViews[svIndex];
 
    int newCanvasWidth  = EM_ASM_INT(return window.devicePixelRatio * window.innerWidth);
    int newCanvasHeight = EM_ASM_INT(return window.devicePixelRatio * window.innerHeight);
 
    if (newCanvasWidth != canvasWidth || newCanvasHeight != canvasHeight)
    {
        canvasWidth  = newCanvasWidth;
        canvasHeight = newCanvasHeight;
        updateCanvas();
 
        if (!AppCommon::sceneViews.empty())
            slResize(svIndex,
                     canvasWidth,
                     canvasHeight);
    }
 
    if (AppCommon::sceneToLoad)
    {
        slSwitchScene(sv, *AppCommon::sceneToLoad);
        AppCommon::sceneToLoad = {}; // sets optional to empty
    }
 
    if (AppCommon::assetLoader->isLoading())
        AppCommon::assetLoader->checkIfAsyncLoadingIsDone();
 
    //////////////////////////////////////////////////////////////////////////
    SLbool appNeedsUpdate  = App::config.onUpdate && App::config.onUpdate(sv);
    SLbool jobIsRunning    = slUpdateParallelJob();
    SLbool isLoading       = AppCommon::assetLoader->isLoading();
    SLbool viewNeedsUpdate = slPaintAllViews();
    //////////////////////////////////////////////////////////////////////////
 
    return appNeedsUpdate || viewNeedsUpdate || jobIsRunning || isLoading;
}

onTouchEnd()

static EM_BOOL onTouchEnd ( int  eventType, const EmscriptenTouchEvent *  touchEvent, void *  userData  )

static

Definition at line 455 of file AppEmscripten.cpp.

{
    if (touchEvent->numTouches == 1)
    {
        mouseX = convertToCanvasCoordinate(touchEvent->touches[0].clientX);
        mouseY = convertToCanvasCoordinate(touchEvent->touches[0].clientY);
        slMouseUp(svIndex,
                  MB_left,
                  mouseX,
                  mouseY,
                  K_none);
 
        int    dx = std::abs(mouseX - lastTouchDownX);
        int    dy = std::abs(mouseY - lastTouchDownY);
        double dt = touchEvent->timestamp - lastTouchDownTimeMS;
 
        if (dt > 800 && dx < 15 && dy < 15)
        {
            slMouseDown(svIndex,
                        MB_right,
                        lastTouchDownX,
                        lastTouchDownY,
                        K_none);
            slMouseUp(svIndex,
                      MB_right,
                      lastTouchDownX,
                      lastTouchDownY,
                      K_none);
        }
    }
    else if (touchEvent->numTouches == 2)
    {
        int x0 = convertToCanvasCoordinate(touchEvent->touches[0].clientX);
        int y0 = convertToCanvasCoordinate(touchEvent->touches[0].clientY);
        int x1 = convertToCanvasCoordinate(touchEvent->touches[1].clientX);
        int y1 = convertToCanvasCoordinate(touchEvent->touches[1].clientY);
        slTouch2Up(svIndex, x0, y0, x1, y1);
    }
 
    return EM_TRUE;
}

onTouchMove()

static EM_BOOL onTouchMove ( int  eventType, const EmscriptenTouchEvent *  touchEvent, void *  userData  )

static

Definition at line 499 of file AppEmscripten.cpp.

{
    if (touchEvent->numTouches == 1)
    {
        mouseX = convertToCanvasCoordinate(touchEvent->touches[0].clientX);
        mouseY = convertToCanvasCoordinate(touchEvent->touches[0].clientY);
        slMouseMove(svIndex, mouseX, mouseY);
    }
    else if (touchEvent->numTouches == 2)
    {
        int x0 = convertToCanvasCoordinate(touchEvent->touches[0].clientX);
        int y0 = convertToCanvasCoordinate(touchEvent->touches[0].clientY);
        int x1 = convertToCanvasCoordinate(touchEvent->touches[1].clientX);
        int y1 = convertToCanvasCoordinate(touchEvent->touches[1].clientY);
        slTouch2Move(svIndex, x0, y0, x1, y1);
    }
 
    return EM_TRUE;
}

onTouchStart()

static EM_BOOL onTouchStart ( int  eventType, const EmscriptenTouchEvent *  touchEvent, void *  userData  )

static

Definition at line 425 of file AppEmscripten.cpp.

{
    if (touchEvent->numTouches == 1)
    {
        mouseX = convertToCanvasCoordinate(touchEvent->touches[0].clientX);
        mouseY = convertToCanvasCoordinate(touchEvent->touches[0].clientY);
        slMouseDown(svIndex,
                    MB_left,
                    mouseX,
                    mouseY,
                    K_none);
        lastTouchDownTimeMS = touchEvent->timestamp;
    }
    else if (touchEvent->numTouches == 2)
    {
        int x0 = convertToCanvasCoordinate(touchEvent->touches[0].clientX);
        int y0 = convertToCanvasCoordinate(touchEvent->touches[0].clientY);
        int x1 = convertToCanvasCoordinate(touchEvent->touches[1].clientX);
        int y1 = convertToCanvasCoordinate(touchEvent->touches[1].clientY);
        slTouch2Down(svIndex, x0, y0, x1, y1);
    }
 
    lastTouchDownX = mouseX;
    lastTouchDownY = mouseY;
 
    return EM_TRUE;
}

onUnload()

static const char * onUnload ( int  eventType, const void *  reserved, void *  userData  )

static

Definition at line 521 of file AppEmscripten.cpp.

{
    slTerminate();
 
    // Cancel the current animation frame to prevent `update` being called after
    // everything has been terminated and cleaned up.
    emscripten_cancel_animation_frame(animationFrameID);
 
    return nullptr;
}

updateCanvas()

static void updateCanvas ( )

static

Definition at line 193 of file AppEmscripten.cpp.

{
    // clang-format off
    EM_ASM({
        let canvas = Module['canvas'];
        canvas.width = $0;
        canvas.height = $1;
    }, canvasWidth, canvasHeight);
    // clang-format on
}

Variable Documentation

animationFrameID

long animationFrameID = 0

static

ID of the current JavaScript animation frame.

Definition at line 55 of file AppEmscripten.cpp.

canvasHeight

int canvasHeight

static

Height of the HTML canvas.

Definition at line 51 of file AppEmscripten.cpp.

canvasWidth

int canvasWidth

static

Width of the HTML canvas.

Definition at line 50 of file AppEmscripten.cpp.

coreAssetsLoaded

SLbool coreAssetsLoaded = false

static

Indicates whether core assets can be used.

Definition at line 56 of file AppEmscripten.cpp.

lastHeight

SLint lastHeight

static

Last window height in pixels.

Definition at line 49 of file AppEmscripten.cpp.

lastTouchDownTimeMS

double lastTouchDownTimeMS

static

Time of last touch down in milliseconds.

Definition at line 54 of file AppEmscripten.cpp.

lastTouchDownX

int lastTouchDownX

static

X coordinate of last touch down.

Definition at line 52 of file AppEmscripten.cpp.

lastTouchDownY

int lastTouchDownY

static

Y coordinate of last touch down.

Definition at line 53 of file AppEmscripten.cpp.

lastWidth

SLint lastWidth

static

Last window width in pixels.

Definition at line 48 of file AppEmscripten.cpp.

mouseX

SLint mouseX

static

Last mouse position x in pixels.

Definition at line 44 of file AppEmscripten.cpp.

mouseY

SLint mouseY

static

Last mouse position y in pixels.

Definition at line 45 of file AppEmscripten.cpp.

startX

SLint startX

static

start position x in pixels

Definition at line 42 of file AppEmscripten.cpp.

startY

SLint startY

static

start position y in pixels

Definition at line 43 of file AppEmscripten.cpp.

svIndex

SLint svIndex

static

Scene view index.

Definition at line 41 of file AppEmscripten.cpp.

touch2

SLVec2i touch2

static

Last finger touch 2 position in pixels.

Definition at line 46 of file AppEmscripten.cpp.

touchDelta

SLVec2i touchDelta

static

Delta between two fingers in x.

Definition at line 47 of file AppEmscripten.cpp.