VCV Rack API v2
Loading...
Searching...
No Matches
rack::app::RackScrollWidget Struct Reference

#include <RackScrollWidget.hpp>

Inheritance diagram for rack::app::RackScrollWidget:
[legend]
Collaboration diagram for rack::app::RackScrollWidget:
[legend]

Public Member Functions

PRIVATE RackScrollWidget ()
 
PRIVATE ~RackScrollWidget ()
 
void reset ()
 
math::Vec getGridOffset ()
 Gets the top-left scroll offset in grid coordinates.
 
void setGridOffset (math::Vec gridOffset)
 
float getZoom ()
 
void setZoom (float zoom)
 Sets the zoom level, with a pivot at the center of the scroll viewport.
 
void setZoom (float zoom, math::Vec pivot)
 
void step () override
 Advances the module by one frame.
 
void draw (const DrawArgs &args) override
 Draws the widget to the NanoVG context.
 
void onHoverKey (const HoverKeyEvent &e) override
 
void onHoverScroll (const HoverScrollEvent &e) override
 
void onHover (const HoverEvent &e) override
 
void onButton (const ButtonEvent &e) override
 
- Public Member Functions inherited from rack::ui::ScrollWidget
 ScrollWidget ()
 
 ~ScrollWidget ()
 
math::Vec getScrollOffset ()
 
void scrollTo (math::Rect r)
 
math::Rect getContainerOffsetBound ()
 Returns the bound of allowed offset values in pixels.
 
math::Vec getHandleOffset ()
 Returns the handle position relative to the scrollbar.
 
math::Vec getHandleSize ()
 Returns the handle size relative to the scrollbar.
 
bool isScrolling ()
 The user is considered scrolling with the wheel until the mouse is moved.
 
void draw (const DrawArgs &args) override
 Draws the widget to the NanoVG context.
 
void step () override
 Advances the module by one frame.
 
void onHover (const HoverEvent &e) override
 
void onButton (const ButtonEvent &e) override
 
void onDragStart (const DragStartEvent &e) override
 
void onDragMove (const DragMoveEvent &e) override
 
void onHoverScroll (const HoverScrollEvent &e) override
 
void onHoverKey (const HoverKeyEvent &e) override
 
- Public Member Functions inherited from rack::widget::OpaqueWidget
void onHover (const HoverEvent &e) override
 
void onButton (const ButtonEvent &e) override
 
void onHoverKey (const HoverKeyEvent &e) override
 
void onHoverText (const HoverTextEvent &e) override
 
void onHoverScroll (const HoverScrollEvent &e) override
 
void onDragHover (const DragHoverEvent &e) override
 
void onPathDrop (const PathDropEvent &e) override
 
- Public Member Functions inherited from rack::widget::Widget
virtual ~Widget ()
 
math::Rect getBox ()
 
void setBox (math::Rect box)
 Calls setPosition() and then setSize().
 
math::Vec getPosition ()
 
void setPosition (math::Vec pos)
 Sets position and triggers RepositionEvent if position changed.
 
math::Vec getSize ()
 
void setSize (math::Vec size)
 Sets size and triggers ResizeEvent if size changed.
 
widget::WidgetgetParent ()
 
bool isVisible ()
 
void setVisible (bool visible)
 Sets visible and triggers ShowEvent or HideEvent if changed.
 
void show ()
 Makes Widget visible and triggers ShowEvent if changed.
 
void hide ()
 Makes Widget not visible and triggers HideEvent if changed.
 
void requestDelete ()
 Requests this Widget's parent to delete it in the next step().
 
virtual math::Rect getChildrenBoundingBox ()
 Returns the smallest rectangle containing this widget's children (visible and invisible) in its local coordinates.
 
virtual math::Rect getVisibleChildrenBoundingBox ()
 
bool isDescendantOf (Widget *ancestor)
 Returns whether ancestor is a parent or distant parent of this widget.
 
virtual math::Vec getRelativeOffset (math::Vec v, Widget *ancestor)
 Returns v (given in local coordinates) transformed into the coordinate system of ancestor.
 
math::Vec getAbsoluteOffset (math::Vec v)
 Returns v transformed into world/root/global/absolute coordinates.
 
virtual float getRelativeZoom (Widget *ancestor)
 Returns the zoom level in the coordinate system of ancestor.
 
float getAbsoluteZoom ()
 
virtual math::Rect getViewport (math::Rect r=math::Rect::inf())
 Returns a subset of the given Rect bounded by the box of this widget and all ancestors.
 
template<class T >
T * getAncestorOfType ()
 
template<class T >
T * getFirstDescendantOfType ()
 
bool hasChild (Widget *child)
 Checks if the given widget is a child of this widget.
 
void addChild (Widget *child)
 Adds widget to the top of the children.
 
void addChildBottom (Widget *child)
 Adds widget to the bottom of the children.
 
void addChildBelow (Widget *child, Widget *sibling)
 Adds widget directly below another widget.
 
void addChildAbove (Widget *child, Widget *sibling)
 
void removeChild (Widget *child)
 Removes widget from list of children if it exists.
 
void clearChildren ()
 Removes and deletes all child Widgets.
 
virtual void step ()
 Advances the module by one frame.
 
virtual void draw (const DrawArgs &args)
 Draws the widget to the NanoVG context.
 
virtual DEPRECATED void draw (NVGcontext *vg)
 Override draw(const DrawArgs &args) instead.
 
virtual void drawLayer (const DrawArgs &args, int layer)
 Draw additional layers.
 
void drawChild (Widget *child, const DrawArgs &args, int layer=0)
 Draws a particular child.
 
template<typename TMethod , class TEvent >
void recurseEvent (TMethod f, const TEvent &e)
 Recurses an event to all visible Widgets.
 
