PCL
Public Member Functions | Public Attributes | List of all members
pcl::NumericControl Class Reference

A label/edit/slider compound control to edit numeric parameters. More...

#include <NumericControl.h>

+ Inheritance diagram for pcl::NumericControl:

Public Member Functions

 NumericControl (Control &parent=Null())
 
 ~NumericControl () override
 
void DisableExponentialResponse (bool disable=true)
 
void EnableExponentialResponse (bool enable=true)
 
bool IsExponentialResponse () const
 
void SetRange (double lower, double upper) override
 
- Public Member Functions inherited from pcl::NumericEdit
 NumericEdit (Control &parent=Null())
 
 ~NumericEdit () override
 
void AdjustEditWidth ()
 
void DisableAutoAdjustEditWidth (bool disable=true)
 
void DisableFixedPrecision (bool disable=true)
 
void DisableFixedSign (bool disable=true)
 
void DisableScientificNotation (bool disable=true)
 
void DisableValidatingRegExp (bool disable=true)
 
void EnableAutoAdjustEditWidth (bool enable=true)
 
void EnableFixedPrecision (bool enable=true)
 
void EnableFixedSign (bool enable=true)
 
void EnableScientificNotation (bool enable=true)
 
void EnableValidatingRegExp (bool enable=true)
 
bool IsAutoAdjustEditWidth () const
 
bool IsFixedPrecision () const
 
bool IsFixedSign () const
 
bool IsReal () const
 
bool IsScientificNotation () const
 
bool IsValidatingRegExpEnabled () const
 
double LowerBound () const
 
int MinEditWidth () const
 
void OnValueUpdated (value_event_handler, Control &)
 
int Precision () const
 
int ScientificNotationTriggerExponent () const
 
void SetInteger (bool integer=true)
 
void SetPrecision (int n)
 
void SetReal (bool real=true)
 
void SetScientificNotationTriggerExponent (int exp10)
 
void SetValue (double)
 
double UpperBound () const
 
double Value () const
 
String ValueAsString () const
 
String ValueAsString (double) const
 
- Public Member Functions inherited from pcl::Control
 Control (const Control &)=delete
 
 Control (Control &&)=delete
 
 Control (Control &parent=Null(), uint32=0)
 
 ~Control () override
 
void ActivateRealTimePreview ()
 
void ActivateTrackView ()
 
void ActivateWindow ()
 
void AdjustToContents ()
 
RGBA AlternateCanvasColor () const
 
RGBA BackgroundColor () const
 
pcl::Rect BoundsRect () const
 
void BringToFront ()
 
RGBA ButtonColor () const
 
RGBA ButtonTextColor () const
 
bool CanUpdate () const
 
RGBA CanvasColor ()
 
Control & ChildByPos (const pcl::Point &p) const
 
Control & ChildByPos (int x, int y) const
 
pcl::Rect ChildrenRect () const
 
Control & ChildToFocus () const
 
void ClearInfoText ()
 
int ClientHeight () const
 
pcl::Rect ClientRect () const
 
int ClientWidth () const
 
void ControlToLocal (const Control &, int &x, int &y) const
 
pcl::Point ControlToLocal (const Control &w, const pcl::Point &p) const
 
pcl::Cursor Cursor () const
 
void DeactivateRealTimePreview ()
 
void DeactivateTrackView ()
 
void Disable (bool disabled=true)
 
void DisableExpansion (bool horzDisable=true, bool vertDisable=true)
 
void DisableMouseTracking (bool disable=true)
 
void DisableUpdates (bool disable=true)
 
double DisplayPixelRatio () const
 
virtual void Enable (bool enabled=true)
 
void EnableExpansion (bool horzEnable=true, bool vertEnable=true)
 
void EnableMouseTracking (bool=true)
 
void EnableUpdates (bool enable=true)
 
void EnsureLayoutUpdated ()
 
void EnsureUnique () override
 
void Focus (bool focus=true)
 
Control & FocusedChild () const
 
FocusStyles FocusStyle () const
 
pcl::Font Font () const
 
RGBA ForegroundColor () const
 
int FrameHeight () const
 
pcl::Rect FrameRect () const
 
int FrameWidth () const
 
pcl::Cursor GetCursor () const
 
pcl::Font GetFont () const
 
void GetMaxSize (int &w, int &h) const
 
void GetMinSize (int &w, int &h) const
 
void GetScaledMaxSize (int &w, int &h) const
 
void GetScaledMinSize (int &w, int &h) const
 
pcl::Sizer GetSizer () const
 
pcl::Point GlobalToLocal (const pcl::Point &p) const
 
void GlobalToLocal (int &x, int &y) const
 
