Rhino C++ API  9.0
Public Member Functions | List of all members
CRhinoUserInterfaceSlider Class Reference

#include <rhinoSdkUserInterfaceObject.h>

Inheritance diagram for CRhinoUserInterfaceSlider:
CRhinoUserInterfaceControl CRhinoUserInterfaceObject

Public Member Functions

 CRhinoUserInterfaceSlider ()
 
 ~CRhinoUserInterfaceSlider ()
 
bool AllowValueAfterRangeEnd () const
 
bool AllowValueBeforeRangeStart () const
 
ON_4dRect ComputedRect (const CRhinoView *view, bool logicalPixels) const override
 
ON_2fSize ComputeSize () const override
 
int DigitPrecision () const
 
bool DisplayValue () const
 
void Draw (CRhinoDisplayPipeline &dp) override
 
void EnableValueDisplay (bool on)
 
bool HorizontalOrientation () const
 
bool IsMouseOver (const CRhinoMouseEventArgs &mouse) override
 
void OnMouseDown (const CRhinoMouseEventArgs &mouse) override
 
void OnMouseEnter (const CRhinoMouseEventArgs &mouse) override
 
void OnMouseLeave (const CRhinoMouseEventArgs &mouse) override
 
void OnMouseMove (const CRhinoMouseEventArgs &mouse) override
 
void OnMouseUp (const CRhinoMouseEventArgs &mouse) override
 
virtual void OnValueChanged ()
 
ON_Interval Range () const
 
void SetAllowValueAfterRangeEnd (bool enable)
 
void SetAllowValueBeforeRangeStart (bool enable)
 
void SetDigitPrecision (int digits)
 
void SetOrientation (bool horizontal)
 
void SetRange (const ON_Interval &range)
 
void SetValue (double value)
 
double Value () const
 
ON_wString ValueAsFormattedString () const
 
- Public Member Functions inherited from CRhinoUserInterfaceControl
 CRhinoUserInterfaceControl ()
 
virtual ~CRhinoUserInterfaceControl ()
 
void GetAlignment (ControlHorizontalAlignment &h, ControlVerticalAlignment &v) const
 
const ON_wStringImageSVG () const
 
ON_2fPoint Location () const
 
void SetAlignment (ControlHorizontalAlignment h, ControlVerticalAlignment v)
 
void SetImageSVG (const wchar_t *svg)
 
void SetLocation (float x, float y)
 
void SetLocation (ON_2fPoint location)
 
void SetLocation (ON_2fPoint location, ControlHorizontalAlignment hAlign, ControlVerticalAlignment vAlign)
 
void SetSize (const ON_2fSize &size)
 
void SetSize (float width, float height)
 
void SetText (const wchar_t *text)
 
void SetTrackingPoint (const ON_3dPoint &pt)
 
ON_2fSize Size () const
 
const ON_wStringText () const
 
ON_3dPoint TrackingPoint () const
 
- Public Member Functions inherited from CRhinoUserInterfaceObject
 CRhinoUserInterfaceObject ()
 
virtual ~CRhinoUserInterfaceObject ()
 
void Animate (CRhinoAnimatingDouble &value, double target, double duration, AnimationStyle style, CRhinoDoc *doc)
 
void BindToActiveViewport (bool on)
 
void BindToViewport (unsigned int viewport_sn)
 
virtual double CameraDepth (const ON_Plane &cameraPlane) const
 
int DisplayOrder () const
 
ON_UUID DocumentGroupId () const
 
unsigned int DocumentRuntimeSerialNumber () const
 
bool GetData (const wchar_t *key, bool &value) const
 
bool GetData (const wchar_t *key, double &value) const
 
bool GetData (const wchar_t *key, int &value) const
 
bool GetData (const wchar_t *key, ON_UUID &value) const
 
bool GetData (const wchar_t *key, ON_wString &value) const
 
bool HasMouseCapture () const
 
bool IsBoundToActiveViewport () const
 
unsigned int IsBoundToViewport () const
 
virtual void OnMouseClick (const CRhinoMouseEventArgs &mouse)
 
virtual void OnMouseDoubleClick (const CRhinoMouseEventArgs &mouse)
 
virtual void OnMouseWheel (const CRhinoMouseEventArgs &mouse, int delta)
 
virtual CRhinoCommand::result OnRunCommand (const CRhinoCommandContext &context, const CRhinoMouseEventArgs &mouse)
 
virtual void OnTrackpadScroll (const CRhinoMouseEventArgs &mouse, double horizontal, double vertical)
 
CRhinoUserInterfaceObjectParent ()
 
const CRhinoUserInterfaceObjectParent () const
 
bool ReceivesMouseWheelEvents () const
 
bool ReceivesTrackpadScrollEvents () const
 
bool RegisterForAllDocuments ()
 
void RunCommand (const CRhinoMouseEventArgs &mouse)
 
unsigned int RuntimeSerialNumber () const
 
void SetCursor (HCURSOR cursor)
 
void SetData (const wchar_t *key, bool value)
 
void SetData (const wchar_t *key, const wchar_t *value)
 
void SetData (const wchar_t *key, double value)
 
void SetData (const wchar_t *key, int value)
 
void SetData (const wchar_t *key, ON_UUID value)
 
void SetDisplayOrder (int order)
 
void SetReceivesMouseWheelEvents (bool enable)
 
void SetReceivesTrackpadScrollEvents (bool enable)
 
void SetTooltip (const wchar_t *tooltip)
 
void SetVisible (bool visible)
 
bool UnregisterFromAllDocuments ()
 
bool Visible () const
 

Additional Inherited Members

