sch_group.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 CLASS_SCH_GROUP_H_
#define CLASS_SCH_GROUP_H_
 
#include <eda_group.h>
#include <sch_commit.h>
#include <sch_item.h>
#include <lset.h>
#include <unordered_set>
 
namespace KIGFX
{
class VIEW;
}

class SCH_GROUP : public SCH_ITEM, public EDA_GROUP
{
public:
    SCH_GROUP();
 
    SCH_GROUP( SCH_ITEM* aParent );
 
    SCH_GROUP( SCH_SCREEN* aParent );
 
    void Serialize( google::protobuf::Any& aContainer ) const override;
    bool Deserialize( const google::protobuf::Any& aContainer ) override;
 
    EDA_ITEM* AsEdaItem() override { return this; }
 
    static inline bool ClassOf( const EDA_ITEM* aItem ) { return aItem && SCH_GROUP_T == aItem->Type(); }
 
    wxString GetClass() const override { return wxT( "SCH_GROUP" ); }
 
    std::unordered_set<SCH_ITEM*> GetSchItems() const;
 
    /*
     * Search for highest level group inside of aScope, containing item.
     *
     * @param aScope restricts the search to groups within the group scope.
     * @param isSymbolEditor true if we should stop promoting at the symbol level
     * @return group inside of aScope, containing item, if exists, otherwise, nullptr
     */
    static EDA_GROUP* TopLevelGroup( SCH_ITEM* aItem, EDA_GROUP* aScope, bool isSymbolEditor );
 
    static bool WithinScope( SCH_ITEM* aItem, SCH_GROUP* aScope, bool isSymbolEditor );
 
    double Similarity( const SCH_ITEM& aOther ) const override;
 
    bool operator==( const SCH_GROUP& aOther ) const;
    bool operator==( const SCH_ITEM& aSchItem ) const override;
 
#if defined( DEBUG )
    void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
#endif

    VECTOR2I GetPosition() const override;

    void SetPosition( const VECTOR2I& aNewpos ) override;

    EDA_ITEM* Clone() const override;
 
    /*
     * Clone this and all descendants
     */
    SCH_GROUP* DeepClone() const;
 
    /*
     * Duplicate this and all descendants
     *
     * @param addToParentGroup if the original is part of a group then the new member will also
     *                         be added to said group
     */
    SCH_GROUP* DeepDuplicate( bool addToParentGroup, SCH_COMMIT* aCommit = nullptr ) const;

    bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;

    bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;

    const BOX2I GetBoundingBox() const override;

    INSPECT_RESULT Visit( INSPECTOR aInspector, void* aTestData,
                          const std::vector<KICAD_T>& aScanTypes ) override;

    std::vector<int> ViewGetLayers() const override;

    double ViewGetLOD( int aLayer, const KIGFX::VIEW* aView ) const override;

    void Move( const VECTOR2I& aMoveVector ) override;

    void Rotate( const VECTOR2I& aCenter, bool aRotateCCW ) override;

    void MirrorHorizontally( int aCenter ) override;

    void MirrorVertically( int aCenter ) override;
 
    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;

    BITMAPS GetMenuImage() const override;

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

    bool Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const override;

    void RunOnChildren( const std::function<void( SCH_ITEM* )>& aFunction, RECURSE_MODE aMode ) override;

    void swapData( SCH_ITEM* aImage ) override;
};
 
#endif