ds_proxy_view_item.h

Go to the documentation of this file.

/*
 * This program source code file is part of KICAD, a free EDA CAD application.
 *
 * Copyright (C) 2013 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 * @author Maciej Suminski <[email protected]>
 *
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef DS_PROXY_VIEW_ITEM_H
#define DS_PROXY_VIEW_ITEM_H
 
#include <eda_item.h>
#include <eda_units.h>
#include <functional>
#include <memory>
#include <vector>
 
class BOARD;
class PAGE_INFO;
class PROJECT;
class TITLE_BLOCK;
class DS_DRAW_ITEM_LINE;
class DS_DRAW_ITEM_RECT;
class DS_DRAW_ITEM_TEXT;
class DS_DRAW_ITEM_BITMAP;
class DS_DRAW_ITEM_LIST;
class TEXT_VAR_TRACKER;
struct TEXT_VAR_REF_KEY;
 
namespace KIGFX
{
class VIEW;
class GAL;
class DS_PAINTER;
}
 
class DS_PROXY_VIEW_ITEM : public EDA_ITEM
{
public:
    DS_PROXY_VIEW_ITEM( const EDA_IU_SCALE& aIuScale, const PAGE_INFO* aPageInfo,
                        const PROJECT* aProject, const TITLE_BLOCK* aTitleBlock,
                        const std::map<wxString, wxString>* aProperties );

    void SetFileName( const std::string& aFileName ) { m_fileName = aFileName; }

    void SetSheetName( const std::string& aSheetName ) { m_sheetName = aSheetName; }

    void SetSheetPath( const std::string& aSheetPath ) { m_sheetPath = aSheetPath; }

    void SetPageNumber( const std::string& aPageNumber ) { m_pageNumber = aPageNumber; }

    void SetSheetCount( int aSheetCount ) { m_sheetCount = aSheetCount; }

    void SetIsFirstPage( bool aIsFirstPage ) { m_isFirstPage = aIsFirstPage; }

    void SetVariantName( const std::string& aVariant ) { m_variantName = aVariant; }
    void SetVariantDesc( const std::string& aVariantDesc ) { m_variantDesc = aVariantDesc; }

    void SetColorLayer( int aLayerId ) { m_colorLayer = aLayerId; }

    void SetPageBorderColorLayer( int aLayerId ) { m_pageBorderColorLayer = aLayerId; }
 
    const PAGE_INFO& GetPageInfo() { return *m_pageInfo; }
    const TITLE_BLOCK& GetTitleBlock() { return *m_titleBlock; }
 
    const BOX2I ViewBBox() const override;
 
    void ViewDraw( int aLayer, KIGFX::VIEW* aView ) const override;
 
    std::vector<int> ViewGetLayers() const override;
 
#if defined(DEBUG)
    void Show( int x, std::ostream& st ) const override { }
#endif

    virtual wxString GetClass() const override
    {
        return wxT( "DS_PROXY_VIEW_ITEM" );
    }
 
    bool HitTestDrawingSheetItems( KIGFX::VIEW* aView, const VECTOR2I& aPosition );

    std::vector<TEXT_VAR_REF_KEY> CollectTextVarKeys() const;

    void AttachToTracker( TEXT_VAR_TRACKER* aTracker );
 
    ~DS_PROXY_VIEW_ITEM() override;
 
protected:
    void buildDrawList( KIGFX::VIEW* aView, const std::map<wxString, wxString>* aProperties,
                        DS_DRAW_ITEM_LIST* aDrawList ) const;
 
protected:
    const EDA_IU_SCALE& m_iuScale;
 
    std::string         m_fileName;
    std::string         m_sheetName;
    std::string         m_sheetPath;
    const TITLE_BLOCK*  m_titleBlock;
    const PAGE_INFO*    m_pageInfo;
    std::string         m_pageNumber;
    int                 m_sheetCount;
    bool                m_isFirstPage;
    std::string         m_variantName;
    std::string         m_variantDesc;
    const PROJECT*      m_project;
 
    const std::map<wxString, wxString>* m_properties;

    int                 m_colorLayer;

    int                 m_pageBorderColorLayer;

    mutable std::unique_ptr<KIGFX::DS_PAINTER> m_painter;
    mutable KIGFX::GAL*                        m_painterGal = nullptr;

    TEXT_VAR_TRACKER*   m_attachedTracker = nullptr;
};
 
#endif /* DS_PROXY_VIEW_ITEM_H */