RoundKnobWidget.hpp

Go to the documentation of this file.

 
#pragma once
 
#define STONEYVCV_COMPONENTLIBRARY_ROUNDKNOB_HPP_INCLUDED 1
 
#if defined (STONEYVCV_BUILD_COMPONENTLIBRARY)
 
//==============================================================================
 
#include <StoneyVCV.hpp>
#include <StoneyVCV/ComponentLibrary.hpp>
#include <StoneyVCV/ComponentLibrary/Widget.hpp>
#include <StoneyVCV/ComponentLibrary/ParamWidget.hpp>
 
//==============================================================================
 
#include <rack.hpp>
#include <StoneyDSP/Core.hpp>
 
//==============================================================================
 
#include <string>
 
//==============================================================================
 
namespace StoneyDSP
{
//==============================================================================
 
namespace StoneyVCV
{
//==============================================================================
 
namespace ComponentLibrary
{
//==============================================================================
 
struct ThemedRoundKnobPanelWidget : virtual ::StoneyDSP::StoneyVCV::ComponentLibrary::ThemedParamPanelWidget
{
 
    //==========================================================================
 
public:
 
    //==========================================================================
 
    using DrawArgs = ::StoneyDSP::StoneyVCV::ComponentLibrary::ThemedParamPanelWidget::DrawArgs;
 
    //==========================================================================
 
    ThemedRoundKnobPanelWidget()
    :   ::StoneyDSP::StoneyVCV::ComponentLibrary::ThemedParamPanelWidget(),
        minAngle(0.0F),
        maxAngle(0.0F)
    {
        DBG("Constructing StoneyVCV::ComponentLibrary::ThemedRoundKnobPanelWidget");
 
        this->minAngle = (0.0F - (5.0F / 6.0F)) * M_PI;
        this->maxAngle = (5.0F / 6.0F) * M_PI;
        this->leading = (4.0F);
    }
 
    virtual ~ThemedRoundKnobPanelWidget() noexcept
    {
        DBG("Destroying StoneyVCV::ComponentLibrary::ThemedRoundKnobPanelWidget");
        assert(!this->parent);
 
        this->clearChildren();
    }
 
    //==========================================================================
 
    virtual void step() override
    {
        return ::StoneyDSP::StoneyVCV::ComponentLibrary::ThemedParamPanelWidget::step();
    }
 
    float radiansToDegrees(const float &radians)
    {
        return radians * (180.0F / M_PI);
    }
 
    ::rack::math::Vec radiusToXY(const float &radius, float angle, float rotation = 0.0F)
    {
        const float theta = (angle + rotation) * (M_PI / 180.0F);
 
        return ::rack::math::Vec(
             radius * ::std::cos(theta),
            -radius * ::std::sin(theta)
        );
    }
 
