Layout.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        Open3D: www.open3d.org                            -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2023 www.open3d.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
#include <string>
 
#include "open3d/visualization/gui/Widget.h"
 
namespace open3d {
namespace visualization {
namespace gui {
 
struct Margins {
    int left;
    int top;
    int right;
    int bottom;
 
    Margins();  // all values zero
    Margins(int px);
    Margins(int horiz_px, int vert_px);
    Margins(int left_px, int top_px, int right_px, int bottom_px);
 
    int GetHoriz() const;
    int GetVert() const;
};
 
class Layout1D : public Widget {
    using Super = Widget;
 
public:
    enum Dir { VERT, HORIZ };
 
    static void debug_PrintPreferredSizes(Layout1D* layout,
                                          const LayoutContext& context,
                                          const Constraints& constraints,
                                          int depth = 0);
 
    Layout1D(Dir dir,
             int spacing,
             const Margins& margins,
             const std::vector<std::shared_ptr<Widget>>& children);
    virtual ~Layout1D();
 
    int GetSpacing() const;
    const Margins& GetMargins() const;
    void SetSpacing(int spacing);
    void SetMargins(const Margins& margins);
 
    Size CalcPreferredSize(const LayoutContext& context,
                           const Constraints& constraints) const override;
    void Layout(const LayoutContext& context) override;
 
    void AddFixed(int size);
    void AddStretch();
 
public:
    class Fixed : public Widget {
    public:
        Fixed(int size, Dir dir);
        Size CalcPreferredSize(const LayoutContext& context,
                               const Constraints& constraints) const override;
 
    private:
        int size_;
        Dir dir_;
    };
 
    class Stretch : public Widget {
        Size CalcPreferredSize(const LayoutContext& context,
                               const Constraints& constraints) const override;
    };
 
protected:
    int GetMinorAxisPreferredSize() const;
    void SetMinorAxisPreferredSize(int size);
 
    Margins& GetMutableMargins();
    std::vector<std::shared_ptr<Widget>> GetVisibleChildren() const;
 
private:
    struct Impl;
    std::unique_ptr<Impl> impl_;
};
 
class Vert : public Layout1D {
public:
    static std::shared_ptr<Layout1D::Fixed> MakeFixed(int size);
    static std::shared_ptr<Layout1D::Stretch> MakeStretch();
 
    Vert();
    Vert(int spacing, const Margins& margins = Margins());
    Vert(int spacing,
         const Margins& margins,
         const std::vector<std::shared_ptr<Widget>>& children);
    virtual ~Vert();
 
    int GetPreferredWidth() const;
    void SetPreferredWidth(int w);
};
 
class CollapsableVert : public Vert {
    using Super = Vert;
 
public:
    CollapsableVert(const char* text);
    CollapsableVert(const char* text,
                    int spacing,
                    const Margins& margins = Margins());
    virtual ~CollapsableVert();
 
    void SetIsOpen(bool is_open);
 
    bool GetIsOpen();
 
    void SetText(const char* text);
    std::string GetText() const;
 
    FontId GetFontId() const;
    void SetFontId(FontId font_id);
 
    Size CalcPreferredSize(const LayoutContext& context,
                           const Constraints& constraints) const override;
    void Layout(const LayoutContext& context) override;
    Widget::DrawResult Draw(const DrawContext& context) override;
 
private:
    struct Impl;
    std::unique_ptr<Impl> impl_;
};
 
class ScrollableVert : public Vert {
    using Super = Vert;
 
public:
    ScrollableVert();
    ScrollableVert(int spacing, const Margins& margins = Margins());
    ScrollableVert(int spacing,
                   const Margins& margins,
                   const std::vector<std::shared_ptr<Widget>>& children);
    virtual ~ScrollableVert();
 
    Widget::DrawResult Draw(const DrawContext& context) override;
 
private:
    struct Impl;
    std::unique_ptr<Impl> impl_;
};
 
class Horiz : public Layout1D {
public:
    static std::shared_ptr<Layout1D::Fixed> MakeFixed(int size);
    static std::shared_ptr<Layout1D::Stretch> MakeStretch();
    static std::shared_ptr<Horiz> MakeCentered(std::shared_ptr<Widget> w);
 
    Horiz();
    Horiz(int spacing, const Margins& margins = Margins());
    Horiz(int spacing,
          const Margins& margins,
          const std::vector<std::shared_ptr<Widget>>& children);
    ~Horiz();
 
    int GetPreferredHeight() const;
    void SetPreferredHeight(int h);
};
 
class VGrid : public Widget {
    using Super = Widget;
 
public:
    VGrid(int num_cols, int spacing = 0, const Margins& margins = Margins());
    virtual ~VGrid();
 
    int GetSpacing() const;
    const Margins& GetMargins() const;
 
    int GetPreferredWidth() const;
    void SetPreferredWidth(int w);
 
    Size CalcPreferredSize(const LayoutContext& context,
                           const Constraints& constraints) const override;
    void Layout(const LayoutContext& context) override;
 
private:
    struct Impl;
    std::unique_ptr<Impl> impl_;
};
 
}  // namespace gui
}  // namespace visualization
}  // namespace open3d