Open3D (C++ API)  0.17.0
Data Structures | Public Types | Public Member Functions
open3d::visualization::gui::Slider Class Reference

#include <Slider.h>

Inheritance diagram for open3d::visualization::gui::Slider:
open3d::visualization::gui::Widget

Data Structures

struct  Impl
 

Public Types

enum  Type { INT , DOUBLE }
 
- Public Types inherited from open3d::visualization::gui::Widget
enum class  DrawResult { NONE , REDRAW , RELAYOUT }
 
enum class  EventResult { IGNORED , CONSUMED , DISCARD }
 

Public Member Functions

 Slider (Type type)
 
 ~Slider ()
 
int GetIntValue () const
 Returns the value of the control as an integer. More...
 
double GetDoubleValue () const
 Returns the value of the control as a double. More...
 
void SetValue (double val)
 
double GetMinimumValue () const
 
double GetMaximumValue () const
 
void SetLimits (double min_value, double max_value)
 
Size CalcPreferredSize (const LayoutContext &theme, const Constraints &constraints) const override
 
DrawResult Draw (const DrawContext &context) override
 
void SetOnValueChanged (std::function< void(double)> on_value_changed)
 Sets a function to call when the value changes because of user action. More...
 
- 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 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

- 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 ()
 

Member Enumeration Documentation

◆ Type

enum open3d::visualization::gui::Slider::Type
Enumerator
INT 
DOUBLE 

Constructor & Destructor Documentation

◆ Slider()

open3d::visualization::gui::Slider::Slider ( Type  type)
explicit

The only difference between INT and DOUBLE is that INT increments by 1.0 and coerces value to whole numbers.

◆ ~Slider()

open3d::visualization::gui::Slider::~Slider ( )

Member Function Documentation

◆ CalcPreferredSize()

Size open3d::visualization::gui::Slider::CalcPreferredSize ( const LayoutContext &  theme,
const Constraints &  constraints 
) const
overridevirtual

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

◆ Draw()

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

◆ GetDoubleValue()

double open3d::visualization::gui::Slider::GetDoubleValue ( ) const

Returns the value of the control as a double.

◆ GetIntValue()

int open3d::visualization::gui::Slider::GetIntValue ( ) const

Returns the value of the control as an integer.

◆ GetMaximumValue()

double open3d::visualization::gui::Slider::GetMaximumValue ( ) const

◆ GetMinimumValue()

double open3d::visualization::gui::Slider::GetMinimumValue ( ) const

◆ SetLimits()

void open3d::visualization::gui::Slider::SetLimits ( double  min_value,
double  max_value 
)

Sets the bounds for valid values of the widget. Values will be clamped to be within [minValue, maxValue].

◆ SetOnValueChanged()

void open3d::visualization::gui::Slider::SetOnValueChanged ( std::function< void(double)>  on_value_changed)

Sets a function to call when the value changes because of user action.

◆ SetValue()

void open3d::visualization::gui::Slider::SetValue ( double  val)

Sets the value of the control. Will not call onValueChanged, but the value will be clamped to [min, max].

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.1