StepButtonView.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019-2020 pongasoft
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 * @author Yan Pujante
 */
#pragma once

#include <vstgui4/vstgui/lib/controls/ccontrol.h>
#include <vstgui4/vstgui/lib/cdrawcontext.h>
#include <pongasoft/VST/GUI/Params/GUIVstParameter.h>
#include "CustomControlView.h"

namespace pongasoft::VST::GUI::Views {

using namespace VSTGUI;

class StepButtonView : public CustomDiscreteControlView
{
public:
  enum class EArrowDirection
  {
    kAuto,
    kUp,
    kRight,
    kDown,
    kLeft
  };
public:
  explicit StepButtonView(const CRect &iSize) : CustomDiscreteControlView(iSize)
  {
  }

  // draw => does the actual drawing job
  void draw(CDrawContext *iContext) override;

  // called to display the "held" button state
  virtual void drawHeldButton(CDrawContext *iContext);

  // called to display the "released" button state
  virtual void drawReleasedButton(CDrawContext *iContext);

  // input events (mouse/keyboard)
  CMouseEventResult onMouseDown(CPoint &where, const CButtonState &buttons) override;
  CMouseEventResult onMouseUp(CPoint &where, const CButtonState &buttons) override;
  CMouseEventResult onMouseCancel() override;
  int32_t onKeyDown(VstKeyCode &keyCode) override;
  int32_t onKeyUp(VstKeyCode &keyCode) override;

  // true if held
  bool isHeld() const { return fHeld; }

  inline CColor const &getHeldColor() const { return fHeldColor; }
  void setHeldColor(CColor const &iColor) { fHeldColor = iColor; markDirty(); }

  inline CColor const &getReleasedColor() const { return fReleasedColor; }
  void setReleasedColor(CColor const &iColor) { fReleasedColor = iColor; markDirty(); }

  BitmapPtr getImage() const { return fImage; }

  void setImage(BitmapPtr iImage) { fImage = iImage; markDirty(); }

  int32 getStepIncrement() const { return fStepIncrement; }

  void setStepIncrement(int32 iStepIncrement) { fStepIncrement = iStepIncrement; fButtonPolygon = nullptr; }

  int32 getShiftStepIncrement() const { return fShiftStepIncrement; }

  void setShiftStepIncrement(int32 iStepIncrement) { fShiftStepIncrement = iStepIncrement; }

  inline bool getWrap() const { return fWrap; }
  void setWrap(bool iFlag) { fWrap = iFlag; markDirty(); }

  EArrowDirection getArrowDirection() const { return fArrowDirection; }

  void setArrowDirection(EArrowDirection iArrowDirection) { fArrowDirection = iArrowDirection; fButtonPolygon = nullptr; markDirty(); }

protected:
  // registerParameters
  void registerParameters() override;

  virtual int32 computeNextValue(int32 iIncrement) const;

  virtual CDrawContext::PointList *getButtonPolygon();

  // setViewSize
  void setViewSize(const CRect &rect, bool invalid) override;

protected:
  bool fHeld{false};

  int32 fStepIncrement{1};
  int32 fShiftStepIncrement{1};
  bool fWrap{false};
  CColor fHeldColor{kRedCColor};
  CColor fReleasedColor{kGreyCColor};
  BitmapSPtr fImage{nullptr};

  EArrowDirection fArrowDirection{EArrowDirection::kAuto};
  std::unique_ptr<CDrawContext::PointList> fButtonPolygon{};

public:
  class Creator : public CustomViewCreator<StepButtonView, CustomDiscreteControlView>
  {
    public:
    explicit Creator(char const *iViewName = nullptr, char const *iDisplayName = nullptr) :
      CustomViewCreator(iViewName, iDisplayName)
    {
      registerIntegerAttribute<int32>("step-increment", &StepButtonView::getStepIncrement, &StepButtonView::setStepIncrement);
      registerIntegerAttribute<int32>("shift-step-increment", &StepButtonView::getShiftStepIncrement, &StepButtonView::setShiftStepIncrement);
      registerBooleanAttribute("wrap", &StepButtonView::getWrap, &StepButtonView::setWrap);
      registerColorAttribute("held-color", &StepButtonView::getHeldColor, &StepButtonView::setHeldColor);
      registerColorAttribute("released-color", &StepButtonView::getReleasedColor, &StepButtonView::setReleasedColor);
      registerBitmapAttribute("button-image", &StepButtonView::getImage, &StepButtonView::setImage);
      registerListAttribute<EArrowDirection>("arrow-direction",
                                             &StepButtonView::getArrowDirection, &StepButtonView::setArrowDirection,
                                             {
                                               {"auto", EArrowDirection::kAuto},
                                               {"up", EArrowDirection::kUp},
                                               {"right", EArrowDirection::kRight},
                                               {"down", EArrowDirection::kDown},
                                               {"left", EArrowDirection::kLeft}
                                             }
      );
    }
  };
};

}