juce/source/src/gui/graphics/drawables/juce_DrawableImage.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #ifndef __JUCE_DRAWABLEIMAGE_JUCEHEADER__
  27 #define __JUCE_DRAWABLEIMAGE_JUCEHEADER__
  28
  29 #include "juce_Drawable.h"
  30 #include "../imaging/juce_Image.h"
  31 #include "../../components/positioning/juce_RelativeParallelogram.h"
  32
  33
  34 //==============================================================================
  35 /**
  36     A drawable object which is a bitmap image.
  37
  38     @see Drawable
  39 */
  40 class JUCE_API  DrawableImage  : public Drawable
  41 {
  42 public:
  43     //==============================================================================
  44     DrawableImage();
  45     DrawableImage (const DrawableImage& other);
  46
  47     /** Destructor. */
  48     ~DrawableImage();
  49
  50     //==============================================================================
  51     /** Sets the image that this drawable will render. */
  52     void setImage (const Image& imageToUse);
  53
  54     /** Returns the current image. */
  55     const Image& getImage() const noexcept                      { return image; }
  56
  57     /** Sets the opacity to use when drawing the image. */
  58     void setOpacity (float newOpacity);
  59
  60     /** Returns the image's opacity. */
  61     float getOpacity() const noexcept                           { return opacity; }
  62
  63     /** Sets a colour to draw over the image's alpha channel.
  64
  65         By default this is transparent so isn't drawn, but if you set a non-transparent
  66         colour here, then it will be overlaid on the image, using the image's alpha
  67         channel as a mask.
  68
  69         This is handy for doing things like darkening or lightening an image by overlaying
  70         it with semi-transparent black or white.
  71     */
  72     void setOverlayColour (const Colour& newOverlayColour);
  73
  74     /** Returns the overlay colour. */
  75     const Colour& getOverlayColour() const noexcept             { return overlayColour; }
  76
  77     /** Sets the bounding box within which the image should be displayed. */
  78     void setBoundingBox (const RelativeParallelogram& newBounds);
  79
  80     /** Returns the position to which the image's top-left corner should be remapped in the target
  81         coordinate space when rendering this object.
  82         @see setTransform
  83     */
  84     const RelativeParallelogram& getBoundingBox() const noexcept        { return bounds; }
  85
  86     //==============================================================================
  87     /** @internal */
  88     void paint (Graphics& g);
  89     /** @internal */
  90     bool hitTest (int x, int y);
  91     /** @internal */
  92     Drawable* createCopy() const;
  93     /** @internal */
  94     Rectangle<float> getDrawableBounds() const;
  95     /** @internal */
  96     void refreshFromValueTree (const ValueTree& tree, ComponentBuilder& builder);
  97     /** @internal */
  98     ValueTree createValueTree (ComponentBuilder::ImageProvider* imageProvider) const;
  99     /** @internal */
 100     static const Identifier valueTreeType;
 101
 102     //==============================================================================
 103     /** Internally-used class for wrapping a DrawableImage's state into a ValueTree. */
 104     class ValueTreeWrapper   : public Drawable::ValueTreeWrapperBase
 105     {
 106     public:
 107         ValueTreeWrapper (const ValueTree& state);
 108
 109         var getImageIdentifier() const;
 110         void setImageIdentifier (const var& newIdentifier, UndoManager* undoManager);
 111         Value getImageIdentifierValue (UndoManager* undoManager);
 112
 113         float getOpacity() const;
 114         void setOpacity (float newOpacity, UndoManager* undoManager);
 115         Value getOpacityValue (UndoManager* undoManager);
 116
 117         const Colour getOverlayColour() const;
 118         void setOverlayColour (const Colour& newColour, UndoManager* undoManager);
 119         Value getOverlayColourValue (UndoManager* undoManager);
 120
 121         RelativeParallelogram getBoundingBox() const;
 122         void setBoundingBox (const RelativeParallelogram& newBounds, UndoManager* undoManager);
 123
 124         static const Identifier opacity, overlay, image, topLeft, topRight, bottomLeft;
 125     };
 126
 127 private:
 128     //==============================================================================
 129     Image image;
 130     float opacity;
 131     Colour overlayColour;
 132     RelativeParallelogram bounds;
 133
 134     friend class Drawable::Positioner<DrawableImage>;
 135     bool registerCoordinates (RelativeCoordinatePositionerBase&);
 136     void recalculateCoordinates (Expression::Scope*);
 137
 138     DrawableImage& operator= (const DrawableImage&);
 139     JUCE_LEAK_DETECTOR (DrawableImage);
 140 };
 141
 142
 143 #endif   // __JUCE_DRAWABLEIMAGE_JUCEHEADER__