Open3D (C++ API): open3d::visualization::gui::MenuBase Class Reference

Open3D (C++ API) 0.18.0+5c982c7

#include <MenuBase.h>

Inheritance diagram for open3d::visualization::gui::MenuBase:

Public Types
using	ItemId = int

Public Member Functions
	MenuBase ()

virtual	~MenuBase ()

virtual void	AddItem (const char *name, ItemId item_id=NO_ITEM, KeyName key=KEY_NONE)=0

virtual void	AddMenu (const char *name, std::shared_ptr< MenuBase > submenu)=0

virtual void	AddSeparator ()=0

virtual void	InsertItem (int index, const char *name, ItemId item_id=NO_ITEM, KeyName key=KEY_NONE)=0

virtual void	InsertMenu (int index, const char *name, std::shared_ptr< MenuBase > submenu)=0

virtual void	InsertSeparator (int index)=0

virtual int	GetNumberOfItems () const =0

virtual bool	IsEnabled (ItemId item_id) const =0

virtual void	SetEnabled (ItemId item_id, bool enabled)=0

virtual bool	IsChecked (ItemId item_id) const =0

virtual void	SetChecked (ItemId item_id, bool checked)=0

virtual int	CalcHeight (const Theme &theme) const =0

virtual bool	CheckVisibilityChange () const =0
	Returns true if submenu visibility changed on last call to DrawMenuBar. More...

virtual ItemId	DrawMenuBar (const DrawContext &context, bool is_enabled)=0

virtual ItemId	Draw (const DrawContext &context, const char *name, bool is_enabled)=0

virtual void *	GetNativePointer ()=0

Static Public Attributes
static constexpr ItemId	NO_ITEM = -1

Detailed Description

The menu item action is handled by Window, rather than by registering a a callback function with (non-existent) Menu::SetOnClicked(). This is because on macOS the menubar is global over all application windows, so any callback would need to go find the data object corresponding to the active window.

Member Typedef Documentation

◆ ItemId

using open3d::visualization::gui::MenuBase::ItemId = int

Constructor & Destructor Documentation

◆ MenuBase()

open3d::visualization::gui::MenuBase::MenuBase ( )

inline

◆ ~MenuBase()

virtual open3d::visualization::gui::MenuBase::~MenuBase ( )

inlinevirtual

Member Function Documentation

◆ AddItem()

virtual void open3d::visualization::gui::MenuBase::AddItem	(	const char *	name,
		ItemId	item_id = `NO_ITEM`,
		KeyName	key = `KEY_NONE`
	)

pure virtual

Implemented in open3d::visualization::gui::MenuMacOS, open3d::visualization::gui::MenuImgui, and open3d::visualization::gui::Menu.

◆ AddMenu()

virtual void open3d::visualization::gui::MenuBase::AddMenu	(	const char *	name,
		std::shared_ptr< MenuBase >	submenu
	)

pure virtual

Implemented in open3d::visualization::gui::MenuMacOS, open3d::visualization::gui::MenuImgui, and open3d::visualization::gui::Menu.

◆ AddSeparator()

virtual void open3d::visualization::gui::MenuBase::AddSeparator ( )

pure virtual

Implemented in open3d::visualization::gui::MenuMacOS, open3d::visualization::gui::MenuImgui, and open3d::visualization::gui::Menu.

◆ CalcHeight()

virtual int open3d::visualization::gui::MenuBase::CalcHeight ( const Theme & theme ) const

pure virtual

Implemented in open3d::visualization::gui::MenuMacOS, open3d::visualization::gui::MenuImgui, and open3d::visualization::gui::Menu.

◆ CheckVisibilityChange()

virtual bool open3d::visualization::gui::MenuBase::CheckVisibilityChange ( ) const

pure virtual

Returns true if submenu visibility changed on last call to DrawMenuBar.

Implemented in open3d::visualization::gui::MenuMacOS, open3d::visualization::gui::MenuImgui, and open3d::visualization::gui::Menu.

◆ Draw()