template<typename TMethod , class TEvent >
void recursePositionEvent (TMethod f, const TEvent &e)
 Recurses an event to all visible Widgets until it is consumed.
 
virtual void onHover (const HoverEvent &e)
 
virtual void onButton (const ButtonEvent &e)
 
virtual void onDoubleClick (const DoubleClickEvent &e)
 
virtual void onHoverKey (const HoverKeyEvent &e)
 
virtual void onHoverText (const HoverTextEvent &e)
 
virtual void onHoverScroll (const HoverScrollEvent &e)
 
virtual void onEnter (const EnterEvent &e)
 
virtual void onLeave (const LeaveEvent &e)
 
virtual void onSelect (const SelectEvent &e)
 
virtual void onDeselect (const DeselectEvent &e)
 
virtual void onSelectKey (const SelectKeyEvent &e)
 
virtual void onSelectText (const SelectTextEvent &e)
 
virtual void onDragStart (const DragStartEvent &e)
 
virtual void onDragEnd (const DragEndEvent &e)
 
virtual void onDragMove (const DragMoveEvent &e)
 
virtual void onDragHover (const DragHoverEvent &e)
 
virtual void onDragEnter (const DragEnterEvent &e)
 
virtual void onDragLeave (const DragLeaveEvent &e)
 
virtual void onDragDrop (const DragDropEvent &e)
 
virtual void onPathDrop (const PathDropEvent &e)
 
virtual void onAction (const ActionEvent &e)
 
virtual void onChange (const ChangeEvent &e)
 
virtual void onDirty (const DirtyEvent &e)
 
virtual void onReposition (const RepositionEvent &e)
 
virtual void onResize (const ResizeEvent &e)
 
virtual void onAdd (const AddEvent &e)
 
virtual void onRemove (const RemoveEvent &e)
 
virtual void onShow (const ShowEvent &e)
 
virtual void onHide (const HideEvent &e)
 
virtual void onContextCreate (const ContextCreateEvent &e)
 
virtual void onContextDestroy (const ContextDestroyEvent &e)
 
- Public Member Functions inherited from rack::WeakBase
 ~WeakBase ()
 
size_t getWeakCount ()
 

Public Attributes

Internal * internal
 
widget::ZoomWidgetzoomWidget
 
RackWidgetrackWidget
 
- Public Attributes inherited from rack::ui::ScrollWidget
Internal * internal
 
widget::Widgetcontainer
 
ScrollbarhorizontalScrollbar
 
ScrollbarverticalScrollbar
 
math::Vec offset
 
math::Rect containerBox
 
bool hideScrollbars = false
 
- Public Attributes inherited from rack::widget::Widget
math::Rect box = math::Rect(math::Vec(), math::Vec(INFINITY, INFINITY))
 Position relative to parent and size of widget.
 
Widgetparent = NULL
 Automatically set when Widget is added as a child to another Widget.
 
std::list< Widget * > children
 
bool visible = true
 Disables rendering but allow stepping.
 
bool requestedDelete = false
 If set to true, parent will delete Widget in the next step().
 
- Public Attributes inherited from rack::WeakBase
WeakHandleweakHandle = nullptr
 

Additional Inherited Members

- Public Types inherited from rack::widget::Widget
using BaseEvent = widget::BaseEvent
 

Constructor & Destructor Documentation

◆ RackScrollWidget()

PRIVATE rack::app::RackScrollWidget::RackScrollWidget ( )

◆ ~RackScrollWidget()

PRIVATE rack::app::RackScrollWidget::~RackScrollWidget ( )

Member Function Documentation

◆ reset()

void rack::app::RackScrollWidget::reset ( )

◆ getGridOffset()

math::Vec rack::app::RackScrollWidget::getGridOffset ( )

Gets the top-left scroll offset in grid coordinates.

◆ setGridOffset()

void rack::app::RackScrollWidget::setGridOffset ( math::Vec  gridOffset)

◆ getZoom()

float rack::app::RackScrollWidget::getZoom ( )

◆ setZoom() [1/2]

void rack::app::RackScrollWidget::setZoom ( float  zoom)

Sets the zoom level, with a pivot at the center of the scroll viewport.

◆ setZoom() [2/2]

void rack::app::RackScrollWidget::setZoom ( float  zoom,
math::Vec  pivot 
)

◆ step()

void rack::app::RackScrollWidget::step ( )
overridevirtual

Advances the module by one frame.

Reimplemented from rack::widget::Widget.

◆ draw()

void rack::app::RackScrollWidget::draw ( const DrawArgs args)
overridevirtual

Draws the widget to the NanoVG context.

When overriding, call the superclass's draw(args) to recurse to children.

Reimplemented from rack::widget::Widget.

◆ onHoverKey()

void rack::app::RackScrollWidget::onHoverKey ( const HoverKeyEvent e)
overridevirtual

Reimplemented from rack::widget::OpaqueWidget.

◆ onHoverScroll()

void rack::app::RackScrollWidget::onHoverScroll ( const HoverScrollEvent e)
overridevirtual

Reimplemented from rack::widget::OpaqueWidget.

◆ onHover()

void rack::app::RackScrollWidget::onHover ( const HoverEvent e)
overridevirtual

Reimplemented from rack::widget::OpaqueWidget.

◆ onButton()

void rack::app::RackScrollWidget::onButton ( const ButtonEvent e)
overridevirtual

Reimplemented from rack::widget::OpaqueWidget.

Member Data Documentation

◆ internal

Internal* rack::app::RackScrollWidget::internal

◆ zoomWidget

widget::ZoomWidget* rack::app::RackScrollWidget::zoomWidget

◆ rackWidget

RackWidget* rack::app::RackScrollWidget::rackWidget

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