Open3D (C++ API)
Data Structures | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
open3d::gui::Layout1D Class Reference

#include <Layout.h>

Inheritance diagram for open3d::gui::Layout1D:
open3d::gui::Widget open3d::gui::Horiz open3d::gui::Vert open3d::gui::CollapsableVert

Data Structures

class  Fixed
 
struct  Impl
 
class  Stretch
 

Public Types

enum  Dir { VERT, HORIZ }
 
- Public Types inherited from open3d::gui::Widget
enum  DrawResult { DrawResult::NONE, DrawResult::REDRAW, DrawResult::RELAYOUT }
 
enum  EventResult { EventResult::IGNORED, EventResult::CONSUMED, EventResult::DISCARD }
 

Public Member Functions

 Layout1D (Dir dir, int spacing, const Margins &margins, const std::vector< std::shared_ptr< Widget >> &children)
 
virtual ~Layout1D ()
 
int GetSpacing () const
 
const MarginsGetMargins () const
 
Size CalcPreferredSize (const Theme &theme) const override
 
void Layout (const Theme &theme) override
 
void AddFixed (int size)
 Adds a fixed number of pixels after the previously added widget. More...
 
void AddStretch ()
 
- Public Member Functions inherited from open3d::gui::Widget
 Widget ()
 
 Widget (const std::vector< std::shared_ptr< Widget >> &children)
 
virtual ~Widget ()
 
void AddChild (std::shared_ptr< Widget > child)
 
const std::vector< std::shared_ptr< Widget > > GetChildren () const
 
const RectGetFrame () const
 Returns the frame size in pixels. More...
 
virtual void SetFrame (const Rect &f)
 
const ColorGetBackgroundColor () const
 
bool IsDefaultBackgroundColor () const
 
void SetBackgroundColor (const Color &color)
 
bool IsVisible () const
 
virtual void SetVisible (bool vis)
 
bool IsEnabled () const
 
virtual void SetEnabled (bool enabled)
 
virtual DrawResult Draw (const DrawContext &context)
 
virtual EventResult Mouse (const MouseEvent &e)
 
virtual EventResult Key (const KeyEvent &e)
 
virtual DrawResult Tick (const TickEvent &e)
 

Static Public Member Functions

static void debug_PrintPreferredSizes (Layout1D *layout, const Theme &theme, int depth=0)
 

Protected Member Functions

MarginsGetMutableMargins ()
 
- Protected Member Functions inherited from open3d::gui::Widget
void DrawImGuiPushEnabledState ()
 
void DrawImGuiPopEnabledState ()
 

Additional Inherited Members

- Static Public Attributes inherited from open3d::gui::Widget
static constexpr int DIM_GROW = 10000
 

Detailed Description

Lays out widgets either horizontally or vertically. Base class for Vert and Horiz.

Member Enumeration Documentation

◆ Dir

Enumerator
VERT 
HORIZ 

Constructor & Destructor Documentation

◆ Layout1D()

open3d::gui::Layout1D::Layout1D ( Dir  dir,
int  spacing,
const Margins margins,
const std::vector< std::shared_ptr< Widget >> &  children 
)

Spacing is in pixels; see the comment in Margin(). 1em is typically a good value for spacing.

◆ ~Layout1D()

open3d::gui::Layout1D::~Layout1D ( )
virtual

Member Function Documentation

◆ AddFixed()

void open3d::gui::Layout1D::AddFixed ( int  size)

Adds a fixed number of pixels after the previously added widget.

◆ AddStretch()

void open3d::gui::Layout1D::AddStretch ( )

Adds a virtual widget that takes up as much space as possible. This is useful for centering widgets: { stretch, w1, w2, stretch } or for aligning widgets to one side or the other: { stretch, ok, cancel }.

◆ CalcPreferredSize()

Size open3d::gui::Layout1D::CalcPreferredSize ( const Theme theme) const
overridevirtual

Reimplemented from open3d::gui::Widget.

Reimplemented in open3d::gui::CollapsableVert.

◆ debug_PrintPreferredSizes()

void open3d::gui::Layout1D::debug_PrintPreferredSizes ( Layout1D layout,
const Theme theme,
int  depth = 0 
)
static

◆ GetMargins()

const Margins & open3d::gui::Layout1D::GetMargins ( ) const

◆ GetMutableMargins()

Margins & open3d::gui::Layout1D::GetMutableMargins ( )
protected

◆ GetSpacing()

int open3d::gui::Layout1D::GetSpacing ( ) const

◆ Layout()

void open3d::gui::Layout1D::Layout ( const Theme theme)
overridevirtual

Reimplemented from open3d::gui::Widget.

Reimplemented in open3d::gui::CollapsableVert.


The documentation for this class was generated from the following files: