plotter_dxf.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 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 <cstdint>
 
#include "plotter.h"

enum class DXF_COLOR_T
{
    BLACK = 0,
    RED,
    YELLOW,
    GREEN,
    CYAN,
    BLUE,
    MAGENTA,
    WHITE,
    BROWN,
    ORANGE,
    LIGHTRED,
    LIGHTYELLOW,
    LIGHTGREEN,
    LIGHTCYAN,
    LIGHTBLUE,
    LIGHTMAGENTA,
    LIGHTORANGE,
    LIGHTGRAY,
    DARKRED,
    DARKYELLOW,
    DARKGREEN,
    DARKCYAN,
    DARKBLUE,
    DARKMAGENTA,
    DARKBROWN,
    DARKORANGE,
    DARKGRAY,
    PURERED,
    PUREYELLOW,
    PUREGREEN,
    PURECYAN,
    PUREBLUE,
    PUREMAGENTA,
    PUREORANGE,
    PUREGRAY,
    REDONE,
    REDTWO,
    REDTHREE,
    REDFOUR,
    REDFIVE,
    REDSIX,
    ORANGEONE,
    ORANGETWO,
    ORANGETHREE,
    ORANGEFOUR,
    ORANGEFIVE,
    REDSEVEN,
    REDEIGHT,
    ORANGESIX,
    REDNINE,
    ORANGESEVEN,
    ORANGEEIGHT,
    ORANGENINE,
    ORANGETEN,
    ORANGEELEVEN,
    ORANGETWELVE,
    ORANGETHIRTEEN,
    ORANGEFOURTEEN,
    YELLOWONE,
    YELLOWTWO,
    YELLOWTHREE,
    YELLOWFOUR,
    YELLOWFIVE,
    YELLOWSIX,
    YELLOWSEVEN,
    YELLOWEIGHT,
    YELLOWNINE,
    YELLOWTEN,
    YELLOWELEVEN,
    YELLOWTWELVE,
    YELLOWTHIRTEEN,
    YELLOWFOURTEEN,
    GREENONE,
    GREENTWO,
    GREENTHREE,
    GREENFOUR,
    GREENFIVE,
    GREENSIX,
    GREENSEVEN,
    GREENEIGHT,
    GREENNINE,
    GREENTEN,
    GREENELEVEN,
    GREENTWELVE,
    GREENTHIRTEEN,
    GREENFOURTEEN,
    GREENFIFTEEN,
    GREENSIXTEEN,
    GREENSEVENTEEN,
    GREENEIGHTEEN,
    GREENNINETEEN,
    GREENTWENTY,
    GREENTWENTYONE,
    GREENTWENTYTWO,
    GREENTWENTYTHREE,
    GREENTWENTYFOUR,
    GREENTWENTYFIVE,
    GREENTWENTYSIX,
    GREENTWENTYSEVEN,
    GREENTWENTYEIGHT,
    GREENTWENTYNINE,
    GREENTHIRTY,
    GREENTHIRTYONE,
    GREENTHIRTYTWO,
    GREENTHIRTYTHREE,
    GREENTHIRTYFOUR,
    GREENTHIRTYFIVE,
    GREENTHIRTYSIX,
    GREENTHIRTYSEVEN,
    GREENTHIRTYEIGHT,
    GREENTHIRTYNINE,
    GREENFORTY,
    GREENFORTYONE,
    GREENFORTYTWO,
    GREENFORTYTHREE,
    GREENFORTYFOUR,
    GREENFORTYFIVE,
    GREENFORTYSIX,
    GREENFORTYSEVEN,
    GREENFORTYEIGHT,
    GREENFORTYNINE,
    GREENFIFTY,
    GREENFIFTYONE,
    GREENFIFTYTWO,
    GREENFIFTYTHREE,
    GREENFIFTYFOUR,
    GREENFIFTYFIVE,
    GREENFIFTYSIX,
    GREENFIFTYSEVEN,
    GREENFIFTYEIGHT,
    GREENFIFTYNINE,
    GREENSIXTY,
    GREENSIXTYONE,
    GREENSIXTYTWO,
    GREENSIXTYTHREE,
    GREENSIXTYFOUR,
    GREENSIXTYFIVE,
    CYANONE,
    CYANTWO,
    CYANTHREE,
    CYANFOUR,
    CYANFIVE,
    CYANSIX,
    CYANSEVEN,
    BLUEONE,
    BLUETWO,
    BLUETHREE,
    BLUEFOUR,
    BLUEFIVE,
    BLUESIX,
    BLUESEVEN,
    BLUEEIGHT,
    BLUENINE,
    BLUETEN,
    BLUEELEVEN,
    BLUETWELVE,
    BLUETHIRTEEN,
    BLUEFOURTEEN,
    BLUEFIFTEEN,
    BLUESIXTEEN,
    BLUESEVENTEEN,
    BLUEEIGHTEEN,
    BLUENINETEEN,
    BLUETWENTY,
    BLUETWENTYONE,
    BLUETWENTYTWO,
    BLUETWENTYTHREE,
    BLUETWENTYFOUR,
    BLUETWENTYFIVE,
    BLUETWENTYSIX,
    BLUETWENTYSEVEN,
    BLUETWENTYEIGHT,
    BLUETWENTYNINE,
    BLUETHIRTY,
    BLUETHIRTYONE,
    BLUETHIRTYTWO,
    BLUETHIRTYETHREE,
    BLUETHIRTYFOUR,
    VIOLETONE,
    VIOLETTWO,
    VIOLETTHREE,
    VIOLETFOUR,
    VIOLETFIVE,
    VIOLETSIX,
    VIOLETSEVEN,
    VIOLETEIGHT,
    VIOLETNINE,
    VIOLETTEN,
    VIOLETELEVEN,
    VIOLETTWELVE,
    VIOLETTHIRTEEN,
    VIOLETFOURTEEN,
    VIOLETFIFTEEN,
    VIOLETSIXTEEN,
    VIOLETSEVENTEEN,
    VIOLETEIGHTEEN,
    VIOLETNINETEEN,
    VIOLETTWENTY,
    VIOLETTWENTYONE,
    VIOLETTWENTYTWO,
    VIOLETTWENTYTHREE,
    VIOLETTWENTYFOUR,
    VIOLETTWENTYFIVE,
    VIOLETTWENTYSIX,
    VIOLETTWENTYSEVEN,
    VIOLETTWENTYEIGHT,
    VIOLETTWENTYNINE,
    VIOLETTHIRTY,
    MAGENTAONE,
    MAGENTATWO,
    MAGENTATHREE,
    MAGENTAFOUR,
    MAGENTAFIVE,
    MAGENTASIX,
    MAGENTASEVEN,
    MAGENTAEIGHT,
    MAGENTANINE,
    MAGENTATEN,
    MAGENTAELEVEN,
    MAGENTATWELVE,
    MAGENTATHIRTEEN,
    MAGENTAFOURTEEN,
    REDTEN,
    REDELEVEN,
    VIOLETTHIRTYONE,
    REDTWELVE,
    REDTHIRTEEN,
    REDFOURTEEN,
    REDFIFTEEN,
    REDSIXTEEN,
    REDSEVENTEEN,
    REDEIGHTEEN,
    REDNINETEEN,
    REDTWENTY,
    REDTWENTYONE,
    REDTWENTYTWO,
    REDTWENTYTHREE,
    REDTWENTYFOUR,
    REDTWENTYFIVE,
    REDTWENTYSIX,
    REDTWENTYSEVEN,
    REDTWENTYEIGHT,
    REDTWENTYNINE,
    REDTHIRTY,
    REDTHIRTYONE,
    GRAYONE,
    GRAYTWO,
    GRAYTHREE,
    GRAYFOUR,
    NBCOLORS  
};
 
