#include <Button.h>

Inheritance diagram for open3d::visualization::gui::Button:

Data Structures
struct	Impl

Public Member Functions
	Button (const char *title)

	Button (std::shared_ptr< UIImage > image)

	~Button ()

const char *	GetText () const

void	SetText (const char *text)
	Sets the text of the button. Do not call if this is an image button. More...

float	GetHorizontalPaddingEm () const
	Returns the padding, in units of ems. More...

float	GetVerticalPaddingEm () const

void	SetPaddingEm (float horiz_ems, float vert_ems)

bool	GetIsToggleable () const

void	SetToggleable (bool toggles)

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()> 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 Rect &	GetFrame () const
	Returns the frame size in pixels. More...

virtual void	SetFrame (const Rect &f)

virtual const Color &	GetBackgroundColor () 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

◆ Button() [1/2]

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

explicit

◆ Button() [2/2]

open3d::visualization::gui::Button::Button ( std::shared_ptr< UIImage > image )

explicit

◆ ~Button()

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

Member Function Documentation

◆ CalcPreferredSize()

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

overridevirtual

Reimplemented from open3d::visualization::gui::Widget.

Reimplemented in open3d::visualization::SmallButton.

◆ Draw()

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

◆ GetHorizontalPaddingEm()

float open3d::visualization::gui::Button::GetHorizontalPaddingEm ( ) const

Returns the padding, in units of ems.

◆ GetIsOn()

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

◆ GetIsToggleable()

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

◆ GetText()

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

Returns the text of the button. If the button is an image, will return "".

◆ GetVerticalPaddingEm()

float open3d::visualization::gui::Button::GetVerticalPaddingEm ( ) const

◆ SetOn()

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

◆ SetOnClicked()

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

◆ SetPaddingEm()

void open3d::visualization::gui::Button::SetPaddingEm	(	float	horiz_ems,
		float	vert_ems
	)

Sets the padding, in units of ems. Note that for text buttons, a padding of (0, 0) will not actually give a padding of 0, there will be a small padding because having zero padding looks horrible and because this way a vertical padding of zero is exactly the same size as a text row, which means the button is the same size as the the other text-based widgets, so it will look nice with them.

◆ SetText()

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

Sets the text of the button. Do not call if this is an image button.

◆ SetToggleable()

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

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

/home/runner/work/Open3D/Open3D/cpp/open3d/visualization/gui/Button.h (252c867 (Sun May 5 05:39:34 2024 +0000))
/home/runner/work/Open3D/Open3D/cpp/open3d/visualization/gui/Button.cpp (252c867 (Sun May 5 05:39:34 2024 +0000))

Data Structures

Public Member Functions

Additional Inherited Members