line_ending.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#pragma once
 
#include <math/vector2d.h>
#include <geometry/eda_angle.h>
#include <stroke_params.h>
#include <wx/string.h>
 
class OUTPUTFORMATTER;
class PLOTTER;
struct EDA_IU_SCALE;
 
namespace KIGFX
{
class GAL;
}

enum class LINE_ENDING_STYLE
{
    NONE = 0,
    ARROW,
    CIRCLE,
    SQUARE,
    ARROW_OPEN,
};
 

class LINE_ENDING
{
public:
    LINE_ENDING() :
            m_style( LINE_ENDING_STYLE::NONE ),
            m_length( 0 ),
            m_width( 0 ),
            m_stroke( 0, LINE_STYLE::DEFAULT, KIGFX::COLOR4D::UNSPECIFIED )
    {
    }
 
    LINE_ENDING( LINE_ENDING_STYLE aStyle, int aLength = 0, int aWidth = 0,
                 int aStrokeWidth = 0 ) :
            m_style( aStyle ),
            m_length( aLength ),
            m_width( aWidth ),
            m_stroke( aStrokeWidth, LINE_STYLE::DEFAULT, KIGFX::COLOR4D::UNSPECIFIED )
    {
    }
 
    LINE_ENDING_STYLE GetStyle() const { return m_style; }
    void SetStyle( LINE_ENDING_STYLE aStyle ) { m_style = aStyle; }
 
    int GetLength() const { return m_length; }     
    void SetLength( int aLength ) { m_length = aLength; }
 
    int GetWidth() const { return m_width; }        
    void SetWidth( int aWidth ) { m_width = aWidth; }
 
    void SetUniformSize( int aSize )
    {
        m_length = aSize;
        m_width = aSize;
    }

    int GetStrokeWidth() const { return m_stroke.GetWidth(); }
    void SetStrokeWidth( int aWidth ) { m_stroke.SetWidth( aWidth ); }
 
    const STROKE_PARAMS& GetStroke() const { return m_stroke; }
    void SetStroke( const STROKE_PARAMS& aStroke ) { m_stroke = aStroke; }

    VECTOR2I GetEffectiveSize( int aLineWidth ) const;

    int GetShortenDepth( int aLineWidth ) const;

    int GetCurveOrientationDepth( int aLineWidth ) const;

    void GetShapes( const VECTOR2I& aPoint, const EDA_ANGLE& aTangent,
                    int aLineWidth, std::vector<VECTOR2I>& aPolygon ) const;
 
    bool operator==( const LINE_ENDING& aOther ) const;
    bool operator!=( const LINE_ENDING& aOther ) const { return !( *this == aOther ); }
 
    void Draw( KIGFX::GAL& aGal, const VECTOR2I& aPoint, const EDA_ANGLE& aTangent,
               double aLineWidth, const KIGFX::COLOR4D& aColor ) const;
 
    void Plot( PLOTTER* aPlotter, const VECTOR2I& aPoint, const EDA_ANGLE& aTangent,
               int aLineWidth, void* aData = nullptr ) const;
 
    void Format( OUTPUTFORMATTER* aOut, const EDA_IU_SCALE& aIuScale,
                 const char* aToken ) const;
 
    static wxString StyleToToken( LINE_ENDING_STYLE aStyle );
    static LINE_ENDING_STYLE TokenToStyle( const wxString& aToken );
 
    static constexpr double DEFAULT_RATIO_LENGTH = 5.0;
    static constexpr double DEFAULT_RATIO_WIDTH = 5.0;

    static const LINE_ENDING_STYLE s_defaultChoiceOrder[];
    static const int               s_defaultChoiceCount;

    static int StyleToChoiceIndex( LINE_ENDING_STYLE aStyle );
 
private:
    LINE_ENDING_STYLE m_style;
    int               m_length;         
    int               m_width;          
    STROKE_PARAMS     m_stroke;
};