NanoVG based widget library for DPF

This library is meant to emulate plugdata UI objects for use in DPF plugins.

For a full example see the pdvg-example-plugin.

Objects

Organization elements

• Main patch (root of the UI)
• Sub patch (nested levels)

General graphical elements

• Canvas (colored square)
• Comment (plain text with word wrap)

Tied to plugin (interactive) Parameters

• Toggle (on/off)
• Bang (event)
• Slider (horizontal + vertical)
• Radio buttons (horizontal + vertical)
• Knob
• Number box
• Float atom

Configuration

All custom colors must use a valid NVGcolor object. You can use nvgRGBA(r, g, b, a) or nvgRGB(r, g, b) for this.

Theme

It is possible to overload the following theme colors:

Colors::cnvColor        // Canvas
Colors::textColor       // Text
Colors::ioColor         // Object internal outline
Colors::bgColor         // Background
Colors::selColor        // Selected
Colors::outColor        // Object outline

And the following corner:

Corners::objectCornerRadius  // Default 2.75f;

Primary configuration

After initialitation the Main patch only needs a total size:

<object>->setSize(<width>, <height>);

All other objects also need an absolute position relative to their parent (main or sub-patch):

<object>->setAbsolutePos(<x>, <y>);

All sub-patches and interactive widgets need to added to a main or subpatch as a managed child object:

<main/sub-patch>->addManagedChild(<object>);

Label setting

The following objects support adding a Label:

• Canvas
• Toggle
• Bang
• Slider
• Radio
• Number

<object>->setLabel("my label", <labelcolor>, <x>, <y>, <size>);

Float object doesn't allow setting the color or relative position. One of 4 positions can be selected instead:

• LabelPos::Left
• LabelPos::Right
• LabelPos::Top
• LabelPos::Bottom

myFloat->setLabel("my label", <size>, LabelPos::Top)

Canvas settings

myCanvas = new PDCanvas(mainPatch);
...
myCanvas->setColors(<canvasColor>);

Comment settings

Comment text that is longer than the widget width will be wrapped to a new line on the last full word that still fits.

myComment = new PDComment(mainPatch);
...
std::string myCommentString = "test comment";
myComment->setText(myCommentString);
myComment->setFontSize(<size>);

Parameters

Widgets that belong to a plugin parameter need to have its id set:

<object>->setId(kParameter);

Slider settings

mySlider = new PDSlider(mainPatch, this);
...
mySlider->setSliderArea(0, 0, <width>, <height>);   // Hit area of the slider
mySlider->setStartPos(<startX>, <startY>);          // Position where the slider starts
mySlider->setEndPos(<endX>, <endY>);                // Position where the slider ends
mySlider->setInverted(true);                        // Optional - invert the slider behavior
mySlider->setHorizontal();                          // Optional - make slider horizontal
mySlider->setRange(0.0001f, 10.0f);                 // Set min/max range
mySlider->setDefault(3.0f);                         // Default value
mySlider->setUsingLogScale(true);                   // Enable log scale
mySlider->setSteadyOnClick(true);                   // Enable steady-on-click behavior
mySlider->setColors(                                // Configure colors
    <background_color>,
    <slider_color>
);

Toggle settings

myToggle = new PDToggle(mainPatch, this);
...
myToggle->setColors(                    // Configure colors
    <background_color>,
    <toggled_color>
);

Radio button settings

myRadio = new PDRadio(mainPatch, this);
...
myRadio->setStep(8);                   // Number of steps
myRadio->setHorizontal();              // Optional - make it horizontal
myRadio->setColors(                    // Configure colors
    <background_color>,
    <radio_color>
);

Number settings

myNumber = PDNumber(mainPatch, this);
...
myNumber->setRange(0.0f, 1000.0f);      // Set min/max range
myNumber->setDefault(666.6f);           // Default value
myNumber->setColors(                    // Configure colors
    <background_color>,
    <foreground_color>
);

Float settings

Float object gets all its colors from the main theme settings.

myFloat = new PDFloat(mainPatch, this);
...
myFloat->setRange(-10.0f, 10.0f);       // Set min/max range
myFloat->setDefault(3.33f);             // Default value

Bang settings

myBang = new PDBang(mainPatch, this);
...
myBang->setInterval(uint32_t intervalMs)    // Set the length of the visual flash when triggered. Default is 250ms
myBang->setColors(                          // Configure colors
    <background_color>,
    <foreground_color>
);

Knob settings

This object has many optional configurations to change the style and behavior. The label text color is taken from the main theme text color.

myKnob = new PDKnob(mainPatch, this);
...
myKnob->setKnobArea(0.0f, 0.0f, <width>, <height>);             // Set the knob hit area (should be the same as the size)
myKnob->setRange(0.0f, 127.0f);                                 // set min/max range
myKnob->setDefault(99.0f);                                      // Default value
myKnob->setShowArc(false);                                      // Optional - disable arc
myKnob->setSteps(16);                                           // Optional - number of steps
myKnob->setDiscrete(true);                                      // Optional - align to steps
myKnob->setShowTicks(true);                                     // Optional - show ticks (uses steps)
myKnob->setJumpOnClick(true);                                   // Optional - jump-on-click behavior
myKnob->setUsingLogScale(PDKnobEventHandler::LogMode::EXP);     // Optional - set alternative mode. Defaults to `LIN`, other values: `LOG` and `EXP`
myKnob->setExpFactor(5.0f);                                     // Optional - when using exponential scale. Defaults to `1.0f`
myKnob->setAngular(180, 90);                                    // Optional - change the angle
myKnob->setDrawSquare(false);                                   // Optional - disable the square box
myKnob->setColors(                                              // Configure colors
    <background_color>,
    <foreground_color>,
    <arc_color>
);
myKnob->setLabelStyle(<x>, <y>, <size>);                        // Configure label
myKnob->setShowLabel(LabelShow::ALWAYS);                        // Optional - defaults to `NEVER`, other values: `ALWAYS`, `ACTIVE`, `TYPING` (not implemented)