juce_FillType.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  FillType  final
{
public:
    //==============================================================================
    FillType() noexcept;

    FillType (Colour colour) noexcept;

    FillType (const ColourGradient& gradient);

    FillType (ColourGradient&& gradient);

    FillType (const Image& image, const AffineTransform& transform) noexcept;

    FillType (const FillType&);

    FillType& operator= (const FillType&);

    FillType (FillType&&) noexcept;

    FillType& operator= (FillType&&) noexcept;

    ~FillType() noexcept;
 
    //==============================================================================
    bool isColour() const noexcept          { return gradient == nullptr && image.isNull(); }

    bool isGradient() const noexcept        { return gradient != nullptr; }

    bool isTiledImage() const noexcept      { return image.isValid(); }

    void setColour (Colour newColour) noexcept;

    void setGradient (const ColourGradient& newGradient);

    void setTiledImage (const Image& image, const AffineTransform& transform) noexcept;

    void setOpacity (float newOpacity) noexcept;

    float getOpacity() const noexcept       { return colour.getFloatAlpha(); }

    bool isInvisible() const noexcept;

    FillType transformed (const AffineTransform& transform) const;
 
    //==============================================================================
    Colour colour;

    std::unique_ptr<ColourGradient> gradient;

    Image image;

    AffineTransform transform;
 
    //==============================================================================
    bool operator== (const FillType&) const;
    bool operator!= (const FillType&) const;
 
private:
    JUCE_LEAK_DETECTOR (FillType)
};
 
} // namespace juce