VCV Rack API v2
No Matches
rack::widget::TransformWidget Struct Reference

Transforms appearance only, not positions of events. More...

#include <TransformWidget.hpp>

Inheritance diagram for rack::widget::TransformWidget:
Collaboration diagram for rack::widget::TransformWidget:

Public Member Functions

 TransformWidget ()
void identity ()
void translate (math::Vec delta)
void rotate (float angle)
void rotate (float angle, math::Vec origin)
void scale (math::Vec s)
void draw (const DrawArgs &args) override
 Draws the widget to the NanoVG context.
void drawLayer (const DrawArgs &args, int layer) override
 Draw additional layers.
- 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 DEPRECATED void draw (NVGcontext *vg)
 Override draw(const DrawArgs &args) instead.
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

float transform [6]
 The transformation matrix.
- 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

Detailed Description

Transforms appearance only, not positions of events.

Constructor & Destructor Documentation

◆ TransformWidget()

rack::widget::TransformWidget::TransformWidget ( )

Member Function Documentation

◆ identity()

void rack::widget::TransformWidget::identity ( )

◆ translate()

void rack::widget::TransformWidget::translate ( math::Vec delta)

◆ rotate() [1/2]

void rack::widget::TransformWidget::rotate ( float angle)

◆ rotate() [2/2]

void rack::widget::TransformWidget::rotate ( float angle,
math::Vec origin )

◆ scale()

void rack::widget::TransformWidget::scale ( math::Vec s)

◆ draw()

void rack::widget::TransformWidget::draw ( const DrawArgs & args)

Draws the widget to the NanoVG context.

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

Reimplemented from rack::widget::Widget.

◆ drawLayer()

void rack::widget::TransformWidget::drawLayer ( const DrawArgs & args,
int layer )

Draw additional layers.

Custom widgets may draw its children multiple times on different layers, passing an arbitrary layer number each time. Layer 0 calls children's draw(). When overriding, always wrap draw commands in if (layer == ...) {} to avoid drawing on all layers. When overriding, call the superclass's drawLayer(args, layer) to recurse to children.

Reimplemented from rack::widget::Widget.

Member Data Documentation

◆ transform

float rack::widget::TransformWidget::transform[6]

The transformation matrix.

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