juce_DrawablePath.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_DRAWABLEPATH_H_INCLUDED
#define JUCE_DRAWABLEPATH_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  DrawablePath  : public DrawableShape
{
public:
    //==============================================================================
    DrawablePath();
    DrawablePath (const DrawablePath&);
 
    ~DrawablePath();
 
    //==============================================================================
    void setPath (const Path& newPath);
 
    void setPath (const RelativePointPath& newPath);
 
    const Path& getPath() const;
 
    const Path& getStrokePath() const;
 
    //==============================================================================
    Drawable* createCopy() const;
    void refreshFromValueTree (const ValueTree& tree, ComponentBuilder& builder);
    ValueTree createValueTree (ComponentBuilder::ImageProvider* imageProvider) const;
    static const Identifier valueTreeType;
 
    //==============================================================================
    class ValueTreeWrapper   : public DrawableShape::FillAndStrokeState
    {
    public:
        ValueTreeWrapper (const ValueTree& state);
 
        bool usesNonZeroWinding() const;
        void setUsesNonZeroWinding (bool b, UndoManager* undoManager);
 
        class Element
        {
        public:
            explicit Element (const ValueTree& state);
            ~Element();
 
            const Identifier getType() const noexcept   { return state.getType(); }
            int getNumControlPoints() const noexcept;
 
            RelativePoint getControlPoint (int index) const;
            Value getControlPointValue (int index, UndoManager*);
            RelativePoint getStartPoint() const;
            RelativePoint getEndPoint() const;
            void setControlPoint (int index, const RelativePoint& point, UndoManager*);
            float getLength (Expression::Scope*) const;
 
            ValueTreeWrapper getParent() const;
            Element getPreviousElement() const;
 
            String getModeOfEndPoint() const;
            void setModeOfEndPoint (const String& newMode, UndoManager*);
 
            void convertToLine (UndoManager*);
            void convertToCubic (Expression::Scope*, UndoManager*);
            void convertToPathBreak (UndoManager* undoManager);
            ValueTree insertPoint (Point<float> targetPoint, Expression::Scope*, UndoManager*);
            void removePoint (UndoManager* undoManager);
            float findProportionAlongLine (Point<float> targetPoint, Expression::Scope*) const;
 
            static const Identifier mode, startSubPathElement, closeSubPathElement,
                                    lineToElement, quadraticToElement, cubicToElement;
            static const char* cornerMode;
            static const char* roundedMode;
            static const char* symmetricMode;
 
            ValueTree state;
        };
 
        ValueTree getPathState();
 
        void readFrom (const RelativePointPath& path, UndoManager* undoManager);
        void writeTo (RelativePointPath& path) const;
 
        static const Identifier nonZeroWinding, point1, point2, point3;
    };
 
private:
    //==============================================================================
    ScopedPointer<RelativePointPath> relativePath;
 
    class RelativePositioner;
    friend class RelativePositioner;
    void applyRelativePath (const RelativePointPath&, Expression::Scope*);
 
    DrawablePath& operator= (const DrawablePath&);
    JUCE_LEAK_DETECTOR (DrawablePath)
};
 
 
#endif   // JUCE_DRAWABLEPATH_H_INCLUDED