rack::app::ParamWidget Struct Reference

Manages an engine::Param on a ModuleWidget. More...

#include <ParamWidget.hpp>

Inheritance diagram for rack::app::ParamWidget:

Collaboration diagram for rack::app::ParamWidget:

Public Member Functions
	ParamWidget ()
	~ParamWidget ()
virtual void	initParamQuantity ()
	Configures ParamQuantity properties based on the type of ParamWidget.
engine::ParamQuantity *	getParamQuantity ()
void	createTooltip ()
void	destroyTooltip ()
void	step () override
	Advances the module by one frame.
void	draw (const DrawArgs &args) override
	Draws the widget to the NanoVG context.
void	onButton (const ButtonEvent &e) override
void	onDoubleClick (const DoubleClickEvent &e) override
void	onEnter (const EnterEvent &e) override
void	onLeave (const LeaveEvent &e) override
void	createContextMenu ()
virtual void	appendContextMenu (ui::Menu *menu)
	Override to add custom menu items at the bottom of the parameter context menu.
void	resetAction ()
Public Member Functions inherited from rack::widget::OpaqueWidget
void	onHover (const HoverEvent &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::Widget *	getParent ()
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 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	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	onDragEnter (const DragEnterEvent &e)
virtual void	onDragLeave (const DragLeaveEvent &e)
virtual void	onDragDrop (const DragDropEvent &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
int	paramId = -1
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.
Widget *	parent = 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
WeakHandle *	weakHandle = nullptr

Additional Inherited Members
Public Types inherited from rack::widget::Widget
using	BaseEvent = widget::BaseEvent

Detailed Description

Manages an engine::Param on a ModuleWidget.

Constructor & Destructor Documentation

ParamWidget()

rack::app::ParamWidget::ParamWidget

(

)

~ParamWidget()

rack::app::ParamWidget::~ParamWidget

(

)

Member Function Documentation

initParamQuantity()

virtual void rack::app::ParamWidget::initParamQuantity ( )

inlinevirtual

Configures ParamQuantity properties based on the type of ParamWidget.

This seems a bit hacky, but it's easier than requiring plugin developers to set ParamQuantity::randomizeEnabled, etc.

Reimplemented in rack::app::Knob, and rack::app::Switch.

getParamQuantity()

engine::ParamQuantity * rack::app::ParamWidget::getParamQuantity

(

)

createTooltip()

void rack::app::ParamWidget::createTooltip

(

)

destroyTooltip()

void rack::app::ParamWidget::destroyTooltip

(

)

step()

void rack::app::ParamWidget::step ( )

overridevirtual

Advances the module by one frame.

Reimplemented from rack::widget::Widget.

Reimplemented in rack::app::Switch.

draw()

void rack::app::ParamWidget::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.

onButton()

void rack::app::ParamWidget::onButton ( const ButtonEvent & e )

overridevirtual

Reimplemented from rack::widget::OpaqueWidget.

Reimplemented in rack::app::SliderKnob.

onDoubleClick()

void rack::app::ParamWidget::onDoubleClick ( const DoubleClickEvent & e )

overridevirtual

Reimplemented from rack::widget::Widget.

Reimplemented in rack::app::Switch.

onEnter()

void rack::app::ParamWidget::onEnter ( const EnterEvent & e )

overridevirtual

Reimplemented from rack::widget::Widget.

onLeave()

void rack::app::ParamWidget::onLeave ( const LeaveEvent & e )

overridevirtual

Reimplemented from rack::widget::Widget.

createContextMenu()

void rack::app::ParamWidget::createContextMenu

(

)

appendContextMenu()

virtual void rack::app::ParamWidget::appendContextMenu ( ui::Menu * menu )

inlinevirtual

Override to add custom menu items at the bottom of the parameter context menu.

It is recommended to add a MenuSeparator before other menu items.

menu->addChild(new MenuSeparator);

resetAction()

void rack::app::ParamWidget::resetAction

(

)

Member Data Documentation

internal

Internal* rack::app::ParamWidget::internal

paramId

int rack::app::ParamWidget::paramId = -1

---

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

• /home/vortico/src/vcv/Rack2/include/app/ParamWidget.hpp