juce_PathStrokeType.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  PathStrokeType
{
public:
    //==============================================================================
    enum JointStyle
    {
        mitered,    
        curved,     
        beveled     
    };

    enum EndCapStyle
    {
        butt,       
        square,     
        rounded     
    };
 
    //==============================================================================
    explicit PathStrokeType (float strokeThickness) noexcept;

    PathStrokeType (float strokeThickness,
                    JointStyle jointStyle,
                    EndCapStyle endStyle = butt) noexcept;

    PathStrokeType (const PathStrokeType&) noexcept;

    PathStrokeType& operator= (const PathStrokeType&) noexcept;

    ~PathStrokeType() noexcept;
 
    //==============================================================================
    void createStrokedPath (Path& destPath,
                            const Path& sourcePath,
                            const AffineTransform& transform = AffineTransform(),
                            float extraAccuracy = 1.0f) const;
 
 
    //==============================================================================
    void createDashedStroke (Path& destPath,
                             const Path& sourcePath,
                             const float* dashLengths,
                             int numDashLengths,
                             const AffineTransform& transform = AffineTransform(),
                             float extraAccuracy = 1.0f) const;
 
    //==============================================================================
    void createStrokeWithArrowheads (Path& destPath,
                                     const Path& sourcePath,
                                     float arrowheadStartWidth, float arrowheadStartLength,
                                     float arrowheadEndWidth, float arrowheadEndLength,
                                     const AffineTransform& transform = AffineTransform(),
                                     float extraAccuracy = 1.0f) const;
 
    //==============================================================================
    float getStrokeThickness() const noexcept                   { return thickness; }

    void setStrokeThickness (float newThickness) noexcept       { thickness = newThickness; }

    JointStyle getJointStyle() const noexcept                   { return jointStyle; }

    void setJointStyle (JointStyle newStyle) noexcept           { jointStyle = newStyle; }

    EndCapStyle getEndStyle() const noexcept                    { return endStyle; }

    void setEndStyle (EndCapStyle newStyle) noexcept            { endStyle = newStyle; }
 
    //==============================================================================
    bool operator== (const PathStrokeType&) const noexcept;

    bool operator!= (const PathStrokeType&) const noexcept;
 
private:
    //==============================================================================
    float thickness;
    JointStyle jointStyle;
    EndCapStyle endStyle;
 
    JUCE_LEAK_DETECTOR (PathStrokeType)
};
 
} // namespace juce