juce_DrawableImage.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  DrawableImage  : public Drawable
{
public:
    //==============================================================================
    DrawableImage();
    DrawableImage (const DrawableImage&);

    explicit DrawableImage (const Image& imageToUse);

    ~DrawableImage() override;
 
    //==============================================================================
    void setImage (const Image& imageToUse);

    const Image& getImage() const noexcept                      { return image; }

    void setOpacity (float newOpacity);

    float getOpacity() const noexcept                           { return opacity; }

    void setOverlayColour (Colour newOverlayColour);

    Colour getOverlayColour() const noexcept                    { return overlayColour; }

    void setBoundingBox (Parallelogram<float> newBounds);

    void setBoundingBox (Rectangle<float> newBounds);

    Parallelogram<float> getBoundingBox() const noexcept        { return bounds; }
 
    //==============================================================================
    void paint (Graphics&) override;
    bool hitTest (int x, int y) override;
    std::unique_ptr<Drawable> createCopy() const override;
    Rectangle<float> getDrawableBounds() const override;
    Path getOutlineAsPath() const override;
 
private:
    //==============================================================================
    std::unique_ptr<AccessibilityHandler> createAccessibilityHandler() override;
    bool setImageInternal (const Image&);
 
    //==============================================================================
    Image image;
    float opacity = 1.0f;
    Colour overlayColour { 0 };
    Parallelogram<float> bounds;
 
    DrawableImage& operator= (const DrawableImage&);
    JUCE_LEAK_DETECTOR (DrawableImage)
};
 
} // namespace juce