Application.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        Open3D: www.open3d.org                            -
// ----------------------------------------------------------------------------
// The MIT License (MIT)
//
// Copyright (c) 2018-2021 www.open3d.org
//
// 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.
// ----------------------------------------------------------------------------

#pragma once

#include <cstdint>
#include <functional>
#include <memory>
#include <string>
#include <vector>

#include "open3d/visualization/gui/Font.h"
#include "open3d/visualization/gui/Menu.h"

namespace open3d {

namespace geometry {
class Image;
}

namespace visualization {

namespace rendering {
class Renderer;
class View;
class Scene;
}  // namespace rendering

namespace gui {

struct Theme;
class Window;
class WindowSystem;

class Application {
public:
    static Application &GetInstance();

    virtual ~Application();

    void Initialize();
    void Initialize(int argc, const char *argv[]);
    void Initialize(const char *resource_path);

    static constexpr FontId DEFAULT_FONT_ID = 0;
    FontId AddFont(const FontDescription &fd);
    void SetFont(FontId id, const FontDescription &fd);

    void Run();
    void Quit();

    void RunInThread(std::function<void()> f);
    void PostToMainThread(Window *window, std::function<void()> f);

    std::shared_ptr<Menu> GetMenubar() const;
    void SetMenubar(std::shared_ptr<Menu> menubar);

    void AddWindow(std::shared_ptr<Window> window);
    void RemoveWindow(Window *window);

    void ShowMessageBox(const char *title, const char *message);

    WindowSystem &GetWindowSystem() const;

    // (std::string not good in interfaces for ABI reasons)
    const char *GetResourcePath() const;

    const Theme &GetTheme() const;

    double Now() const;

    void OnMenuItemSelected(Menu::ItemId itemId);

    void OnTerminate();

    class EnvUnlocker {
    public:
        EnvUnlocker() {}
        virtual ~EnvUnlocker() {}
        virtual void unlock() {}
        virtual void relock() {}
    };
    bool RunOneTick(EnvUnlocker &unlocker, bool cleanup_if_no_windows = true);

    void SetWindowSystem(std::shared_ptr<WindowSystem> ws);

    bool UsingNativeWindows() const;

    void VerifyIsInitialized();

    const std::vector<FontDescription> &GetFontDescriptions() const;

    std::shared_ptr<geometry::Image> RenderToImage(
            rendering::Renderer &renderer,
            rendering::View *view,
            rendering::Scene *scene,
            int width,
            int height);

    // Same as RenderToImage(), but returns the depth values in a float image.
    std::shared_ptr<geometry::Image> RenderToDepthImage(
            rendering::Renderer &renderer,
            rendering::View *view,
            rendering::Scene *scene,
            int width,
            int height,
            bool z_in_view_space = false);

private:
    Application();

    enum class RunStatus { CONTINUE, DONE };
    RunStatus ProcessQueuedEvents(EnvUnlocker &unlocker);

private:
    struct Impl;
    std::unique_ptr<Impl> impl_;
};

}  // namespace gui
}  // namespace visualization
}  // namespace open3d