    virtual void draw(const ::StoneyDSP::StoneyVCV::ComponentLibrary::ThemedRoundKnobPanelWidget::DrawArgs &args) override
    {
        const bool &prefersDarkPanels = this->getPrefersDarkPanels();
        const auto &size = this->getSize();
 
        const auto &minAngle = this->getMinAngle();
        const auto &maxAngle = this->getMaxAngle();
        const auto &leading = this->getLeading();
 
        // For debugging the bounding box of the widget
        const auto &bgColor = prefersDarkPanels ? ::StoneyDSP::StoneyVCV::Panels::bgLight: ::StoneyDSP::StoneyVCV::Panels::bgDark;
        // const auto &borderColor = ::StoneyDSP::StoneyVCV::Panels::borderColor;
        const auto &textColor = prefersDarkPanels ? ::StoneyDSP::StoneyVCV::Panels::bgPortDark : ::StoneyDSP::StoneyVCV::Panels::bgPortLight;
        const auto &fontSize = this->getFontSize();
 
        // Load font from cache
        ::std::shared_ptr<::rack::window::Font> font = APP->window->loadFont(
                ::rack::asset::system("res/fonts/DejaVuSans.ttf"
            )
        );
 
        // Don't draw text if font failed to load
        if (font) {
            // ::nvgBeginPath(args.vg);
            // Select font handle
            ::nvgFontFaceId(args.vg, font->handle);
 
            // Set font size and alignment
            ::nvgFontSize(args.vg, fontSize);
            ::nvgTextAlign(args.vg,
                ::NVGalign::NVG_ALIGN_CENTER | ::NVGalign::NVG_ALIGN_BASELINE
            );
            ::nvgFillColor(args.vg, textColor);
 
            // Draw the text at a position
            ::nvgText(args.vg,
                (size.x * 0.5F),
                0.0F - (fontSize), // font size / 2
                this->getLabelText().c_str(),
                NULL
            );
        }
 
        ::nvgBeginPath(args.vg);
        ::nvgLineCap(args.vg, NVG_ROUND);               // set rounded lines
        ::nvgLineJoin(args.vg, NVG_ROUND);              // set the line join to round corners
 
        float radius = (size.x * 0.5F) + leading;
        float rotationOffset = -M_PI / 2.0F;            // Knob Widgets are actually rotated -90 degress in rads
 
        // Draw knob ring
        ::nvgArc(args.vg,
            (size.x * 0.5F),                            // knob ring centre x
            (size.y * 0.5F),                            // knob ring center y
            radius,                                     // knob ring diameter
            (minAngle + rotationOffset),                // knob ring start position
            (maxAngle + rotationOffset),                // knob ring end position
            NVG_CW                                      // knob ring direction
        );
 
        // reset cursor
        ::nvgMoveTo(args.vg,
            size.x * 0.5F,
            size.y * 0.5F
        );
 
 
 
        ::std::vector<::rack::math::Vec> ranges;
 
        ranges.reserve(3);
 
        // ranges = {
        //     // rangeStart, rangeEnd
        //     this->radiusToXY(radius, this->radiansToDegrees(this->minAngle - rotationOffset)),
        //     // this->radiusToXY(radius, 0.0F),
        //     // this->radiusToXY(radius, 45.0F),
        //     // this->radiusToXY(radius, 90.0F),
        //     // this->radiusToXY(radius, 180.0F),
        //     // this->radiusToXY(radius, 270.0F),
        //     this->radiusToXY(radius, this->radiansToDegrees(this->maxAngle - rotationOffset))
        // };
 
        ranges.emplace_back(
            this->radiusToXY(radius, this->radiansToDegrees(this->minAngle - rotationOffset))
        );
 
        if(this->isBipolar)
            ranges.emplace_back(
                // this->radiusToXY(
                //     radius,
                //     this->radiansToDegrees(this->minAngle - rotationOffset) - this->radiansToDegrees(this->maxAngle - rotationOffset)
                // )
                this->radiusToXY(radius, 90.0F)
            );
 
        ranges.emplace_back(
            this->radiusToXY(radius, this->radiansToDegrees(this->maxAngle - rotationOffset))
 
        );
 
        // Draw ranges as lines from the knob centre-point to the outer radius (includes leading)
        for(const auto &range : ranges) {
            ::nvgLineTo(args.vg,
                (size.x * 0.5F) + range.x,
                (size.y * 0.5F) + range.y
            );
            ::nvgMoveTo(args.vg,
                size.x * 0.5F,
                size.y * 0.5F
            );
        }
 
        // Draw ranges as lines
        ::nvgStrokeWidth(args.vg, (5.0F / 6.0F));
        ::nvgStrokeColor(args.vg, bgColor);
        ::nvgStroke(args.vg);
        ::nvgClosePath(args.vg);
 
        return ::StoneyDSP::StoneyVCV::ComponentLibrary::ThemedParamPanelWidget::draw(args);
    }
 
    //==========================================================================
 
    virtual void setMinAngle(const float &newMinAngle)
    {
        this->minAngle = newMinAngle;
    }
 
    virtual const float &getMinAngle() const noexcept
    {
        return this->minAngle;
    }
 
    //==========================================================================
 
    virtual void setMaxAngle(const float &newMaxAngle)
    {
        this->maxAngle = newMaxAngle;
    }
 
    virtual const float &getMaxAngle() const noexcept
    {
        return this->maxAngle;
    }
 
    //==========================================================================
 
protected:
 
    //==========================================================================
 
    float minAngle = (0.0F - (5.0F / 6.0F)) * M_PI;     // -0.8333... * pi
    float maxAngle = (5.0F / 6.0F) * M_PI;              // +0.8333... * pi
 
    //==========================================================================
 
private:
 
