Open3D (C++ API)  0.18.0+fcf98ee
Data Structures | Public Member Functions
open3d::visualization::gui::ToggleSwitch Class Reference

#include <ToggleSwitch.h>

Inheritance diagram for open3d::visualization::gui::ToggleSwitch:

Data Structures

struct  Impl

Public Member Functions

 ToggleSwitch (const char *title)
 ~ToggleSwitch ()
const char * GetText () const
 Returns the text of the toggle slider. More...
void SetText (const char *text)
 Sets the text of the toggle slider. More...
bool GetIsOn () const
void SetOn (bool is_on)
Size CalcPreferredSize (const LayoutContext &context, const Constraints &constraints) const override
DrawResult Draw (const DrawContext &context) override
void SetOnClicked (std::function< void(bool)> on_clicked)
- Public Member Functions inherited from open3d::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 open3d::visualization::gui::Widget
enum class  DrawResult { NONE , REDRAW , RELAYOUT }
enum class  EventResult { IGNORED , CONSUMED , DISCARD }
- Static Public Attributes inherited from open3d::visualization::gui::Widget
static constexpr int DIM_GROW = 10000
- Protected Member Functions inherited from open3d::visualization::gui::Widget
void DrawImGuiPushEnabledState ()
void DrawImGuiPopEnabledState ()
void DrawImGuiTooltip ()

Constructor & Destructor Documentation

◆ ToggleSwitch()

open3d::visualization::gui::ToggleSwitch::ToggleSwitch ( const char *  title)

◆ ~ToggleSwitch()

open3d::visualization::gui::ToggleSwitch::~ToggleSwitch ( )

Member Function Documentation

◆ CalcPreferredSize()

Size open3d::visualization::gui::ToggleSwitch::CalcPreferredSize ( const LayoutContext context,
const Constraints constraints 
) const

◆ Draw()

Widget::DrawResult open3d::visualization::gui::ToggleSwitch::Draw ( const DrawContext context)

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

◆ GetIsOn()

bool open3d::visualization::gui::ToggleSwitch::GetIsOn ( ) const

◆ GetText()

const char* open3d::visualization::gui::ToggleSwitch::GetText ( ) const

Returns the text of the toggle slider.

◆ SetOn()

void open3d::visualization::gui::ToggleSwitch::SetOn ( bool  is_on)

◆ SetOnClicked()

void open3d::visualization::gui::ToggleSwitch::SetOnClicked ( std::function< void(bool)>  on_clicked)

Sets a function that will be called when the switch is clicked on to change state. The boolean argument is true if the switch is now on and false otherwise.

◆ SetText()

void open3d::visualization::gui::ToggleSwitch::SetText ( const char *  text)

Sets the text of the toggle slider.

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