virtual ItemId open3d::visualization::gui::MenuBase::Draw	(	const DrawContext &	context,
		const char *	name,
		bool	is_enabled
	)

pure virtual

Implemented in open3d::visualization::gui::MenuMacOS, open3d::visualization::gui::MenuImgui, and open3d::visualization::gui::Menu.

◆ DrawMenuBar()

virtual ItemId open3d::visualization::gui::MenuBase::DrawMenuBar	(	const DrawContext &	context,
		bool	is_enabled
	)

pure virtual

Implemented in open3d::visualization::gui::MenuMacOS, open3d::visualization::gui::MenuImgui, and open3d::visualization::gui::Menu.

◆ GetNativePointer()

virtual void* open3d::visualization::gui::MenuBase::GetNativePointer ( )

pure virtual

Implemented in open3d::visualization::gui::MenuMacOS, open3d::visualization::gui::MenuImgui, and open3d::visualization::gui::Menu.

◆ GetNumberOfItems()

virtual int open3d::visualization::gui::MenuBase::GetNumberOfItems ( ) const

pure virtual

Implemented in open3d::visualization::gui::MenuMacOS, open3d::visualization::gui::MenuImgui, and open3d::visualization::gui::Menu.

◆ InsertItem()

virtual void open3d::visualization::gui::MenuBase::InsertItem	(	int	index,
		const char *	name,
		ItemId	item_id = `NO_ITEM`,
		KeyName	key = `KEY_NONE`
	)

pure virtual

Implemented in open3d::visualization::gui::MenuMacOS, open3d::visualization::gui::MenuImgui, and open3d::visualization::gui::Menu.

◆ InsertMenu()

virtual void open3d::visualization::gui::MenuBase::InsertMenu	(	int	index,
		const char *	name,
		std::shared_ptr< MenuBase >	submenu
	)

pure virtual

Implemented in open3d::visualization::gui::MenuMacOS, open3d::visualization::gui::MenuImgui, and open3d::visualization::gui::Menu.

◆ InsertSeparator()

virtual void open3d::visualization::gui::MenuBase::InsertSeparator ( int index )

pure virtual

Implemented in open3d::visualization::gui::MenuMacOS, open3d::visualization::gui::MenuImgui, and open3d::visualization::gui::Menu.

◆ IsChecked()

virtual bool open3d::visualization::gui::MenuBase::IsChecked ( ItemId item_id ) const

pure virtual

Implemented in open3d::visualization::gui::MenuMacOS, open3d::visualization::gui::MenuImgui, and open3d::visualization::gui::Menu.

◆ IsEnabled()

virtual bool open3d::visualization::gui::MenuBase::IsEnabled ( ItemId item_id ) const

pure virtual

Searches the menu hierarchy down from this menu to find the item and returns true if the item is enabled.

Implemented in open3d::visualization::gui::MenuMacOS, open3d::visualization::gui::MenuImgui, and open3d::visualization::gui::Menu.

◆ SetChecked()

virtual void open3d::visualization::gui::MenuBase::SetChecked	(	ItemId	item_id,
		bool	checked
	)

pure virtual

Implemented in open3d::visualization::gui::MenuMacOS, open3d::visualization::gui::MenuImgui, and open3d::visualization::gui::Menu.

◆ SetEnabled()

virtual void open3d::visualization::gui::MenuBase::SetEnabled	(	ItemId	item_id,
		bool	enabled
	)

pure virtual

Searches the menu hierarchy down from this menu to find the item and set it enabled according to enabled.

Implemented in open3d::visualization::gui::MenuMacOS, open3d::visualization::gui::MenuImgui, and open3d::visualization::gui::Menu.

Field Documentation

◆ NO_ITEM

constexpr ItemId open3d::visualization::gui::MenuBase::NO_ITEM = -1

staticconstexpr

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

/home/runner/work/Open3D/Open3D/cpp/open3d/visualization/gui/MenuBase.h (5c982c7 (Thu Apr 18 12:15:13 2024 -0700))