int Height () const
 
void Hide ()
 
RGBA HighlightColor () const
 
RGBA HighlightedTextColor () const
 
String InfoText () const
 
bool IsActiveWindow () const
 
bool IsAncestorOf (const Control &) const
 
virtual bool IsEnabled () const
 
bool IsFixedHeight () const
 
bool IsFixedWidth () const
 
bool IsFocused () const
 
bool IsHidden () const
 
bool IsHorizontalExpansionEnabled () const
 
bool IsMaximized () const
 
bool IsMinimized () const
 
bool IsModal () const
 
bool IsMouseTrackingEnabled () const
 
bool IsRealTimePreviewActive () const
 
bool IsTrackViewActive () const
 
bool IsUnderMouse () const
 
bool IsVerticalExpansionEnabled () const
 
bool IsVisible () const
 
bool IsWindow () const
 
void LocalToControl (const Control &, int &x, int &y) const
 
pcl::Point LocalToControl (const Control &w, const pcl::Point &p) const
 
pcl::Point LocalToGlobal (const pcl::Point &p) const
 
void LocalToGlobal (int &x, int &y) const
 
pcl::Point LocalToParent (const pcl::Point &p) const
 
void LocalToParent (int &x, int &y) const
 
int LogicalPixelsToPhysical (int size) const
 
int LogicalPixelsToResource (int size) const
 
int MaxHeight () const
 
int MaxWidth () const
 
int MinHeight () const
 
int MinWidth () const
 
void Move (const pcl::Point &p)
 
void Move (int x, int y)
 
Control & NextSiblingToFocus () const
 
void OnChildCreate (child_event_handler, Control &)
 
void OnChildDestroy (child_event_handler, Control &)
 
void OnClose (close_event_handler, Control &)
 
void OnDestroy (event_handler, Control &)
 
void OnEnter (event_handler, Control &)
 
void OnFileDrag (file_drag_event_handler, Control &)
 
void OnFileDrop (file_drop_event_handler, Control &)
 
void OnGetFocus (event_handler, Control &)
 
void OnHide (event_handler, Control &)
 
void OnKeyPress (keyboard_event_handler, Control &)
 
void OnKeyRelease (keyboard_event_handler, Control &)
 
void OnLeave (event_handler, Control &)
 
void OnLoseFocus (event_handler, Control &)
 
void OnMouseDoubleClick (mouse_event_handler, Control &)
 
void OnMouseMove (mouse_event_handler, Control &)
 
void OnMousePress (mouse_button_event_handler, Control &)
 
void OnMouseRelease (mouse_button_event_handler, Control &)
 
void OnMouseWheel (mouse_wheel_event_handler, Control &)
 
void OnMove (move_event_handler, Control &)
 
void OnPaint (paint_event_handler, Control &)
 
void OnResize (resize_event_handler, Control &)
 
void OnShow (event_handler, Control &)
 
void OnViewDrag (view_drag_event_handler, Control &)
 
void OnViewDrop (view_drop_event_handler, Control &)
 
Control & operator= (const Control &)=delete
 
Control & operator= (Control &&)=delete
 
Control & Parent () const
 
pcl::Point ParentToLocal (const pcl::Point &p) const
 
void ParentToLocal (int &x, int &y) const
 
int PhysicalPixelsToLogical (int size) const
 
pcl::Point Position () const
 
void Repaint ()
 
void Repaint (const pcl::Rect &r)
 
void Repaint (int x0, int y0, int x1, int y1)
 
void Resize (int w, int h)
 
double ResourcePixelRatio () const
 
int ResourcePixelsToLogical (int size) const
 
void Restyle ()
 
Point ScaledCursorHotSpot (const Point &hotSpot) const
 
Point ScaledCursorHotSpot (int xHot, int yHot) const
 
int ScaledMaxHeight () const
 
int ScaledMaxWidth () const
 
int ScaledMinHeight () const
 
int ScaledMinWidth () const
 
template<class R >
String ScaledResource (R resource) const
 
template<class S >
String ScaledStyleSheet (S cssCode, int fontDPI=0) const
 
void Scroll (const pcl::Point &d)
 
void Scroll (const pcl::Point &d, const pcl::Rect &r)
 
void Scroll (int dx, int dy)
 
void Scroll (int dx, int dy, int x0, int y0, int x1, int y1)
 
void SendToBack ()
 
void SetAlternateCanvasColor (RGBA)
 
void SetBackgroundColor (RGBA)
 
void SetButtonColor (RGBA)
 
void SetButtonTextColor (RGBA)
 
void SetCanvasColor (RGBA)
 
void SetChildToFocus (Control &)
 
