Open3D (C++ API)
Data Structures | Public Member Functions
open3d::gui::Label Class Reference

#include <Label.h>

Inheritance diagram for open3d::gui::Label:
open3d::gui::Widget

Data Structures

struct  Impl
 

Public Member Functions

 Label (const char *text=nullptr)
 Copies text. More...
 
 ~Label ()
 
const char * GetText () const
 
void SetText (const char *text)
 Sets the text of the label (copies text) More...
 
Color GetTextColor () const
 
void SetTextColor (const Color &color)
 
Size CalcPreferredSize (const Theme &theme) const override
 
DrawResult Draw (const DrawContext &context) override
 
- Public Member Functions inherited from open3d::gui::Widget
 Widget ()
 
 Widget (const std::vector< std::shared_ptr< Widget >> &children)
 
virtual ~Widget ()
 
void AddChild (std::shared_ptr< Widget > child)
 
const std::vector< std::shared_ptr< Widget > > GetChildren () const
 
const RectGetFrame () const
 Returns the frame size in pixels. More...
 
virtual void SetFrame (const Rect &f)
 
const ColorGetBackgroundColor () const
 
bool IsDefaultBackgroundColor () const
 
void SetBackgroundColor (const Color &color)
 
bool IsVisible () const
 
virtual void SetVisible (bool vis)
 
bool IsEnabled () const
 
virtual void SetEnabled (bool enabled)
 
virtual void Layout (const Theme &theme)
 
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::gui::Widget
enum  DrawResult { DrawResult::NONE, DrawResult::REDRAW, DrawResult::RELAYOUT }
 
enum  EventResult { EventResult::IGNORED, EventResult::CONSUMED, EventResult::DISCARD }
 
- Static Public Attributes inherited from open3d::gui::Widget
static constexpr int DIM_GROW = 10000
 
- Protected Member Functions inherited from open3d::gui::Widget
void DrawImGuiPushEnabledState ()
 
void DrawImGuiPopEnabledState ()
 

Constructor & Destructor Documentation

◆ Label()

open3d::gui::Label::Label ( const char *  text = nullptr)
explicit

Copies text.

◆ ~Label()

open3d::gui::Label::~Label ( )

Member Function Documentation

◆ CalcPreferredSize()

Size open3d::gui::Label::CalcPreferredSize ( const Theme theme) const
overridevirtual

Reimplemented from open3d::gui::Widget.

◆ Draw()

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

◆ GetText()

const char * open3d::gui::Label::GetText ( ) const

◆ GetTextColor()

Color open3d::gui::Label::GetTextColor ( ) const

◆ SetText()

void open3d::gui::Label::SetText ( const char *  text)

Sets the text of the label (copies text)

◆ SetTextColor()

void open3d::gui::Label::SetTextColor ( const Color color)

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