plotter_hpgl.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016-2023 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 3 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, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <list>
 
#include "plotter.h"
 
 
class HPGL_PLOTTER : public PLOTTER
{
public:
    HPGL_PLOTTER();
 
    virtual PLOT_FORMAT GetPlotterType() const override
    {
        return PLOT_FORMAT::HPGL;
    }
 
    static wxString GetDefaultFileExtension()
    {
        return wxString( wxT( "plt" ) );
    }
 
    void SetTargetChordLength( double chord_len );
 
    void SetUserCoords( bool user_coords ) { m_useUserCoords = user_coords; }
 
    void SetUserCoordsFit( bool user_coords_fit ) { m_fitUserCoords = user_coords_fit; }
 
    virtual bool StartPlot( const wxString& aPageNumber ) override;
 
    virtual bool EndPlot() override;
 
    virtual void SetColorMode( bool aColorMode ) override {};
 
    virtual void SetCurrentLineWidth( int width, void* aData = nullptr ) override
    {
        // This is the truth
        m_currentPenWidth = userToDeviceSize( m_penDiameter );
    }
 
    virtual void SetDash( int aLineWidth, LINE_STYLE aLineStyle ) override;
 
    virtual void SetColor( const COLOR4D& color ) override {}
 
    virtual void SetPenSpeed( int speed )
    {
        m_penSpeed = speed;
    }
 
    virtual void SetPenNumber( int number )
    {
        m_penNumber = number;
    }
 
    virtual void SetPenDiameter( double diameter );
 
    virtual void SetViewport( const VECTOR2I& aOffset, double aIusPerDecimil,
                              double aScale, bool aMirror ) override;
    virtual void Rect( const VECTOR2I& p1, const VECTOR2I& p2, FILL_T aFill,
                       int aWidth = USE_DEFAULT_LINE_WIDTH ) override;
    virtual void Circle( const VECTOR2I& aCenter, int aDiameter, FILL_T aFill,
                         int aWidth = USE_DEFAULT_LINE_WIDTH ) override;
    virtual void PlotPoly( const std::vector<VECTOR2I>& aCornerList, FILL_T aFill,
                           int aWidth = USE_DEFAULT_LINE_WIDTH, void* aData = nullptr ) override;
 
    virtual void ThickSegment( const VECTOR2I& start, const VECTOR2I& end, int width,
                               OUTLINE_MODE tracemode, void* aData ) override;
 
    virtual void PenTo( const VECTOR2I& pos, char plume ) override;
 
    virtual void FlashPadCircle( const VECTOR2I& aPadPos, int aDiameter,
                                 OUTLINE_MODE aTraceMode, void* aData ) override;
    virtual void FlashPadOval( const VECTOR2I& aPadPos, const VECTOR2I& aSize,
                               const EDA_ANGLE& aPadOrient, OUTLINE_MODE aTraceMode,
                               void* aData ) override;
    virtual void FlashPadRect( const VECTOR2I& aPadPos, const VECTOR2I& aSize,
                               const EDA_ANGLE& aOrient, OUTLINE_MODE aTraceMode,
                               void* aData ) override;
    virtual void FlashPadRoundRect( const VECTOR2I& aPadPos, const VECTOR2I& aSize,
                                    int aCornerRadius, const EDA_ANGLE& aOrient,
                                    OUTLINE_MODE aTraceMode, void* aData ) override;
    virtual void FlashPadCustom( const VECTOR2I& aPadPos, const VECTOR2I& aSize,
                                 const EDA_ANGLE& aOrient, SHAPE_POLY_SET* aPolygons,
                                 OUTLINE_MODE aTraceMode, void* aData ) override;
    virtual void FlashPadTrapez( const VECTOR2I& aPadPos, const VECTOR2I* aCorners,
                                 const EDA_ANGLE& aPadOrient, OUTLINE_MODE aTraceMode,
                                 void* aData ) override;
    virtual void FlashRegularPolygon( const VECTOR2I& aShapePos, int aDiameter, int aCornerCount,
                                      const EDA_ANGLE& aOrient, OUTLINE_MODE aTraceMode,
                                      void* aData ) override;
 
protected:
    virtual void Arc( const VECTOR2D& aCenter, const EDA_ANGLE& aStartAngle,
                      const EDA_ANGLE& aAngle, double aRadius, FILL_T aFill,
                      int aWidth = USE_DEFAULT_LINE_WIDTH ) override;
 
    bool startItem( const VECTOR2D& location );
 
    void flushItem();
 
    bool startOrAppendItem( const VECTOR2D& location, const wxString& content );
 
    struct HPGL_ITEM
    {
        HPGL_ITEM() :
            lift_before( false ),
            lift_after( false ),
            pen_returns( false ),
            pen( 0 ),
            dashType( LINE_STYLE::SOLID ) {}
 
        VECTOR2D   loc_start;
 
        VECTOR2D   loc_end;
 
        BOX2D      bbox;
 
        bool       lift_before;
 
        bool       lift_after;
 
        bool       pen_returns;
 
        int        pen;            
        LINE_STYLE dashType;       
        wxString   content;        
    };
 
    static void sortItems( std::list<HPGL_ITEM>& items );
 
    static const char* lineStyleCommand( LINE_STYLE aLineStyle );
 
protected:
    int                  m_penSpeed;
    int                  m_penNumber;
    double               m_penDiameter;
    double               m_arcTargetChordLength;
    EDA_ANGLE            m_arcMinChordDegrees;
    LINE_STYLE           m_lineStyle;
    bool                 m_useUserCoords;
    bool                 m_fitUserCoords;
 
    std::list<HPGL_ITEM> m_items;
    HPGL_ITEM*           m_current_item;
};