juce_DrawableImage.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission is granted to use this software under the terms of either:
   a) the GPL v2 (or any later version)
   b) the Affero GPL v3
 
   Details of these licenses can be found at: www.gnu.org/licenses
 
   JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
   A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 
   ------------------------------------------------------------------------------
 
   To release a closed-source product which uses JUCE, commercial licenses are
   available: visit www.juce.com for more information.
 
  ==============================================================================
*/
 
#ifndef JUCE_DRAWABLEIMAGE_H_INCLUDED
#define JUCE_DRAWABLEIMAGE_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  DrawableImage  : public Drawable
{
public:
    //==============================================================================
    DrawableImage();
    DrawableImage (const DrawableImage&);
 
    ~DrawableImage();
 
    //==============================================================================
    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 (const RelativeParallelogram& newBounds);
 
    const RelativeParallelogram& getBoundingBox() const noexcept        { return bounds; }
 
    //==============================================================================
    void paint (Graphics&) override;
    bool hitTest (int x, int y) override;
    Drawable* createCopy() const override;
    Rectangle<float> getDrawableBounds() const override;
    void refreshFromValueTree (const ValueTree& tree, ComponentBuilder&);
    ValueTree createValueTree (ComponentBuilder::ImageProvider*) const override;
    static const Identifier valueTreeType;
 
    //==============================================================================
    class ValueTreeWrapper   : public Drawable::ValueTreeWrapperBase
    {
    public:
        ValueTreeWrapper (const ValueTree& state);
 
        var getImageIdentifier() const;
        void setImageIdentifier (const var&, UndoManager*);
        Value getImageIdentifierValue (UndoManager*);
 
        float getOpacity() const;
        void setOpacity (float newOpacity, UndoManager*);
        Value getOpacityValue (UndoManager*);
 
        Colour getOverlayColour() const;
        void setOverlayColour (Colour newColour, UndoManager*);
        Value getOverlayColourValue (UndoManager*);
 
        RelativeParallelogram getBoundingBox() const;
        void setBoundingBox (const RelativeParallelogram&, UndoManager*);
 
        static const Identifier opacity, overlay, image, topLeft, topRight, bottomLeft;
    };
 
private:
    //==============================================================================
    Image image;
    float opacity;
    Colour overlayColour;
    RelativeParallelogram bounds;
 
    friend class Drawable::Positioner<DrawableImage>;
    bool registerCoordinates (RelativeCoordinatePositionerBase&);
    void recalculateCoordinates (Expression::Scope*);
 
    DrawableImage& operator= (const DrawableImage&);
    JUCE_LEAK_DETECTOR (DrawableImage)
};
 
 
#endif   // JUCE_DRAWABLEIMAGE_H_INCLUDED