open3d::visualization::gui::ListView Class Reference

#include <ListView.h>

Inheritance diagram for open3d::visualization::gui::ListView:

Data Structures
struct	Impl

Public Member Functions
	ListView ()
virtual	~ListView ()
void	SetItems (const std::vector< std::string > &items)
int	GetSelectedIndex () const
	Returns the currently selected item in the list. More...
const char *	GetSelectedValue () const
	Returns the value of the currently selected item in the list. More...
void	SetSelectedIndex (int index)
	Selects the indicated row of the list. Does not call onValueChanged. More...
void	SetMaxVisibleItems (int num)
Size	CalcPreferredSize (const LayoutContext &context, const Constraints &constraints) const override
Size	CalcMinimumSize (const LayoutContext &context) const override
DrawResult	Draw (const DrawContext &context) override
void	SetOnValueChanged (std::function< void(const char *, bool)> 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 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 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

ListView()

open3d::visualization::gui::ListView::ListView

(

)

~ListView()

open3d::visualization::gui::ListView::~ListView ( )

virtual

Member Function Documentation

CalcMinimumSize()

Size open3d::visualization::gui::ListView::CalcMinimumSize ( const LayoutContext &  context ) const

overridevirtual

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

CalcPreferredSize()

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

overridevirtual

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

Draw()

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

GetSelectedIndex()

int open3d::visualization::gui::ListView::GetSelectedIndex

(

)

const

Returns the currently selected item in the list.

GetSelectedValue()

const char * open3d::visualization::gui::ListView::GetSelectedValue

(

)

const

Returns the value of the currently selected item in the list.

SetItems()

void open3d::visualization::gui::ListView::SetItems

(

const std::vector< std::string > &

items

)

SetMaxVisibleItems()

void open3d::visualization::gui::ListView::SetMaxVisibleItems

(

int

num

)

Limit the max visible items shown to user. Set to negative number will make list extends vertically as much as possible, otherwise the list will at least show 3 items and at most show num items.

SetOnValueChanged()

void open3d::visualization::gui::ListView::SetOnValueChanged

(

std::function< void(const char *, bool)>

on_value_changed

)

Calls onValueChanged(const char *selectedText, bool isDoubleClick) when the list selection changes because of user action.

SetSelectedIndex()

void open3d::visualization::gui::ListView::SetSelectedIndex

(

int

index

)

Selects the indicated row of the list. Does not call onValueChanged.

---

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

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