WindowSystem.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        Open3D: www.open3d.org                            -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.open3d.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
#include <string>
 
#include "open3d/visualization/gui/Gui.h"
 
namespace open3d {
namespace visualization {
 
namespace rendering {
class FilamentRenderer;
}  // namespace rendering
 
namespace gui {
 
class MenuBase;
class Window;
 
class WindowSystem {
public:
    using OSWindow = void*;
 
    virtual ~WindowSystem() {};
 
    virtual void Initialize() = 0;
    virtual void Uninitialize() = 0;
 
    virtual void WaitEventsTimeout(double timeout_secs) = 0;
 
    virtual Size GetScreenSize(OSWindow w) = 0;
 
    static constexpr int FLAG_VISIBLE = 0;
    static constexpr int FLAG_HIDDEN = (1 << 0);
    static constexpr int FLAG_TOPMOST = (1 << 1);
 
    virtual OSWindow CreateOSWindow(Window* o3d_window,
                                    int width,
                                    int height,
                                    const char* title,
                                    int flags) = 0;
    virtual void DestroyWindow(OSWindow w) = 0;
 
    virtual void PostRedrawEvent(OSWindow w) = 0;
 
    virtual bool GetWindowIsVisible(OSWindow w) const = 0;
    virtual void ShowWindow(OSWindow w, bool show) = 0;
 
    virtual void RaiseWindowToTop(OSWindow w) = 0;
    virtual bool IsActiveWindow(OSWindow w) const = 0;
 
    virtual Point GetWindowPos(OSWindow w) const = 0;
    virtual void SetWindowPos(OSWindow w, int x, int y) = 0;
 
    virtual Size GetWindowSize(OSWindow w) const = 0;
    virtual void SetWindowSize(OSWindow w, int width, int height) = 0;
 
    // Returns total window-decoration extents as Size(left+right, top+bottom)
    // so callers can subtract them from the screen work area before sizing.
    virtual Size GetWindowFrameSize(OSWindow w) const = 0;
 
    virtual Size GetWindowSizePixels(OSWindow w) const = 0;
    virtual void SetWindowSizePixels(OSWindow w, const Size& size) = 0;
 
    virtual float GetWindowScaleFactor(OSWindow w) const = 0;
    virtual float GetUIScaleFactor(OSWindow w) const = 0;
 
    virtual void SetWindowTitle(OSWindow w, const char* title) = 0;
 
    virtual Point GetMousePosInWindow(OSWindow w) const = 0;
    virtual int GetMouseButtons(OSWindow w) const = 0;
 
    virtual void CancelUserClose(OSWindow w) = 0;
 
    virtual void* GetNativeDrawable(OSWindow w) = 0;
 
    // Creates an appropriate renderer with new(). It is the caller's
    // responsibility to delete it.
    virtual rendering::FilamentRenderer* CreateRenderer(OSWindow w) = 0;
 
    virtual void ResizeRenderer(OSWindow w,
                                rendering::FilamentRenderer* renderer) = 0;
 
    virtual MenuBase* CreateOSMenu() = 0;
 
    virtual void SetClipboardText(OSWindow w, const char* text) {}
 
    virtual std::string GetClipboardText(OSWindow w) { return ""; }
};
 
}  // namespace gui
}  // namespace visualization
}  // namespace open3d