MomentaryButtonView.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2020 pongasoft
 *
 * Licensed under the Apache License, Version 2.0 or the MIT license,
 * at your option. You may not use this file except in compliance with
 * one of these licenses. You may obtain copies of the licenses at:
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 * https://opensource.org/licenses/MIT
 *
 * 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 "CustomControlView.h"
 
namespace pongasoft::VST::GUI::Views {
 
using namespace VSTGUI;

class MomentaryButtonView : public CustomDiscreteControlView
{
public:
  explicit MomentaryButtonView(const CRect &iSize) : CustomDiscreteControlView(iSize)
  {
    // off color is grey
    fBackColor = CColor{200,200,200};
  }

  void draw(CDrawContext *iContext) override;

  virtual void drawOn(CDrawContext *iContext);

  virtual void drawOff(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;
 
  // sizeToFit
  bool sizeToFit() override;

  int32 getOffStep() const { return fOffStep; }

  void setOffStep(int32 iStep) { fOffStep = iStep; markDirty(); }

  int32 getComputedOffStep() const { return std::max(Utils::ZERO_INT32, getOffStep()); }

  int32 getOnStep() const { return fOnStep; }

  void setOnStep(int32 iStep) { fOnStep = iStep; markDirty(); }

  int32 getComputedOnStep() const;
 
  // is on or off
  bool isOff() const { return getControlValue() == getComputedOffStep(); }
  bool isOn() const { return !isOff(); }

  CColor const &getOnColor() const { return fOnColor; }

  void setOnColor(CColor const &iColor) { fOnColor = iColor; }

  CColor const &getDisabledColor() const { return fDisabledColor; }
  void setDisabledColor(CColor const &iColor) { fDisabledColor = iColor; }

  BitmapPtr getImage() const { return fImage; }

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

  bool getImageHasDisabledState() const { return fImageHasDisabledState; }
  void setImageHasDisabledState(bool iValue) { fImageHasDisabledState = iValue; }

  bool getInverse() const { return fInverse; }
  void setInverse(bool iInverse) { fInverse = iInverse; }
 
  // true if held
  bool isHeld() const { return fHeld; }
 
protected:
  int32 fOffStep{-1};
  int32 fOnStep{-1};

  bool fHeld{false};
 
  CColor fOnColor{kRedCColor};
  CColor fDisabledColor{kBlackCColor};
  BitmapSPtr fImage{nullptr};
  bool fInverse{false};
 
  // whether the image has disabled state (3 frames) or not (2 frames)
  bool fImageHasDisabledState{false};
 
public:
  class Creator : public CustomViewCreator<MomentaryButtonView, CustomDiscreteControlView>
  {
    public:
    explicit Creator(char const *iViewName = nullptr, char const *iDisplayName = nullptr) :
      CustomViewCreator(iViewName, iDisplayName)
    {
      registerIntegerAttribute<int32>("on-step", &MomentaryButtonView::getOnStep, &MomentaryButtonView::setOnStep);
      registerIntegerAttribute<int32>("off-step", &MomentaryButtonView::getOffStep, &MomentaryButtonView::setOffStep);
      registerColorAttribute("on-color", &MomentaryButtonView::getOnColor, &MomentaryButtonView::setOnColor);
      registerColorAttribute("disabled-color", &MomentaryButtonView::getDisabledColor, &MomentaryButtonView::setDisabledColor);
      registerBitmapAttribute("button-image", &MomentaryButtonView::getImage, &MomentaryButtonView::setImage);
      registerBooleanAttribute("button-image-has-disabled-state", &MomentaryButtonView::getImageHasDisabledState, &MomentaryButtonView::setImageHasDisabledState);
      registerBooleanAttribute("inverse", &MomentaryButtonView::getInverse, &MomentaryButtonView::setInverse);
    }
  };
};
 
}