source/modules/juce_gui_basics/drawables/juce_Drawable.cpp

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library.
   5    Copyright (c) 2022 - Raw Material Software Limited
   6
   7    JUCE is an open source library subject to commercial or open-source
   8    licensing.
   9
  10    By using JUCE, you agree to the terms of both the JUCE 7 End-User License
  11    Agreement and JUCE Privacy Policy.
  12
  13    End User License Agreement: www.juce.com/juce-7-licence
  14    Privacy Policy: www.juce.com/juce-privacy-policy
  15
  16    Or: You may also use this code under the terms of the GPL v3 (see
  17    www.gnu.org/licenses).
  18
  19    JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
  20    EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
  21    DISCLAIMED.
  22
  23   ==============================================================================
  24 */
  25
  26 namespace juce
  27 {
  28
  29 Drawable::Drawable()
  30 {
  31     setInterceptsMouseClicks (false, false);
  32     setPaintingIsUnclipped (true);
  33     setAccessible (false);
  34 }
  35
  36 Drawable::Drawable (const Drawable& other)
  37     : Component (other.getName())
  38 {
  39     setInterceptsMouseClicks (false, false);
  40     setPaintingIsUnclipped (true);
  41     setAccessible (false);
  42
  43     setComponentID (other.getComponentID());
  44     setTransform (other.getTransform());
  45
  46     if (auto* clipPath = other.drawableClipPath.get())
  47         setClipPath (clipPath->createCopy());
  48 }
  49
  50 Drawable::~Drawable()
  51 {
  52 }
  53
  54 void Drawable::applyDrawableClipPath (Graphics& g)
  55 {
  56     if (drawableClipPath != nullptr)
  57     {
  58         auto clipPath = drawableClipPath->getOutlineAsPath();
  59
  60         if (! clipPath.isEmpty())
  61             g.getInternalContext().clipToPath (clipPath, {});
  62     }
  63 }
  64
  65 //==============================================================================
  66 void Drawable::draw (Graphics& g, float opacity, const AffineTransform& transform) const
  67 {
  68     const_cast<Drawable*> (this)->nonConstDraw (g, opacity, transform);
  69 }
  70
  71 void Drawable::nonConstDraw (Graphics& g, float opacity, const AffineTransform& transform)
  72 {
  73     Graphics::ScopedSaveState ss (g);
  74
  75     g.addTransform (AffineTransform::translation ((float) -(originRelativeToComponent.x),
  76                                                   (float) -(originRelativeToComponent.y))
  77                         .followedBy (getTransform())
  78                         .followedBy (transform));
  79
  80     applyDrawableClipPath (g);
  81
  82     if (! g.isClipEmpty())
  83     {
  84         if (opacity < 1.0f)
  85         {
  86             g.beginTransparencyLayer (opacity);
  87             paintEntireComponent (g, true);
  88             g.endTransparencyLayer();
  89         }
  90         else
  91         {
  92             paintEntireComponent (g, true);
  93         }
  94     }
  95 }
  96
  97 void Drawable::drawAt (Graphics& g, float x, float y, float opacity) const
  98 {
  99     draw (g, opacity, AffineTransform::translation (x, y));
 100 }
 101
 102 void Drawable::drawWithin (Graphics& g, Rectangle<float> destArea,
 103                            RectanglePlacement placement, float opacity) const
 104 {
 105     draw (g, opacity, placement.getTransformToFit (getDrawableBounds(), destArea));
 106 }
 107
 108 //==============================================================================
 109 DrawableComposite* Drawable::getParent() const
 110 {
 111     return dynamic_cast<DrawableComposite*> (getParentComponent());
 112 }
 113
 114 void Drawable::setClipPath (std::unique_ptr<Drawable> clipPath)
 115 {
 116     if (drawableClipPath != clipPath)
 117     {
 118         drawableClipPath = std::move (clipPath);
 119         repaint();
 120     }
 121 }
 122
 123 void Drawable::transformContextToCorrectOrigin (Graphics& g)
 124 {
 125     g.setOrigin (originRelativeToComponent);
 126 }
 127
 128 void Drawable::parentHierarchyChanged()
 129 {
 130     setBoundsToEnclose (getDrawableBounds());
 131 }
 132
 133 void Drawable::setBoundsToEnclose (Rectangle<float> area)
 134 {
 135     Point<int> parentOrigin;
 136
 137     if (auto* parent = getParent())
 138         parentOrigin = parent->originRelativeToComponent;
 139
 140     auto newBounds = area.getSmallestIntegerContainer() + parentOrigin;
 141     originRelativeToComponent = parentOrigin - newBounds.getPosition();
 142     setBounds (newBounds);
 143 }
 144
 145 //==============================================================================
 146 bool Drawable::replaceColour (Colour original, Colour replacement)
 147 {
 148     bool changed = false;
 149
 150     for (auto* c : getChildren())
 151         if (auto* d = dynamic_cast<Drawable*> (c))
 152             changed = d->replaceColour (original, replacement) || changed;
 153
 154     return changed;
 155 }
 156
 157 //==============================================================================
 158 void Drawable::setOriginWithOriginalSize (Point<float> originWithinParent)
 159 {
 160     setTransform (AffineTransform::translation (originWithinParent.x, originWithinParent.y));
 161 }
 162
 163 void Drawable::setTransformToFit (const Rectangle<float>& area, RectanglePlacement placement)
 164 {
 165     if (! area.isEmpty())
 166         setTransform (placement.getTransformToFit (getDrawableBounds(), area));
 167 }
 168
 169 //==============================================================================
 170 std::unique_ptr<Drawable> Drawable::createFromImageData (const void* data, const size_t numBytes)
 171 {
 172     auto image = ImageFileFormat::loadFrom (data, numBytes);
 173
 174     if (image.isValid())
 175         return std::make_unique<DrawableImage> (image);
 176
 177     if (auto svg = parseXMLIfTagMatches (String::createStringFromData (data, (int) numBytes), "svg"))
 178         return Drawable::createFromSVG (*svg);
 179
 180     return {};
 181 }
 182
 183 std::unique_ptr<Drawable> Drawable::createFromImageDataStream (InputStream& dataSource)
 184 {
 185     MemoryOutputStream mo;
 186     mo << dataSource;
 187
 188     return createFromImageData (mo.getData(), mo.getDataSize());
 189 }
 190
 191 std::unique_ptr<Drawable> Drawable::createFromImageFile (const File& file)
 192 {
 193     FileInputStream fin (file);
 194
 195     if (fin.openedOk())
 196         return createFromImageDataStream (fin);
 197
 198     return {};
 199 }
 200
 201 } // namespace juce