juce_PathStrokeType.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission is granted to use this software under the terms of either:
   a) the GPL v2 (or any later version)
   b) the Affero GPL v3
 
   Details of these licenses can be found at: www.gnu.org/licenses
 
   JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
   A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 
   ------------------------------------------------------------------------------
 
   To release a closed-source product which uses JUCE, commercial licenses are
   available: visit www.juce.com for more information.
 
  ==============================================================================
*/
 
#ifndef JUCE_PATHSTROKETYPE_H_INCLUDED
#define JUCE_PATHSTROKETYPE_H_INCLUDED
 
 
//==============================================================================
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::identity,
                            float extraAccuracy = 1.0f) const;
 
 
    //==============================================================================
    void createDashedStroke (Path& destPath,
                             const Path& sourcePath,
                             const float* dashLengths,
                             int numDashLengths,
                             const AffineTransform& transform = AffineTransform::identity,
                             float extraAccuracy = 1.0f) const;
 
    //==============================================================================
    void createStrokeWithArrowheads (Path& destPath,
                                     const Path& sourcePath,
                                     float arrowheadStartWidth, float arrowheadStartLength,
                                     float arrowheadEndWidth, float arrowheadEndLength,
                                     const AffineTransform& transform = AffineTransform::identity,
                                     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)
};
 
#endif   // JUCE_PATHSTROKETYPE_H_INCLUDED