juce_Drawable.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  Drawable  : public Component
{
protected:
    //==============================================================================
    Drawable();
 
public:
    ~Drawable() override;
 
    //==============================================================================
    virtual std::unique_ptr<Drawable> createCopy() const = 0;

    virtual Path getOutlineAsPath() const = 0;
 
    //==============================================================================
    void draw (Graphics& g, float opacity,
               const AffineTransform& transform = AffineTransform()) const;

    void drawAt (Graphics& g, float x, float y, float opacity) const;

    void drawWithin (Graphics& g,
                     Rectangle<float> destArea,
                     RectanglePlacement placement,
                     float opacity) const;
 
 
    //==============================================================================
    void setOriginWithOriginalSize (Point<float> originWithinParent);

    void setTransformToFit (const Rectangle<float>& areaInParent, RectanglePlacement placement);

    DrawableComposite* getParent() const;

    void setClipPath (std::unique_ptr<Drawable> drawableClipPath);
 
    //==============================================================================
    static std::unique_ptr<Drawable> createFromImageData (const void* data, size_t numBytes);

    static std::unique_ptr<Drawable> createFromImageDataStream (InputStream& dataSource);

    static std::unique_ptr<Drawable> createFromImageFile (const File& file);

    static std::unique_ptr<Drawable> createFromSVG (const XmlElement& svgDocument);

    static std::unique_ptr<Drawable> createFromSVGFile (const File& svgFile);

    static Path parseSVGPath (const String& svgPath);
 
    //==============================================================================
    virtual Rectangle<float> getDrawableBounds() const = 0;

    virtual bool replaceColour (Colour originalColour, Colour replacementColour);
 
protected:
    //==============================================================================
    friend class DrawableComposite;
    friend class DrawableShape;

    void transformContextToCorrectOrigin (Graphics&);
    void parentHierarchyChanged() override;
    void setBoundsToEnclose (Rectangle<float>);
    void applyDrawableClipPath (Graphics&);
 
    Point<int> originRelativeToComponent;
    std::unique_ptr<Drawable> drawableClipPath;
 
    void nonConstDraw (Graphics&, float opacity, const AffineTransform&);
 
    Drawable (const Drawable&);
    Drawable& operator= (const Drawable&);
    JUCE_LEAK_DETECTOR (Drawable)
};
 
} // namespace juce