Open3D (C++ API)
•All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Data Structures | Public Member Functions
open3d::gui::ImageLabel Class Reference

#include <ImageLabel.h>

Inheritance diagram for open3d::gui::ImageLabel:
open3d::gui::Widget

Data Structures

struct  Impl
 

Public Member Functions

 ImageLabel ()
 
 ImageLabel (const char *image_path)
 
 ImageLabel (visualization::TextureHandle texture_id, float u0=0.0f, float v0=0.0f, float u1=1.0f, float v1=1.0f)
 
 ImageLabel (std::shared_ptr< UIImage > image)
 
 ~ImageLabel ()
 
std::shared_ptr< UIImage > GetImage () const
 
void SetImage (std::shared_ptr< UIImage > image)
 
Size CalcPreferredSize (const Theme &theme) const override
 
void Layout (const Theme &theme) 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 Rect & GetFrame () const
 Returns the frame size in pixels. More...
 
virtual void SetFrame (const Rect &f)
 
const Color & GetBackgroundColor () 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 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

◆ ImageLabel() [1/4]

open3d::gui::ImageLabel::ImageLabel ( )

◆ ImageLabel() [2/4]

open3d::gui::ImageLabel::ImageLabel ( const char *  image_path)
explicit

Uses image from the specified path. Each ImageLabel will use one draw call.

◆ ImageLabel() [3/4]

open3d::gui::ImageLabel::ImageLabel ( visualization::TextureHandle  texture_id,
float  u0 = 0.0f,
float  v0 = 0.0f,
float  u1 = 1.0f,
float  v1 = 1.0f 
)
explicit

Uses an existing texture, using texture coordinates (u0, v0) to (u1, v1). Does not deallocate texture on destruction. This is useful for using an icon atlas to reduce draw calls.

◆ ImageLabel() [4/4]

open3d::gui::ImageLabel::ImageLabel ( std::shared_ptr< UIImage >  image)

◆ ~ImageLabel()

open3d::gui::ImageLabel::~ImageLabel ( )

Member Function Documentation

◆ CalcPreferredSize()

Size open3d::gui::ImageLabel::CalcPreferredSize ( const Theme &  theme) const
overridevirtual

Reimplemented from open3d::gui::Widget.

◆ Draw()

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

◆ GetImage()

std::shared_ptr<UIImage> open3d::gui::ImageLabel::GetImage ( ) const

◆ Layout()

void open3d::gui::ImageLabel::Layout ( const Theme &  theme)
overridevirtual

Reimplemented from open3d::gui::Widget.

◆ SetImage()

void open3d::gui::ImageLabel::SetImage ( std::shared_ptr< UIImage >  image)
The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.13