class DXF_PLOTTER : public PLOTTER
{
public:
    DXF_PLOTTER() :
            m_textAsLines( false )
    {
        m_textAsLines = true;
        m_currentColor = COLOR4D::BLACK;
        m_currentLineType = LINE_STYLE::SOLID;
        SetUnits( DXF_UNITS::INCH );
    }
 
    virtual PLOT_FORMAT GetPlotterType() const override
    {
        return PLOT_FORMAT::DXF;
    }
 
    static wxString GetDefaultFileExtension()
    {
        return wxString( wxT( "dxf" ) );
    }

    virtual void SetTextMode( PLOT_TEXT_MODE mode ) override
    {
        if( mode != PLOT_TEXT_MODE::DEFAULT )
            m_textAsLines = ( mode != PLOT_TEXT_MODE::NATIVE );
    }

    virtual bool StartPlot( const wxString& aPageNumber ) override;
    virtual bool EndPlot() override;
 
    // For now we don't use 'thick' primitives, so no line width
    virtual void SetCurrentLineWidth( int width, void* aData = nullptr ) override
    {
        m_currentPenWidth = 0;
    }
 
    virtual void SetDash( int aLineWidth, LINE_STYLE aLineStyle ) override;

    virtual void SetColor( const COLOR4D& color ) override;

