juce_ColourGradient.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  ColourGradient  final
{
public:
    ColourGradient() noexcept;
 
    ColourGradient (const ColourGradient&);
    ColourGradient (ColourGradient&&) noexcept;
    ColourGradient& operator= (const ColourGradient&);
    ColourGradient& operator= (ColourGradient&&) noexcept;
 
    //==============================================================================
    ColourGradient (Colour colour1, float x1, float y1,
                    Colour colour2, float x2, float y2,
                    bool isRadial);

    ColourGradient (Colour colour1, Point<float> point1,
                    Colour colour2, Point<float> point2,
                    bool isRadial);
 
    //==============================================================================
    static ColourGradient vertical (Colour colour1, float y1,
                                    Colour colour2, float y2);

    static ColourGradient horizontal (Colour colour1, float x1,
                                      Colour colour2, float x2);

    template <typename Type>
    static ColourGradient vertical (Colour colourTop, Colour colourBottom, Rectangle<Type> area)
    {
        return vertical (colourTop, (float) area.getY(), colourBottom, (float) area.getBottom());
    }

    template <typename Type>
    static ColourGradient horizontal (Colour colourLeft, Colour colourRight, Rectangle<Type> area)
    {
        return horizontal (colourLeft, (float) area.getX(), colourRight, (float) area.getRight());
    }

    ~ColourGradient();
 
    //==============================================================================
    void clearColours();

    int addColour (double proportionAlongGradient, Colour colour);

    void removeColour (int index);

    void multiplyOpacity (float multiplier) noexcept;
 
    //==============================================================================
    int getNumColours() const noexcept;

    double getColourPosition (int index) const noexcept;

    Colour getColour (int index) const noexcept;

    void setColour (int index, Colour newColour) noexcept;

    Colour getColourAtPosition (double position) const noexcept;
 
    //==============================================================================
    int createLookupTable (const AffineTransform& transform, HeapBlock<PixelARGB>& resultLookupTable) const;

    void createLookupTable (PixelARGB* resultLookupTable, int numEntries) const noexcept;

    bool isOpaque() const noexcept;

    bool isInvisible() const noexcept;
 
    //==============================================================================
    Point<float> point1, point2;

    bool isRadial;
 
    bool operator== (const ColourGradient&) const noexcept;
    bool operator!= (const ColourGradient&) const noexcept;
 
 
private:
    //==============================================================================
    struct ColourPoint
    {
        bool operator== (ColourPoint) const noexcept;
        bool operator!= (ColourPoint) const noexcept;
 
        double position;
        Colour colour;
    };
 
    Array<ColourPoint> colours;
 
    JUCE_LEAK_DETECTOR (ColourGradient)
};
 
} // namespace juce