kicad/common/basic_gal.cpp

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 1992-2021 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
 */

/**
 * Implement a very basic GAL used to draw, plot and convert texts in segments
 * for DRC functions, using the common GAL functions.
 * Draw functions use wxDC.
 * Plot functions use a PLOTTER
 * Convert texts in segments use a callback function created by the caller
 * @file basic_gal.cpp
 */

#include <gr_basic.h>
#include <plotters/plotter.h>
#include <trigo.h>

#include <basic_gal.h>

using namespace KIGFX;

KIGFX::GAL_DISPLAY_OPTIONS basic_displayOptions;

// the basic GAL doesn't get an external display option object
BASIC_GAL basic_gal( basic_displayOptions );


const VECTOR2D BASIC_GAL::transform( const VECTOR2D& aPoint ) const
{
    VECTOR2D point = aPoint + m_transform.m_moveOffset - m_transform.m_rotCenter;
    point = point.Rotate( m_transform.m_rotAngle ) + m_transform.m_rotCenter;
    return point;
}


void BASIC_GAL::doDrawPolyline( const std::vector<VECTOR2I>& aLocalPointList )
{
    if( m_DC )
    {
        if( m_isFillEnabled )
        {
            GRPoly( m_isClipped ? &m_clipBox : nullptr, m_DC, aLocalPointList.size(),
                    &aLocalPointList[0], 0, GetLineWidth(), m_Color, m_Color );
        }
        else
        {
            for( unsigned ii = 1; ii < aLocalPointList.size(); ++ii )
            {
                GRCSegm( m_isClipped ? &m_clipBox : nullptr, m_DC, aLocalPointList[ ii - 1],
                         aLocalPointList[ii], GetLineWidth(), m_Color );
            }
        }
    }
    else if( m_plotter )
    {
        m_plotter->MoveTo( aLocalPointList[0] );

        for( unsigned ii = 1; ii < aLocalPointList.size(); ii++ )
        {
            m_plotter->LineTo( aLocalPointList[ii] );
        }

        m_plotter->PenFinish();
    }
    else if( m_callback )
    {
        for( unsigned ii = 1; ii < aLocalPointList.size(); ii++ )
        {
            m_callback( aLocalPointList[ ii - 1].x, aLocalPointList[ ii - 1].y,
                        aLocalPointList[ii].x, aLocalPointList[ii].y, m_callbackData );
        }
    }
}


void BASIC_GAL::DrawPolyline( const std::deque<VECTOR2D>& aPointList )
{
    if( aPointList.size() < 2 )
        return;

    std::vector<VECTOR2I> polyline_corners;

    for( const VECTOR2D& pt : aPointList )
        polyline_corners.emplace_back( (VECTOR2I) transform( pt ) );

    doDrawPolyline( polyline_corners );
}


void BASIC_GAL::DrawPolyline( const std::vector<VECTOR2D>& aPointList )
{
    if( aPointList.size() < 2 )
        return;

    std::vector<VECTOR2I> polyline_corners;

    for( const VECTOR2D& pt : aPointList )
        polyline_corners.emplace_back( (VECTOR2I) transform( pt ) );

    doDrawPolyline( polyline_corners );
}


void BASIC_GAL::DrawPolyline( const VECTOR2D aPointList[], int aListSize )
{
    if( aListSize < 2 )
        return;

    std::vector<VECTOR2I> polyline_corners;

    for( int ii = 0; ii < aListSize; ++ii )
        polyline_corners.emplace_back( (VECTOR2I) transform( aPointList[ii] ) );

    doDrawPolyline( polyline_corners );
}


void BASIC_GAL::DrawLine( const VECTOR2D& aStartPoint, const VECTOR2D& aEndPoint )
{
    VECTOR2D startVector = transform( aStartPoint );
    VECTOR2D endVector = transform( aEndPoint );

    if( m_DC )
    {
        if( m_isFillEnabled )
        {
            GRLine( m_isClipped ? &m_clipBox : nullptr, m_DC, startVector.x, startVector.y,
                    endVector.x, endVector.y, GetLineWidth(), m_Color );
        }
        else
        {
            GRCSegm( m_isClipped ? &m_clipBox : nullptr, m_DC, startVector.x, startVector.y,
                     endVector.x, endVector.y, GetLineWidth(), 0, m_Color );
        }
    }
    else if( m_plotter )
    {
        m_plotter->MoveTo( wxPoint( startVector.x, startVector.y ) );
        m_plotter->LineTo( wxPoint( endVector.x, endVector.y ) );
        m_plotter->PenFinish();
    }
    else if( m_callback )
    {
        m_callback( startVector.x, startVector.y, endVector.x, endVector.y, m_callbackData );
    }
}


void BASIC_GAL::DrawGlyph( const KIFONT::GLYPH& aGlyph, int aNth, int aTotal )
{
    if( aGlyph.IsStroke() )
    {
        const auto& strokeGlyph = static_cast<const KIFONT::STROKE_GLYPH&>( aGlyph );

        for( const std::vector<VECTOR2D>& pointList : strokeGlyph )
            DrawPolyline( pointList );
    }
#if 0 // FONT TODO
    else if( aGlyph.IsOutline() )
    {
    }
#endif
}