juce_GraphicsContext.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  Graphics  final
{
public:
    //==============================================================================
    explicit Graphics (const Image& imageToDrawOnto);
 
    //==============================================================================
    void setColour (Colour newColour);

    void setOpacity (float newOpacity);

    void setGradientFill (const ColourGradient& gradient);

    void setGradientFill (ColourGradient&& gradient);

    void setTiledImageFill (const Image& imageToUse,
                            int anchorX, int anchorY,
                            float opacity);

    void setFillType (const FillType& newFill);
 
    //==============================================================================
    void setFont (const Font& newFont);

    void setFont (float newFontHeight);

    Font getCurrentFont() const;

    void drawSingleLineText (const String& text,
                             int startX, int baselineY,
                             Justification justification = Justification::left) const;

    void drawMultiLineText (const String& text,
                            int startX, int baselineY,
                            int maximumLineWidth,
                            Justification justification = Justification::left,
                            float leading = 0.0f) const;

    void drawText (const String& text,
                   int x, int y, int width, int height,
                   Justification justificationType,
                   bool useEllipsesIfTooBig = true) const;

    void drawText (const String& text,
                   Rectangle<int> area,
                   Justification justificationType,
                   bool useEllipsesIfTooBig = true) const;

    void drawText (const String& text,
                   Rectangle<float> area,
                   Justification justificationType,
                   bool useEllipsesIfTooBig = true) const;

    void drawFittedText (const String& text,
                         int x, int y, int width, int height,
                         Justification justificationFlags,
                         int maximumNumberOfLines,
                         float minimumHorizontalScale = 0.0f) const;

    void drawFittedText (const String& text,
                         Rectangle<int> area,
                         Justification justificationFlags,
                         int maximumNumberOfLines,
                         float minimumHorizontalScale = 0.0f) const;
 
    //==============================================================================
    void fillAll() const;

    void fillAll (Colour colourToUse) const;
 
    //==============================================================================
    void fillRect (Rectangle<int> rectangle) const;

    void fillRect (Rectangle<float> rectangle) const;

    void fillRect (int x, int y, int width, int height) const;

    void fillRect (float x, float y, float width, float height) const;

    void fillRectList (const RectangleList<float>& rectangles) const;

    void fillRectList (const RectangleList<int>& rectangles) const;

    void fillRoundedRectangle (float x, float y, float width, float height,
                               float cornerSize) const;

    void fillRoundedRectangle (Rectangle<float> rectangle,
                               float cornerSize) const;

    void fillCheckerBoard (Rectangle<float> area,
                           float checkWidth, float checkHeight,
                           Colour colour1, Colour colour2) const;

    void drawRect (int x, int y, int width, int height, int lineThickness = 1) const;

    void drawRect (float x, float y, float width, float height, float lineThickness = 1.0f) const;

    void drawRect (Rectangle<int> rectangle, int lineThickness = 1) const;

    void drawRect (Rectangle<float> rectangle, float lineThickness = 1.0f) const;

    void drawRoundedRectangle (float x, float y, float width, float height,
                               float cornerSize, float lineThickness) const;

    void drawRoundedRectangle (Rectangle<float> rectangle,
                               float cornerSize, float lineThickness) const;
 
    //==============================================================================
    void fillEllipse (float x, float y, float width, float height) const;

    void fillEllipse (Rectangle<float> area) const;

    void drawEllipse (float x, float y, float width, float height,
                      float lineThickness) const;

    void drawEllipse (Rectangle<float> area, float lineThickness) const;
 
    //==============================================================================
    void drawLine (float startX, float startY, float endX, float endY) const;

    void drawLine (float startX, float startY, float endX, float endY, float lineThickness) const;

    void drawLine (Line<float> line) const;

    void drawLine (Line<float> line, float lineThickness) const;

    void drawDashedLine (Line<float> line,
                         const float* dashLengths, int numDashLengths,
                         float lineThickness = 1.0f,
                         int dashIndexToStartFrom = 0) const;

    void drawVerticalLine (int x, float top, float bottom) const;

    void drawHorizontalLine (int y, float left, float right) const;
 
    //==============================================================================
    void fillPath (const Path& path) const;

    void fillPath (const Path& path, const AffineTransform& transform) const;

    void strokePath (const Path& path,
                     const PathStrokeType& strokeType,
                     const AffineTransform& transform = {}) const;

    void drawArrow (Line<float> line,
                    float lineThickness,
                    float arrowheadWidth,
                    float arrowheadLength) const;
 
 
    //==============================================================================
    enum ResamplingQuality
    {
        lowResamplingQuality     = 0,    
        mediumResamplingQuality  = 1,    
        highResamplingQuality    = 2,    
    };

    void setImageResamplingQuality (const ResamplingQuality newQuality);

    void drawImageAt (const Image& imageToDraw, int topLeftX, int topLeftY,
                      bool fillAlphaChannelWithCurrentBrush = false) const;

    void drawImage (const Image& imageToDraw,
                    int destX, int destY, int destWidth, int destHeight,
                    int sourceX, int sourceY, int sourceWidth, int sourceHeight,
                    bool fillAlphaChannelWithCurrentBrush = false) const;

    void drawImageTransformed (const Image& imageToDraw,
                               const AffineTransform& transform,
                               bool fillAlphaChannelWithCurrentBrush = false) const;

    void drawImage (const Image& imageToDraw, Rectangle<float> targetArea,
                    RectanglePlacement placementWithinTarget = RectanglePlacement::stretchToFit,
                    bool fillAlphaChannelWithCurrentBrush = false) const;

    void drawImageWithin (const Image& imageToDraw,
                          int destX, int destY, int destWidth, int destHeight,
                          RectanglePlacement placementWithinTarget,
                          bool fillAlphaChannelWithCurrentBrush = false) const;
 
    //==============================================================================
    Rectangle<int> getClipBounds() const;

    bool clipRegionIntersects (Rectangle<int> area) const;

    bool reduceClipRegion (int x, int y, int width, int height);

    bool reduceClipRegion (Rectangle<int> area);

    bool reduceClipRegion (const RectangleList<int>& clipRegion);

    bool reduceClipRegion (const Path& path, const AffineTransform& transform = AffineTransform());

    bool reduceClipRegion (const Image& image, const AffineTransform& transform);

    void excludeClipRegion (Rectangle<int> rectangleToExclude);

    bool isClipEmpty() const;
 
    //==============================================================================
    void saveState();

    void restoreState();

    class ScopedSaveState
    {
    public:
        ScopedSaveState (Graphics&);
        ~ScopedSaveState();
 
    private:
        Graphics& context;
        JUCE_DECLARE_NON_COPYABLE (ScopedSaveState)
    };
 
    //==============================================================================
    void beginTransparencyLayer (float layerOpacity);

    void endTransparencyLayer();

    void setOrigin (Point<int> newOrigin);

    void setOrigin (int newOriginX, int newOriginY);

    void addTransform (const AffineTransform& transform);

    void resetToDefaultState();

    bool isVectorDevice() const;
 
    //==============================================================================
    Graphics (LowLevelGraphicsContext&) noexcept;

    LowLevelGraphicsContext& getInternalContext() const noexcept    { return context; }
 
private:
    //==============================================================================
    std::unique_ptr<LowLevelGraphicsContext> contextHolder;
    LowLevelGraphicsContext& context;
 
    bool saveStatePending = false;
    void saveStateIfPending();
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Graphics)
};
 
} // namespace juce