|
PCL
|
A label/edit/slider compound control to edit numeric parameters. More...
#include <NumericControl.h>
Inheritance diagram for pcl::NumericControl:Public Attributes | |
| HorizontalSlider | slider |
| The Slider part of this NumericEdit control. | |
| Public Attributes inherited from pcl::NumericEdit | |
| Edit | edit |
| The Edit part of this NumericEdit control. | |
| Label | label |
| The Label part of this NumericEdit control. | |
| HorizontalSizer | sizer |
| The Sizer object of this NumericEdit control. | |
Additional Inherited Members | |
| Public Types inherited from pcl::NumericEdit | |
| using | value_event_handler = void(Control::*)(NumericEdit &sender, double value) |
| Public Types inherited from pcl::Control | |
| using | child_event_handler = void(Control::*)(Control &sender, Control &child) |
| using | close_event_handler = void(Control::*)(Control &sender, bool &allowClose) |
| using | event_handler = void(Control::*)(Control &sender) |
| using | file_drag_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const StringList &files, unsigned modifiers, bool &wantsFiles) |
| using | file_drop_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const StringList &files, unsigned modifiers) |
| using | keyboard_event_handler = void(Control::*)(Control &sender, int key, unsigned modifiers, bool &wantsKey) |
| using | mouse_button_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, int button, unsigned buttons, unsigned modifiers) |
| using | mouse_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, unsigned buttons, unsigned modifiers) |
| using | mouse_wheel_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, int delta, unsigned buttons, unsigned modifiers) |
| using | move_event_handler = void(Control::*)(Control &sender, const pcl::Point &newPos, const pcl::Point &oldPos) |
| using | paint_event_handler = void(Control::*)(Control &sender, const pcl::Rect &updateRect) |
| using | resize_event_handler = void(Control::*)(Control &sender, int newWidth, int newHeight, int oldWidth, int oldHeight) |
| using | view_drag_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const View &view, unsigned modifiers, bool &wantsView) |
| using | view_drop_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const View &view, unsigned modifiers) |
| Static Public Member Functions inherited from pcl::Control | |
| static void | HideToolTip () |
| static Control & | Null () |
| static void | ShowToolTip (const Point &pos, const String &text, const Control &control=Control::Null(), const Rect &rect=Rect(0)) |
| static void | ShowToolTip (int x, int y, const String &text, const Control &control=Control::Null(), const Rect &rect=Rect(0)) |
| static String | ToolTipText () |
| Static Public Member Functions inherited from pcl::UIObject | |
| static UIObject & | Null () |
| Protected Member Functions inherited from pcl::UIObject | |
| UIObject ()=default | |
| UIObject (const UIObject &x) | |
| UIObject (UIObject &&x) | |
| UIObject & | operator= (const UIObject &x) |
| UIObject & | operator= (UIObject &&x) |
Definition at line 380 of file NumericControl.h.
Constructs a NumericControl object as a child control of parent.
|
inlineoverride |
Destroys a NumericControl object.
Definition at line 394 of file NumericControl.h.
|
inline |
Disables the exponential slider response feature. See IsExponentialResponse() for detailed information.
Definition at line 469 of file NumericControl.h.
| void pcl::NumericControl::EnableExponentialResponse | ( | bool | enable = true | ) |
Enables the exponential slider response feature. See IsExponentialResponse() for detailed information.
If the minimum allowed control value is negative, this member function throws an Error exception: The exponential slider response feature can only be enabled when LowerBound() ≥ 0.
|
inline |
Returns true if the slider component of this NumericControl has exponential response. Returns false if the slider has the default linear response.
When exponential response is enabled, the slider defines control values following an exponential growth function of the form:
y = (1 + y0)*Exp( k*x ) - 1
where y is the current control value, y0 is the minimum allowed control value (as returned by LowerBound()), x is the current slider position normalized to the [0,1] range, and k is an automatically calculated exponential growth factor given by:
k = Ln( (1 + y1)/(1 + y0) )
where y1 is the maximum allowed control value, as returned by UpperBound().
Exponential slider response is useful for NumericControl objects used to define parameters with very large numeric ranges, such as [0,500] or [0,1000] for example. For such large ranges, one normally wants to provide finer control for low parameter values, which is impossible with a linear slider response. The exponential slider response feature is disabled by default, that is, sliders have linear response by default.
The exponential slider response feature is only available for controls where the minimum allowed value (given by LowerBound()) is greater than or equal to zero.
Definition at line 446 of file NumericControl.h.
|
overridevirtual |
Sets the range of allowed control values.
| lower | Minimum allowed control value, or lower bound. |
| upper | Maximum allowed control value, or upper bound. |
If the specified lower and upper bounds are not sorted in ascending order, this member function will swap them automatically.
If the resulting lower bound is negative, the exponential slider response feature will be implicitly disabled.
Reimplemented from pcl::NumericEdit.
1.9.1 