    //==========================================================================
 
    STONEYDSP_DECLARE_NON_COPYABLE(ThemedRoundKnobPanelWidget)
    STONEYDSP_DECLARE_NON_MOVEABLE(ThemedRoundKnobPanelWidget)
};
 
//==============================================================================
 
struct RoundKnob : virtual ::rack::app::SvgKnob
{
    RoundKnob()
    :   ::rack::app::SvgKnob(),
        bg(nullptr)
    {
        this->minAngle = (0.0F - (5.0F / 6.0F)) * M_PI; // -0.83 * pi
        this->maxAngle = (5.0F / 6.0F) * M_PI;          //  0.83 * pi
 
        this->bg = new ::rack::widget::SvgWidget;
        this->fb->addChildBelow(this->bg, this->tw);
    }
 
    virtual ~RoundKnob() noexcept
    {
        assert(!this->parent);
 
        this->clearChildren();
    }
 
    ::rack::widget::SvgWidget* bg = NULL;
 
private:
 
    STONEYDSP_DECLARE_NON_COPYABLE(RoundKnob)
    STONEYDSP_DECLARE_NON_MOVEABLE(RoundKnob)
};
 
//==============================================================================
 
struct RoundBlackKnob : virtual ::StoneyDSP::StoneyVCV::ComponentLibrary::RoundKnob
{
public:
 
    RoundBlackKnob()
    : ::StoneyDSP::StoneyVCV::ComponentLibrary::RoundKnob()
    {
 
        this->setSvg(
            ::rack::window::Svg::load(
                ::rack::asset::system(
                    "res/ComponentLibrary/RoundBlackKnob.svg"
                )
            )
        );
 
        this->bg->setSvg(
            ::rack::window::Svg::load(
                ::rack::asset::system(
                    "res/ComponentLibrary/RoundBlackKnob_bg.svg"
                )
            )
        );
 
    }
 
    virtual ~RoundBlackKnob() noexcept
    {
        assert(!this->parent);
 
        this->clearChildren();
    }
 
private:
 
    STONEYDSP_DECLARE_NON_COPYABLE(RoundBlackKnob)
    STONEYDSP_DECLARE_NON_MOVEABLE(RoundBlackKnob)
};
 
 
struct RoundSmallBlackKnob : virtual ::StoneyDSP::StoneyVCV::ComponentLibrary::RoundKnob
{
 
public:
 
    RoundSmallBlackKnob()
    :   ::StoneyDSP::StoneyVCV::ComponentLibrary::RoundKnob()
    {
        this->setSvg(
            ::rack::window::Svg::load(
                ::rack::asset::system(
                    "res/ComponentLibrary/RoundSmallBlackKnob.svg"
                )
            )
        );
 
        this->bg->setSvg(
            ::rack::window::Svg::load(
                ::rack::asset::system(
                    "res/ComponentLibrary/RoundSmallBlackKnob_bg.svg"
                )
            )
        );
    }
 
    virtual ~RoundSmallBlackKnob() noexcept
    {
        assert(!this->parent);
 
        this->clearChildren();
    }
 
private:
 
    STONEYDSP_DECLARE_NON_COPYABLE(RoundSmallBlackKnob)
    STONEYDSP_DECLARE_NON_MOVEABLE(RoundSmallBlackKnob)
};
 
struct RoundLargeBlackKnob : virtual ::StoneyDSP::StoneyVCV::ComponentLibrary::RoundKnob
{
 
public:
 
    RoundLargeBlackKnob()
    :   ::StoneyDSP::StoneyVCV::ComponentLibrary::RoundKnob()
    {
        this->setSvg(
            ::rack::window::Svg::load(
                ::rack::asset::system(
                    "res/ComponentLibrary/RoundLargeBlackKnob.svg"
                )
            )
        );
 
        this->bg->setSvg(
            ::rack::window::Svg::load(
                ::rack::asset::system(
                    "res/ComponentLibrary/RoundLargeBlackKnob_bg.svg"
                )
            )
        );
    }
 
    virtual ~RoundLargeBlackKnob() noexcept
    {
        assert(!this->parent);
 
        this->clearChildren();
    }
 
private:
 