void SetClientRect (const pcl::Rect &r)
 
void SetClientRect (int x0, int y0, int x1, int y1)
 
void SetCursor (const pcl::Cursor &)
 
void SetCursorToParent ()
 
void SetFixedHeight ()
 
void SetFixedHeight (int h)
 
void SetFixedSize ()
 
void SetFixedSize (int w, int h)
 
void SetFixedWidth ()
 
void SetFixedWidth (int w)
 
void SetFocusStyle (FocusStyles)
 
void SetFont (const pcl::Font &)
 
void SetForegroundColor (RGBA)
 
void SetHighlightColor (RGBA)
 
void SetHighlightedTextColor (RGBA)
 
void SetInfoText (const String &)
 
void SetMaxHeight ()
 
void SetMaxHeight (int h)
 
void SetMaxSize ()
 
void SetMaxSize (int w, int h)
 
void SetMaxWidth ()
 
void SetMaxWidth (int w)
 
void SetMinHeight ()
 
void SetMinHeight (int h)
 
void SetMinSize ()
 
void SetMinSize (int w, int h)
 
void SetMinWidth ()
 
void SetMinWidth (int w)
 
void SetNextSiblingToFocus (Control &)
 
void SetParent (Control &)
 
void SetRealTimePreviewActive (bool=true)
 
void SetScaledFixedHeight (int h)
 
void SetScaledFixedSize (int w, int h)
 
void SetScaledFixedWidth (int w)
 
void SetScaledMaxHeight (int h)
 
void SetScaledMaxSize (int w, int h)
 
void SetScaledMaxWidth (int w)
 
void SetScaledMinHeight (int h)
 
void SetScaledMinSize (int w, int h)
 
void SetScaledMinWidth (int w)
 
void SetSizer (pcl::Sizer &)
 
void SetStyleSheet (const String &css)
 
void SetTextColor (RGBA)
 
void SetToolTip (const String &)
 
void SetTrackViewActive (bool=true)
 
void SetVariableHeight ()
 
void SetVariableSize ()
 
void SetVariableWidth ()
 
void SetVisible (bool visible)
 
void SetWindowOpacity (double)
 
void SetWindowTitle (const String &)
 
void Show ()
 
pcl::Sizer Sizer () const
 
void StackUnder (Control &)
 
String StyleSheet () const
 
RGBA TextColor () const
 
String ToolTip () const
 
void Unfocus ()
 
void Update ()
 
void Update (const pcl::Rect &r)
 
void Update (int x0, int y0, int x1, int y1)
 
pcl::Rect VisibleRect () const
 
int Width () const
 
Control & Window () const
 
double WindowOpacity () const
 
String WindowTitle () const
 
int X () const
 
int Y () const
 
- Public Member Functions inherited from pcl::UIObject
virtual ~UIObject () noexcept(false)
 
bool IsAlias () const
 
bool IsGarbage () const
 
bool IsNull () const
 
bool IsSameObject (const UIObject &o) const
 
bool IsUnique () const
 
String ObjectId () const
 
IsoString ObjectType () const
 
bool operator< (const UIObject &o) const
 
bool operator== (const UIObject &o) const
 
size_type RefCount () const
 
void SetObjectId (const String &id)
 

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)
 

Detailed Description

TODO: Write a detailed description for NumericControl.

Definition at line 380 of file NumericControl.h.

Constructor & Destructor Documentation

◆ NumericControl()

pcl::NumericControl::NumericControl ( Control &  parent = Null())

Constructs a NumericControl object as a child control of parent.

◆ ~NumericControl()

pcl::NumericControl::~NumericControl ( )
inlineoverride

Destroys a NumericControl object.

Definition at line 394 of file NumericControl.h.

Member Function Documentation

◆ DisableExponentialResponse()

void pcl::NumericControl::DisableExponentialResponse ( bool  disable = true)
inline

Disables the exponential slider response feature. See IsExponentialResponse() for detailed information.

See also
IsExponentialResponse(), EnableExponentialResponse()

Definition at line 469 of file NumericControl.h.

◆ EnableExponentialResponse()

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.

See also
IsExponentialResponse(), DisableExponentialResponse()

◆ IsExponentialResponse()

bool pcl::NumericControl::IsExponentialResponse ( ) const
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.

See also
EnableExponentialResponse(), DisableExponentialResponse()

Definition at line 446 of file NumericControl.h.

◆ SetRange()

void pcl::NumericControl::SetRange ( double  lower,
double  upper 
)
overridevirtual

Sets the range of allowed control values.

Parameters
lowerMinimum allowed control value, or lower bound.
upperMaximum 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.

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