Window.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 <functional>
#include <memory>
#include <string>
 
#include "open3d/visualization/gui/Events.h"
#include "open3d/visualization/gui/Gui.h"
#include "open3d/visualization/gui/Menu.h"
#include "open3d/visualization/gui/Widget.h"
#include "open3d/visualization/gui/WindowSystem.h"
#include "open3d/visualization/rendering/Renderer.h"
 
namespace open3d {
namespace visualization {
namespace gui {
 
class Dialog;
class Menu;
class Renderer;
struct Theme;
 
class Window {
    friend class Application;
    friend class Renderer;
 
public:
    static const int FLAG_HIDDEN;
    static const int FLAG_TOPMOST;
 
    explicit Window(const std::string& title, int flags = 0);
 
    Window(const std::string& title,
           int width,
           int height,
           int flags = 0);  // centered
 
    Window(const std::string& title,
           int x,
           int y,
           int width,
           int height,
           int flags = 0);
    virtual ~Window();
 
    const Theme& GetTheme() const;
    visualization::rendering::Renderer& GetRenderer() const;
 
    Rect GetOSFrame() const;
    void SetOSFrame(const Rect& r);
 
    const char* GetTitle() const;
    void SetTitle(const char* title);
 
    void SizeToFit();
 
    void SetSize(const Size& size);
    Size GetSize() const;
    Rect GetContentRect() const;
    float GetScaling() const;
    Point GlobalToWindowCoord(int global_x, int global_y);
 
    bool IsVisible() const;
    void Show(bool vis = true);
    void Close();
 
    void SetNeedsLayout();
    void PostRedraw();
 
    void SetTopmost(bool topmost);
    void RaiseToTop() const;
 
    bool IsActiveWindow() const;
 
    void SetFocusWidget(Widget* w);
 
    void AddChild(std::shared_ptr<Widget> w);
 
    void SetOnMenuItemActivated(Menu::ItemId item_id,
                                std::function<void()> callback);
 
    void SetOnTickEvent(std::function<bool()> callback);
 
    void SetOnClose(std::function<bool()> callback);
 
    void SetOnKeyEvent(std::function<bool(const KeyEvent&)> callback);
 
    void ShowDialog(std::shared_ptr<Dialog> dlg);
    void CloseDialog();
 
    void ShowMessageBox(const char* title, const char* message);
 
    void SetClipboardText(const std::string& text);
 
    std::string GetClipboardText() const;
 
    void DestroyWindow();
 
    // Override to handle menu items
    virtual void OnMenuItemSelected(Menu::ItemId item_id);
 
    // Override to handle drag and drop on the windows.
    virtual void OnDragDropped(const char* path);
 
    // Shows or hides the menubar, except on macOS when using real windows.
    // This is intended to be used when using HeadlessWindowSystem but may
    // be useful in other circumstances.
    void ShowMenu(bool show);
 
    int GetMouseMods() const;  // internal, for WindowSystem
 
    std::string GetWebRTCUID() const;
 
protected:
    virtual Size CalcPreferredSize();
 
    virtual void Layout(const LayoutContext& context);
 
    LayoutContext GetLayoutContext();
 
    const std::vector<std::shared_ptr<Widget>>& GetChildren() const;
 
public:
    // these are intended for internal delivery of events
    void OnDraw();
    void OnResize();
    void OnMouseEvent(const MouseEvent& e);
    void OnKeyEvent(const KeyEvent& e);
    void OnTextInput(const TextInputEvent& e);
    void OnTickEvent(const TickEvent& e);
 
    WindowSystem::OSWindow GetOSWindow() const;
 
private:
    void CreateRenderer();
    Widget::DrawResult DrawOnce(bool is_layout_pass);
    void* MakeDrawContextCurrent() const;
    void RestoreDrawContext(void* old_context) const;
 
private:
    struct Impl;
    std::unique_ptr<Impl> impl_;
};
 
}  // namespace gui
}  // namespace visualization
}  // namespace open3d