Widget.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 <memory>
#include <vector>
 
#include "open3d/visualization/gui/Gui.h"
 
namespace open3d {
 
namespace visualization {
namespace rendering {
class Renderer;
}
}  // namespace visualization
 
namespace visualization {
namespace gui {
 
class Color;
struct MouseEvent;
struct KeyEvent;
struct TickEvent;
struct Theme;
 
struct LayoutContext {
    const Theme& theme;
    FontContext& fonts;
};
 
struct DrawContext {
    const Theme& theme;
    visualization::rendering::Renderer& renderer;
    FontContext& fonts;
    int uiOffsetX;
    int uiOffsetY;
    int screenWidth;
    int screenHeight;
    int emPx;
    float frameDelta;  // in seconds
};
 
class Widget {
    friend class Window;
 
public:
    Widget();
    explicit Widget(const std::vector<std::shared_ptr<Widget>>& children);
    virtual ~Widget();
 
    virtual void AddChild(std::shared_ptr<Widget> child);
    virtual const std::vector<std::shared_ptr<Widget>> GetChildren() const;

    virtual const Rect& GetFrame() const;
    virtual void SetFrame(const Rect& f);
 
    virtual const Color& GetBackgroundColor() const;
    virtual bool IsDefaultBackgroundColor() const;
    virtual void SetBackgroundColor(const Color& color);
 
    virtual bool IsVisible() const;
    virtual void SetVisible(bool vis);
 
    virtual bool IsEnabled() const;
    virtual void SetEnabled(bool enabled);
 
    virtual void SetTooltip(const char* text);
    virtual const char* GetTooltip() const;
 
    static constexpr int DIM_GROW = 10000;
    struct Constraints {
        int width = DIM_GROW;
        int height = DIM_GROW;
    };
    virtual Size CalcPreferredSize(const LayoutContext& context,
                                   const Constraints& constraints) const;
 
    virtual Size CalcMinimumSize(const LayoutContext& context) const;
 
    virtual void Layout(const LayoutContext& context);
 
    enum class DrawResult { NONE, REDRAW, RELAYOUT };
    virtual DrawResult Draw(const DrawContext& context);
 
    enum class EventResult { IGNORED, CONSUMED, DISCARD };

    virtual EventResult Mouse(const MouseEvent& e);

    virtual EventResult Key(const KeyEvent& e);

    virtual DrawResult Tick(const TickEvent& e);
 
protected:
    void DrawImGuiPushEnabledState();
    void DrawImGuiPopEnabledState();
    void DrawImGuiTooltip();
 
private:
    struct Impl;
    std::unique_ptr<Impl> impl_;
};
 
}  // namespace gui
}  // namespace visualization
}  // namespace open3d