- Protected Member Functions inherited from CRhinoUserInterfaceObject
virtual void ContinueAnimate (CRhinoDoc *doc)
 
void SetMouseCapture (CRhinoDoc *doc)
 
- Protected Attributes inherited from CRhinoUserInterfaceControl
class CRhUserInterfaceControlPrivate * m_ui_control_private = nullptr
 
- Protected Attributes inherited from CRhinoUserInterfaceObject
class CRhUserInterfaceObjectPrivatem_private = nullptr
 

Constructor & Destructor Documentation

◆ CRhinoUserInterfaceSlider()

CRhinoUserInterfaceSlider::CRhinoUserInterfaceSlider ( )

◆ ~CRhinoUserInterfaceSlider()

CRhinoUserInterfaceSlider::~CRhinoUserInterfaceSlider ( )

Member Function Documentation

◆ AllowValueAfterRangeEnd()

bool CRhinoUserInterfaceSlider::AllowValueAfterRangeEnd ( ) const

◆ AllowValueBeforeRangeStart()

bool CRhinoUserInterfaceSlider::AllowValueBeforeRangeStart ( ) const

◆ ComputedRect()

ON_4dRect CRhinoUserInterfaceSlider::ComputedRect ( const CRhinoView view,
bool  logicalPixels 
) const
overridevirtual

Description: Compute the location and size of this control in the coordinates of a view. Parameters: view - the view to use for computing location and size inside of. The same control can be in different locations for different views due to how the control is aligned in the view or if it is tracking a 3d point logicalPixels - should the rectangle be return in device or logical pixels

Reimplemented from CRhinoUserInterfaceControl.

◆ ComputeSize()

ON_2fSize CRhinoUserInterfaceSlider::ComputeSize ( ) const
overridevirtual

Description: Compute the size of this control in logical pixels.

Reimplemented from CRhinoUserInterfaceControl.

◆ DigitPrecision()

int CRhinoUserInterfaceSlider::DigitPrecision ( ) const

◆ DisplayValue()

bool CRhinoUserInterfaceSlider::DisplayValue ( ) const

◆ Draw()

void CRhinoUserInterfaceSlider::Draw ( CRhinoDisplayPipeline dp)
overridevirtual

Description: All user interface objects must implement a Draw function. This is where drawing using the input display pipeline is performed. The base class Draw function does nothing.

Reimplemented from CRhinoUserInterfaceObject.

◆ EnableValueDisplay()

void CRhinoUserInterfaceSlider::EnableValueDisplay ( bool  on)

◆ HorizontalOrientation()

bool CRhinoUserInterfaceSlider::HorizontalOrientation ( ) const

Description: Sliders can be either horizontal or vertically oriented

◆ IsMouseOver()

bool CRhinoUserInterfaceSlider::IsMouseOver ( const CRhinoMouseEventArgs mouse)
overridevirtual

Description: Return true if the input mouse is considered to be over this object

Reimplemented from CRhinoUserInterfaceObject.

◆ OnMouseDown()

void CRhinoUserInterfaceSlider::OnMouseDown ( const CRhinoMouseEventArgs mouse)
overridevirtual

Description: Called when a mouse button goes down over this UI element Parameters: mouse - mouse position, button and view

Reimplemented from CRhinoUserInterfaceObject.

◆ OnMouseEnter()

void CRhinoUserInterfaceSlider::OnMouseEnter ( const CRhinoMouseEventArgs mouse)
overridevirtual

Description: Called when first goes over this object (IsMouseOver returns true)

Reimplemented from CRhinoUserInterfaceObject.

◆ OnMouseLeave()

void CRhinoUserInterfaceSlider::OnMouseLeave ( const CRhinoMouseEventArgs mouse)
overridevirtual

Description: Called when mouse leaves this object (IsMouseOver returns false)

Reimplemented from CRhinoUserInterfaceObject.

◆ OnMouseMove()

void CRhinoUserInterfaceSlider::OnMouseMove ( const CRhinoMouseEventArgs mouse)
overridevirtual

Description: Called when a mouse moves over this UI element Parameters: mouse - mouse position, button and view

Reimplemented from CRhinoUserInterfaceObject.

◆ OnMouseUp()

void CRhinoUserInterfaceSlider::OnMouseUp ( const CRhinoMouseEventArgs mouse)
overridevirtual

Description: Called when a mouse button goes up over this UI element Parameters: mouse - mouse position, button and view

Reimplemented from CRhinoUserInterfaceObject.

◆ OnValueChanged()

virtual void CRhinoUserInterfaceSlider::OnValueChanged ( )
virtual

◆ Range()

ON_Interval CRhinoUserInterfaceSlider::Range ( ) const

◆ SetAllowValueAfterRangeEnd()

void CRhinoUserInterfaceSlider::SetAllowValueAfterRangeEnd ( bool  enable)

◆ SetAllowValueBeforeRangeStart()

void CRhinoUserInterfaceSlider::SetAllowValueBeforeRangeStart ( bool  enable)

◆ SetDigitPrecision()

void CRhinoUserInterfaceSlider::SetDigitPrecision ( int  digits)

◆ SetOrientation()

void CRhinoUserInterfaceSlider::SetOrientation ( bool  horizontal)

◆ SetRange()

void CRhinoUserInterfaceSlider::SetRange ( const ON_Interval range)

◆ SetValue()

void CRhinoUserInterfaceSlider::SetValue ( double  value)

◆ Value()

double CRhinoUserInterfaceSlider::Value ( ) const

◆ ValueAsFormattedString()

ON_wString CRhinoUserInterfaceSlider::ValueAsFormattedString ( ) const