Open3D (C++ API)
Data Structures | Public Member Functions
open3d::gui::Button Class Reference

#include <Button.h>

Inheritance diagram for open3d::gui::Button:
open3d::gui::Widget

Data Structures

struct  Impl
 

Public Member Functions

 Button (const char *title)
 
 ~Button ()
 
bool GetIsToggleable () const
 
void SetToggleable (bool toggles)
 
bool GetIsOn () const
 
void SetOn (bool is_on)
 
Size CalcPreferredSize (const Theme &theme) const override
 
DrawResult Draw (const DrawContext &context) override
 
void SetOnClicked (std::function< void()> on_clicked)
 
- 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 void Layout (const Theme &theme)
 
virtual EventResult Mouse (const MouseEvent &e)
 
virtual EventResult Key (const KeyEvent &e)
 
virtual DrawResult Tick (const TickEvent &e)
 

Additional Inherited Members

- Public Types inherited from open3d::gui::Widget
enum  DrawResult { DrawResult::NONE, DrawResult::REDRAW, DrawResult::RELAYOUT }
 
enum  EventResult { EventResult::IGNORED, EventResult::CONSUMED, EventResult::DISCARD }
 
- Static Public Attributes inherited from open3d::gui::Widget
static constexpr int DIM_GROW = 10000
 
- Protected Member Functions inherited from open3d::gui::Widget
void DrawImGuiPushEnabledState ()
 
void DrawImGuiPopEnabledState ()
 

Constructor & Destructor Documentation

◆ Button()

open3d::gui::Button::Button ( const char *  title)
explicit

◆ ~Button()

open3d::gui::Button::~Button ( )

Member Function Documentation

◆ CalcPreferredSize()

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

Reimplemented from open3d::gui::Widget.

◆ Draw()

Widget::DrawResult open3d::gui::Button::Draw ( const DrawContext context)
overridevirtual

Draws the widget. If this is a Dear ImGUI widget, this is where the actual event processing happens. Return NONE if no action needs to be taken, REDRAW if the widget needs to be redrawn (e.g. its value changed), and RELAYOUT if the widget wishes to change size.

Reimplemented from open3d::gui::Widget.

◆ GetIsOn()

bool open3d::gui::Button::GetIsOn ( ) const

◆ GetIsToggleable()

bool open3d::gui::Button::GetIsToggleable ( ) const

◆ SetOn()

void open3d::gui::Button::SetOn ( bool  is_on)

◆ SetOnClicked()

void open3d::gui::Button::SetOnClicked ( std::function< void()>  on_clicked)

◆ SetToggleable()

void open3d::gui::Button::SetToggleable ( bool  toggles)

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