sch_rule_area.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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef SCH_RULE_AREA_H
#define SCH_RULE_AREA_H
 
#include <unordered_set>
#include <utility>
 
#include <plotters/plotter.h>
#include <sch_plotter.h>
#include <sch_screen.h>
#include <sch_shape.h>
#include <sch_label.h>
#include <sch_sheet_path.h>
#include <sch_view.h>
 
class SCHEMATIC;
 
class SCH_RULE_AREA : public SCH_SHAPE
{
public:
    SCH_RULE_AREA() :
            SCH_SHAPE( SHAPE_T::POLY, LAYER_RULE_AREAS, 0 /* line width */, FILL_T::NO_FILL, SCH_RULE_AREA_T ),
            m_excludedFromSim( false ),
            m_excludedFromBOM( false ),
            m_excludedFromBoard( false ),
            m_DNP( false )
    {
        SetLayer( LAYER_RULE_AREAS );
    }
 
    virtual ~SCH_RULE_AREA();
 
    void Serialize( google::protobuf::Any& aContainer ) const override;
    bool Deserialize( const google::protobuf::Any& aContainer ) override;
 
    wxString GetClass() const override;
 
    wxString GetFriendlyName() const override;
 
    EDA_ITEM* Clone() const override;

    void SetExcludedFromSim( bool aExcludeFromSim, const SCH_SHEET_PATH* aInstance = nullptr,
                             const wxString& aVariantName = wxEmptyString ) override
    {
        m_excludedFromSim = aExcludeFromSim;
    }
 
    bool GetExcludedFromSim( const SCH_SHEET_PATH* aInstance = nullptr,
                             const wxString& aVariantName = wxEmptyString ) const override
    {
        return m_excludedFromSim;
    }
 
    bool GetExcludedFromSimProp() const { return GetExcludedFromSim(); }
 
    void SetExcludedFromSimProp( bool aExcludeFromSim ) { SetExcludedFromSim( aExcludeFromSim ); }

    void SetExcludedFromBOM( bool aExcludeFromBOM, const SCH_SHEET_PATH* aInstance = nullptr,
                             const wxString& aVariantName = wxEmptyString ) override
    {
        m_excludedFromBOM = aExcludeFromBOM;
    }
 
    bool GetExcludedFromBOM( const SCH_SHEET_PATH* aInstance = nullptr,
                             const wxString& aVariantName = wxEmptyString ) const override
    {
        return m_excludedFromBOM;
    }
 
    bool GetExcludedFromBOMProp() const { return GetExcludedFromBOM(); }
 
    void SetExcludedFromBOMProp( bool aExcludeFromBOM ) { SetExcludedFromBOM( aExcludeFromBOM ); }

    void SetExcludedFromBoard( bool aExclude, const SCH_SHEET_PATH* aInstance = nullptr,
                               const wxString& aVariantName = wxEmptyString ) override
    {
        m_excludedFromBoard = aExclude;
    }
 
    bool GetExcludedFromBoard( const SCH_SHEET_PATH* aInstance = nullptr,
                               const wxString& aVariantName = wxEmptyString ) const override
    {
        return m_excludedFromBoard;
    }
 
    bool GetExcludedFromBoardProp() const { return GetExcludedFromBoard(); }
    void SetExcludedFromBoardProp( bool aExclude ) { SetExcludedFromBoard( aExclude ); }

    bool GetDNP( const SCH_SHEET_PATH* aInstance = nullptr,
                 const wxString& aVariantName = wxEmptyString ) const override { return m_DNP; }
    void SetDNP( bool aDNP, const SCH_SHEET_PATH* aInstance = nullptr,
                 const wxString& aVariantName = wxEmptyString ) override { m_DNP = aDNP; }
 
    bool GetDNPProp() const { return GetDNP(); }
 
    void SetDNPProp( bool aDNP ) { SetDNP( aDNP ); }
 
    std::vector<int> ViewGetLayers() const override;
 
    bool IsFilledForHitTesting() const override
    {
        return false;
    }
 
    virtual std::vector<SHAPE*> MakeEffectiveShapes( bool aEdgeOnly = false ) const override;
 
    virtual void Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts,
                       int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aDimmed ) override;
 
    wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;

    void RefreshContainedItemsAndDirectives( SCH_SCREEN* screen );

    static std::vector<std::pair<SCH_RULE_AREA*, SCH_SCREEN*>>
    UpdateRuleAreasInScreens( std::unordered_set<SCH_SCREEN*>& screens, KIGFX::SCH_VIEW* view );

    const std::unordered_set<SCH_ITEM*>& GetContainedItems() const;
 
    const std::unordered_set<KIID>& GetPastContainedItems() const;

    const std::unordered_set<SCH_DIRECTIVE_LABEL*>& GetDirectives() const;

    const std::vector<std::pair<wxString, SCH_ITEM*>> GetResolvedNetclasses( const SCH_SHEET_PATH* aSheetPath ) const;

    bool IsDirectiveLabelOnlyArea() const
    {
        return !m_directives.empty() && !m_DNP && !m_excludedFromSim && !m_excludedFromBOM
               && !m_excludedFromBoard;
    }

    void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
 
protected:
    void addDirective( SCH_DIRECTIVE_LABEL* label );

    void addContainedItem( SCH_ITEM* item );

    void resetCaches();
 
protected:
    bool          m_excludedFromSim;
    bool          m_excludedFromBOM;
    bool          m_excludedFromBoard;
    bool          m_DNP;                   
 
public:
    void RemoveItem( SCH_ITEM* aItem );

    void RemoveDirective( SCH_DIRECTIVE_LABEL* aLabel );

    std::unordered_set<SCH_ITEM*>            m_items;
    std::unordered_set<KIID>                 m_itemIDs;

    std::unordered_set<SCH_DIRECTIVE_LABEL*> m_directives;
    std::unordered_set<KIID>                 m_directiveIDs;

    std::unordered_set<KIID>                 m_prev_items;

    std::unordered_set<KIID>                 m_prev_directives;
};
 
#endif