    virtual void SetViewport( const VECTOR2I& aOffset, double aIusPerDecimil,
                              double aScale, bool aMirror ) override;

    virtual void Rect( const VECTOR2I& p1, const VECTOR2I& p2, FILL_T fill, int width,
                       int aCornerRadius = 0 ) override;

    virtual void Circle( const VECTOR2I& pos, int diametre, FILL_T fill, int width ) override;
 
    virtual void Arc( const VECTOR2D& aCenter, const EDA_ANGLE& aStartAngle,
                      const EDA_ANGLE& aAngle, double aRadius, FILL_T aFill, int aWidth ) override;

    virtual void PlotPoly( const std::vector<VECTOR2I>& aCornerList, FILL_T aFill, int aWidth,
                           void* aData = nullptr ) override;
 
    virtual void PlotPoly( const SHAPE_LINE_CHAIN& aLineChain, FILL_T aFill, int aWidth,
                           void* aData = nullptr ) override;
 
    virtual void ThickSegment( const VECTOR2I& start, const VECTOR2I& end, int width,
                               void* aData ) override;
 
    virtual void ThickArc( const VECTOR2D& aCentre, const EDA_ANGLE& aStAngle, const EDA_ANGLE& aAngle,
                           double aRadius, int aWidth, void* aData ) override;
 
    virtual void ThickRect( const VECTOR2I& p1, const VECTOR2I& p2, int width, void* aData ) override;
 
    virtual void ThickCircle( const VECTOR2I& pos, int diametre, int width, void* aData ) override;
 
    virtual void FilledCircle( const VECTOR2I& pos, int diametre, void* aData ) override;
 
    virtual void ThickPoly( const SHAPE_POLY_SET& aPoly, int aWidth, void* aData ) override;
 
    virtual void PenTo( const VECTOR2I& pos, char plume ) override;

    virtual void FlashPadCircle( const VECTOR2I& pos, int diametre, void* aData ) override;

    virtual void FlashPadOval( const VECTOR2I& aPos, const VECTOR2I& aSize,
                               const EDA_ANGLE& aOrient, void* aData ) override;

    virtual void FlashPadRect( const VECTOR2I& aPos, const VECTOR2I& aSize,
                               const EDA_ANGLE& aOrient, void* aData ) override;
    virtual void FlashPadRoundRect( const VECTOR2I& aPadPos, const VECTOR2I& aSize,
                                    int aCornerRadius, const EDA_ANGLE& aOrient,
                                    void* aData ) override;
    virtual void FlashPadCustom( const VECTOR2I& aPadPos, const VECTOR2I& aSize,
                                 const EDA_ANGLE& aOrient, SHAPE_POLY_SET* aPolygons,
                                 void* aData ) override;

    virtual void FlashPadTrapez( const VECTOR2I& aPadPos, const VECTOR2I* aCorners,
                                 const EDA_ANGLE& aPadOrient, void* aData ) override;
    virtual void FlashRegularPolygon( const VECTOR2I& aShapePos, int aDiameter, int aCornerCount,
                                      const EDA_ANGLE& aOrient, void* aData ) override;
 
