ACloudViewer  3.9.4
A Modern Library for 3D Data Processing
cloudViewer::visualization::gui::Checkbox Class Reference

#include <Checkbox.h>

Inheritance diagram for cloudViewer::visualization::gui::Checkbox:
Collaboration diagram for cloudViewer::visualization::gui::Checkbox:

Classes

struct  Impl
 

Public Member Functions

 Checkbox (const char *name)
 
 ~Checkbox ()
 
bool IsChecked () const
 
void SetChecked (bool checked)
 
Size CalcPreferredSize (const LayoutContext &context, const Constraints &constraints) const override
 
DrawResult Draw (const DrawContext &context) override
 
void SetOnChecked (std::function< void(bool)> on_checked)
 
- Public Member Functions inherited from cloudViewer::visualization::gui::Widget
 Widget ()
 
 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 RectGetFrame () const
 Returns the frame size in pixels. More...
 
virtual void SetFrame (const Rect &f)
 
virtual const ColorGetBackgroundColor () 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
 
virtual Size CalcMinimumSize (const LayoutContext &context) const
 
virtual void Layout (const LayoutContext &context)
 
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 cloudViewer::visualization::gui::Widget
enum class  DrawResult { NONE , REDRAW , RELAYOUT }
 
enum class  EventResult { IGNORED , CONSUMED , DISCARD }
 
- Static Public Attributes inherited from cloudViewer::visualization::gui::Widget
static constexpr int DIM_GROW = 10000
 
- Protected Member Functions inherited from cloudViewer::visualization::gui::Widget
void DrawImGuiPushEnabledState ()
 
void DrawImGuiPopEnabledState ()
 
void DrawImGuiTooltip ()
 

Detailed Description

Definition at line 18 of file Checkbox.h.

Constructor & Destructor Documentation

◆ Checkbox()

cloudViewer::visualization::gui::Checkbox::Checkbox ( const char *  name)
explicit

Definition at line 33 of file Checkbox.cpp.

References name, and patch::to_string().

◆ ~Checkbox()

cloudViewer::visualization::gui::Checkbox::~Checkbox ( )

Definition at line 39 of file Checkbox.cpp.

Member Function Documentation

◆ CalcPreferredSize()

Size cloudViewer::visualization::gui::Checkbox::CalcPreferredSize ( const LayoutContext context,
const Constraints constraints 
) const
overridevirtual

Reimplemented from cloudViewer::visualization::gui::Widget.

Definition at line 49 of file Checkbox.cpp.

References cloudViewer::utility::ceil(), context, and height.

◆ Draw()

Widget::DrawResult cloudViewer::visualization::gui::Checkbox::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 cloudViewer::visualization::gui::Widget.

Definition at line 61 of file Checkbox.cpp.

References cloudViewer::visualization::gui::colorToImgui(), context, cloudViewer::visualization::gui::Widget::DrawImGuiPopEnabledState(), cloudViewer::visualization::gui::Widget::DrawImGuiPushEnabledState(), cloudViewer::visualization::gui::Widget::DrawImGuiTooltip(), frame, cloudViewer::visualization::gui::Widget::GetFrame(), cloudViewer::visualization::gui::Widget::NONE, cloudViewer::visualization::gui::Widget::REDRAW, result, and width.

◆ IsChecked()

bool cloudViewer::visualization::gui::Checkbox::IsChecked ( ) const

Definition at line 41 of file Checkbox.cpp.

Referenced by cloudViewer::visualization::gui::pybind_gui_classes().

◆ SetChecked()

void cloudViewer::visualization::gui::Checkbox::SetChecked ( bool  checked)

Definition at line 43 of file Checkbox.cpp.

Referenced by cloudViewer::visualization::gui::pybind_gui_classes().

◆ SetOnChecked()

void cloudViewer::visualization::gui::Checkbox::SetOnChecked ( std::function< void(bool)>  on_checked)

Specifies a callback function which will be called when the box changes checked state as a result of user action.

Definition at line 45 of file Checkbox.cpp.

Referenced by cloudViewer::visualization::gui::pybind_gui_classes().


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