juce_KeyboardComponentBase.h

Go to the documentation of this file.

 /*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  KeyboardComponentBase  : public Component,
                                         public ChangeBroadcaster
{
public:
    //==============================================================================
    enum Orientation
    {
        horizontalKeyboard,
        verticalKeyboardFacingLeft,
        verticalKeyboardFacingRight,
    };
 
    //==============================================================================
    explicit KeyboardComponentBase (Orientation orientation);
 
    ~KeyboardComponentBase() override = default;
 
    //==============================================================================
    void setKeyWidth (float widthInPixels);
 
    float getKeyWidth() const noexcept                              { return keyWidth; }
 
    void setScrollButtonWidth (int widthInPixels);
 
    int getScrollButtonWidth() const noexcept                       { return scrollButtonWidth; }
 
    void setOrientation (Orientation newOrientation);
 
    Orientation getOrientation() const noexcept                     { return orientation; }
 
    bool isHorizontal() const noexcept                              { return orientation == horizontalKeyboard; }
 
    void setAvailableRange (int lowestNote, int highestNote);
 
    int getRangeStart() const noexcept                              { return rangeStart; }
 
    int getRangeEnd() const noexcept                                { return rangeEnd; }
 
    void setLowestVisibleKey (int noteNumber);
 
    int getLowestVisibleKey() const noexcept                        { return (int) firstKey; }
 
    float getWhiteNoteLength() const noexcept;
 
    void setBlackNoteLengthProportion (float ratio) noexcept;
 
    float getBlackNoteLengthProportion() const noexcept             { return blackNoteLengthRatio; }
 
    float getBlackNoteLength() const noexcept;
 
    void setBlackNoteWidthProportion (float ratio) noexcept;
 
    float getBlackNoteWidthProportion() const noexcept             { return blackNoteWidthRatio; }
 
    float getBlackNoteWidth() const noexcept                       { return keyWidth * blackNoteWidthRatio; }
 
    void setScrollButtonsVisible (bool canScroll);
 
    //==============================================================================
    enum ColourIds
    {
        upDownButtonBackgroundColourId  = 0x1004000,
        upDownButtonArrowColourId       = 0x1004001
    };
 
    float getKeyStartPosition (int midiNoteNumber) const;
 
    float getTotalKeyboardWidth() const noexcept;
 
    struct JUCE_API  NoteAndVelocity
    {
        int note;
        float velocity;
    };
 
    NoteAndVelocity getNoteAndVelocityAtPosition (Point<float> position, bool includeChildComponents = false);
 
   #ifndef DOXYGEN
    [[deprecated ("This method has been deprecated in favour of getNoteAndVelocityAtPosition.")]]
    int getNoteAtPosition (Point<float> p)  { return getNoteAndVelocityAtPosition (p).note; }
   #endif
 
    Rectangle<float> getRectangleForKey (int midiNoteNumber) const;
 
    //==============================================================================
    void setOctaveForMiddleC (int octaveNumForMiddleC);
 
    int getOctaveForMiddleC() const noexcept            { return octaveNumForMiddleC; }
 
    //==============================================================================
    virtual void drawKeyboardBackground (Graphics& g, Rectangle<float> area) = 0;
 
    virtual void drawWhiteKey (int midiNoteNumber, Graphics& g, Rectangle<float> area) = 0;
 
    virtual void drawBlackKey (int midiNoteNumber, Graphics& g, Rectangle<float> area) = 0;
 
    virtual void drawUpDownButton (Graphics& g, int w, int h, bool isMouseOver, bool isButtonPressed, bool movesOctavesUp);
 
    virtual Range<float> getKeyPosition (int midiNoteNumber, float keyWidth) const;
 
    //==============================================================================
    void paint (Graphics&) override;
    void resized() override;
    void mouseWheelMove (const MouseEvent&, const MouseWheelDetails&) override;
 
private:
    //==============================================================================
    struct UpDownButton;
 
    Range<float> getKeyPos (int midiNoteNumber) const;
    NoteAndVelocity remappedXYToNote (Point<float>) const;
    void setLowestVisibleKeyFloat (float noteNumber);
 
    //==============================================================================
    Orientation orientation;
 
    float blackNoteLengthRatio = 0.7f, blackNoteWidthRatio = 0.7f;
    float xOffset = 0.0f;
    float keyWidth = 16.0f;
    float firstKey = 12 * 4.0f;
 
    int scrollButtonWidth = 12;
    int rangeStart = 0, rangeEnd = 127;
    int octaveNumForMiddleC = 3;
 
    bool canScroll = true;
    std::unique_ptr<Button> scrollDown, scrollUp;
 
    //==============================================================================
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (KeyboardComponentBase)
};
 
} // namespace juce