    virtual void Text( const VECTOR2I&        aPos,
                       const COLOR4D&         aColor,
                       const wxString&        aText,
                       const EDA_ANGLE&       aOrient,
                       const VECTOR2I&        aSize,
                       enum GR_TEXT_H_ALIGN_T aH_justify,
                       enum GR_TEXT_V_ALIGN_T aV_justify,
                       int                    aWidth,
                       bool                   aItalic,
                       bool                   aBold,
                       bool                   aMultilineAllowed,
                       KIFONT::FONT*          aFont,
                       const KIFONT::METRICS& aFontMetrics,
                       void*                  aData = nullptr ) override;
 
    virtual void PlotText( const VECTOR2I&        aPos,
                           const COLOR4D&         aColor,
                           const wxString&        aText,
                           const TEXT_ATTRIBUTES& aAttributes,
                           KIFONT::FONT*          aFont,
                           const KIFONT::METRICS& aFontMetrics,
                           void*                  aData = nullptr ) override;

    void SetUnits( DXF_UNITS aUnit );

    DXF_UNITS GetUnits() const
    {
        return m_plotUnits;
    }

    double GetUnitScaling() const
    {
        return m_unitScalingFactor;
    }

    unsigned int GetMeasurementDirective() const
    {
        return m_measurementDirective;
    }

    unsigned int GetInsUnits() const
    {
        return m_insUnits;
    }
 
    // Finds the nearest legacy color to the given RGB values (aR, aG, aB).
    int FindNearestLegacyColor( int aR, int aG, int aB );
 
    // Retrieves the current layer name based on the output mode and optional layer ID.
    wxString GetCurrentLayerName( DXF_LAYER_OUTPUT_MODE aMode, std::optional<PCB_LAYER_ID> aLayerId = std::nullopt );
 
protected:
    void plotOneLineOfText( const VECTOR2I& aPos, const COLOR4D& aColor, const wxString& aText,
                            const TEXT_ATTRIBUTES& aAttrs );
 
    // Allocate the next DXF object handle.  Handle 0 is reserved by the spec.
    std::string nextHandle();
 
    // Emit the R2000 entity prologue (opcode + handle + owner + AcDbEntity/layer +
    // optional subclass) and return the allocated handle.  Empty aOwner defaults to
    // the *Model_Space BLOCK_RECORD.  Pass nullptr for aSubclass on SEQEND.
    std::string emitEntityHandle( const char* aEntityType, const char* aSubclass,
                                  const std::string& aLayerName,
                                  const std::string& aOwner = "" );
 
    // Writes the OBJECTS section that closes the BLOCK_RECORD 340 references.  Called
    // from EndPlot() between ENTITIES/ENDSEC and EOF.
    void writeObjectsSection();
 
    // Emit the standard symbol-table header (TABLE, name, handle, owner, subclass,
    // count) and return the table handle for use as the 330 owner of child records.
    std::string emitSymbolTableHeader( const char* aTableName, int aCount );
 
    bool         m_textAsLines;
    COLOR4D      m_currentColor;
    LINE_STYLE   m_currentLineType;
 
    DXF_UNITS    m_plotUnits;
    double       m_unitScalingFactor;
    unsigned int m_measurementDirective;
    unsigned int m_insUnits;
 
    // Monotonic handle counter; zero is reserved by the DXF spec.  64-bit so even
    // pathological multi-million-entity exports cannot wrap into the reserved 0 handle.
    uint64_t     m_handle = 0;
 
    // BLOCK_RECORD handle for the *Model_Space layout; cached so every entity can
    // reference it as its 330 owner tag.
    std::string  m_modelSpaceHandle;
 
    // Layout bookkeeping carried from StartPlot to EndPlot so the OBJECTS section can
    // emit one LAYOUT object per BLOCK_RECORD with the matching 330 back-pointer.
    struct DxfLayout
    {
        std::string name;              // "Model" / "Layout1" / "Layout2"
        std::string blockName;         // "*Model_Space" / "*Paper_Space" / "*Paper_Space0"
        std::string blockRecordHandle; // BLOCK_RECORD entry handle
        std::string layoutHandle;      // LAYOUT object handle (in OBJECTS section)
        bool        isPaperSpace;
    };
 
    std::vector<DxfLayout> m_dxfLayouts;
    std::string            m_namedObjectDictHandle;
    std::string            m_layoutDictHandle;
    std::string            m_plotStyleNameDictHandle;
    std::string            m_plotStyleNormalHandle;
};