    STONEYDSP_DECLARE_NON_COPYABLE(RoundLargeBlackKnob)
    STONEYDSP_DECLARE_NON_MOVEABLE(RoundLargeBlackKnob)
};
 
struct RoundBigBlackKnob : virtual ::StoneyDSP::StoneyVCV::ComponentLibrary::RoundKnob
{
 
public:
 
    RoundBigBlackKnob()
    :   ::StoneyDSP::StoneyVCV::ComponentLibrary::RoundKnob()
    {
        this->setSvg(
            ::rack::window::Svg::load(
                ::rack::asset::system(
                    "res/ComponentLibrary/RoundBigBlackKnob.svg"
                )
            )
        );
 
        this->bg->setSvg(
            ::rack::window::Svg::load(
                ::rack::asset::system(
                    "res/ComponentLibrary/RoundBigBlackKnob_bg.svg"
                )
            )
        );
    }
 
    virtual ~RoundBigBlackKnob() noexcept
    {
        assert(!this->parent);
 
        this->clearChildren();
    }
 
private:
 
    STONEYDSP_DECLARE_NON_COPYABLE(RoundBigBlackKnob)
    STONEYDSP_DECLARE_NON_MOVEABLE(RoundBigBlackKnob)
};
 
struct RoundHugeBlackKnob : virtual ::StoneyDSP::StoneyVCV::ComponentLibrary::RoundKnob
{
 
public:
 
    RoundHugeBlackKnob()
    :   ::StoneyDSP::StoneyVCV::ComponentLibrary::RoundKnob()
    {
        this->setSvg(
            ::rack::window::Svg::load(
                ::rack::asset::system(
                    "res/ComponentLibrary/RoundHugeBlackKnob.svg"
                )
            )
        );
 
        this->bg->setSvg(
            ::rack::window::Svg::load(
                ::rack::asset::system(
                    "res/ComponentLibrary/RoundHugeBlackKnob_bg.svg"
                )
            )
        );
    }
 
    virtual ~RoundHugeBlackKnob() noexcept
    {
        assert(!this->parent);
 
        this->clearChildren();
    }
 
private:
 
    STONEYDSP_DECLARE_NON_COPYABLE(RoundHugeBlackKnob)
    STONEYDSP_DECLARE_NON_MOVEABLE(RoundHugeBlackKnob)
};
 
struct RoundBlackSnapKnob : virtual ::StoneyDSP::StoneyVCV::ComponentLibrary::RoundKnob
{
 
public:
 
    RoundBlackSnapKnob()
    :   ::StoneyDSP::StoneyVCV::ComponentLibrary::RoundKnob()
    {
        snap = true;
    }
 
    virtual ~RoundBlackSnapKnob() noexcept
    {
        assert(!this->parent);
 
        this->clearChildren();
    }
 
private:
 
    STONEYDSP_DECLARE_NON_COPYABLE(RoundBlackSnapKnob)
    STONEYDSP_DECLARE_NON_MOVEABLE(RoundBlackSnapKnob)
};
 
struct Trimpot : virtual ::StoneyDSP::StoneyVCV::ComponentLibrary::RoundKnob
{
public:
 
    Trimpot()
    :   ::StoneyDSP::StoneyVCV::ComponentLibrary::RoundKnob()
    {
        this->minAngle = -0.75 * M_PI;
        this->maxAngle = 0.75 * M_PI;
 
        this->setSvg(
            ::rack::Svg::load(
                ::rack::asset::system(
                    "res/ComponentLibrary/Trimpot.svg"
                )
            )
        );
        this->bg->setSvg(
            ::rack::Svg::load(
                ::rack::asset::system(
                    "res/ComponentLibrary/Trimpot_bg.svg"
                )
            )
        );
    }
 
    virtual ~Trimpot() noexcept
    {
        assert(!this->parent);
 
        this->clearChildren();
    }
 
private:
 
    STONEYDSP_DECLARE_NON_COPYABLE(Trimpot)
    STONEYDSP_DECLARE_NON_MOVEABLE(Trimpot)
};
 
//==============================================================================
 
} // namespace ComponentLibrary
 
//==============================================================================
 
} // namespace StoneyVCV
 
//==============================================================================
 
} // namespace StoneyDSP
 
//==============================================================================
 
#endif // STONEYVCV_BUILD_COMPONENTLIBRARY
 
//==============================================================================