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

#include <Combobox.h>

Inheritance diagram for open3d::visualization::gui::Combobox:

Data Structures

struct  Impl

Public Member Functions

 Combobox ()
 Combobox (const std::vector< const char * > &items)
 ~Combobox () override
void ClearItems ()
int AddItem (const char *name)
void ChangeItem (int index, const char *name)
void ChangeItem (const char *orig_name, const char *new_name)
void RemoveItem (const char *name)
 Removes the first item matching the given text. More...
void RemoveItem (int index)
 Removes the item at index. More...
int GetNumberOfItems () const
const char * GetItem (int index) const
int GetSelectedIndex () const
const char * GetSelectedValue () const
 Returns the text of the selected value, or "" if nothing is selected. More...
void SetSelectedIndex (int index)
bool SetSelectedValue (const char *value)
Size CalcPreferredSize (const LayoutContext &context, const Constraints &constraints) const override
DrawResult Draw (const DrawContext &context) override
void SetOnValueChanged (std::function< void(const char *, int)> on_value_changed)
- 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

◆ Combobox() [1/2]

open3d::visualization::gui::Combobox::Combobox ( )

◆ Combobox() [2/2]

open3d::visualization::gui::Combobox::Combobox ( const std::vector< const char * > &  items)

◆ ~Combobox()

open3d::visualization::gui::Combobox::~Combobox ( )

Member Function Documentation

◆ AddItem()

int open3d::visualization::gui::Combobox::AddItem ( const char *  name)

Adds an item to the combobox. Its index is the order in which it is added, so the first item's index is 0, the second is 1, etc. Returns the index of the new item.

◆ CalcPreferredSize()

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

◆ ChangeItem() [1/2]

void open3d::visualization::gui::Combobox::ChangeItem ( const char *  orig_name,
const char *  new_name 

If an item exists with orig_name, it will be changed to new_name.

◆ ChangeItem() [2/2]

void open3d::visualization::gui::Combobox::ChangeItem ( int  index,
const char *  name 

Changes the item's text. index must be valid, otherwise nothing will happen.

◆ ClearItems()

void open3d::visualization::gui::Combobox::ClearItems ( )

◆ Draw()

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

◆ GetItem()

const char * open3d::visualization::gui::Combobox::GetItem ( int  index) const

Returns the text of the item at index. index must be valid.

◆ GetNumberOfItems()

int open3d::visualization::gui::Combobox::GetNumberOfItems ( ) const

◆ GetSelectedIndex()

int open3d::visualization::gui::Combobox::GetSelectedIndex ( ) const

◆ GetSelectedValue()

const char * open3d::visualization::gui::Combobox::GetSelectedValue ( ) const

Returns the text of the selected value, or "" if nothing is selected.

◆ RemoveItem() [1/2]

void open3d::visualization::gui::Combobox::RemoveItem ( const char *  name)

Removes the first item matching the given text.

◆ RemoveItem() [2/2]

void open3d::visualization::gui::Combobox::RemoveItem ( int  index)

Removes the item at index.

◆ SetOnValueChanged()

void open3d::visualization::gui::Combobox::SetOnValueChanged ( std::function< void(const char *, int)>  on_value_changed)

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

◆ SetSelectedIndex()

void open3d::visualization::gui::Combobox::SetSelectedIndex ( int  index)

Sets the selected item by index. Does not call the onValueChanged callback.

◆ SetSelectedValue()

bool open3d::visualization::gui::Combobox::SetSelectedValue ( const char *  value)

Sets the selected item by value. Does nothing if value is not an item, but will return false. Does not call the onValueChanged callback

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