sch_sheet_pin.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * 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_SHEEET_PIN_H
#define SCH_SHEEET_PIN_H
 
#include <sch_label.h>
 
class KIID;
class LINE_READER;
class SCH_SHEET;
 
namespace kiapi::schematic::types
{
    class SheetPin;
}
 

enum class SHEET_SIDE
{
    LEFT = 0,
    RIGHT,
    TOP,
    BOTTOM,
    UNDEFINED
};
 

class SCH_SHEET_PIN : public SCH_HIERLABEL
{
public:
    SCH_SHEET_PIN( SCH_SHEET* parent, const VECTOR2I& pos = VECTOR2I( 0, 0 ),
                   const wxString& text = wxEmptyString );
 
    void Serialize( google::protobuf::Any& aContainer ) const override;
    bool Deserialize( const google::protobuf::Any& aContainer ) override;
 
    void Serialize( kiapi::schematic::types::SheetPin& aOutput ) const;
    bool Deserialize( const kiapi::schematic::types::SheetPin& aInput );
 
    // Do not create a copy constructor.  The one generated by the compiler is adequate.
 
    ~SCH_SHEET_PIN() { }
 
    static inline bool ClassOf( const EDA_ITEM* aItem )
    {
        return aItem && SCH_SHEET_PIN_T == aItem->Type();
    }
 
    wxString GetClass() const override
    {
        return wxT( "SCH_SHEET_PIN" );
    }
 
    wxString GetFriendlyName() const override
    {
        return _( "Sheet Pin" );
    }
 
    bool operator ==( const SCH_SHEET_PIN* aPin ) const;
    bool operator!=( const SCH_SHEET_PIN* aRhs ) const { return !( this == aRhs ); }
 
    static SHEET_SIDE GetOppositeSide( SHEET_SIDE aSide )
    {
        switch( aSide )
        {
        case SHEET_SIDE::TOP:    return SHEET_SIDE::BOTTOM;
        case SHEET_SIDE::BOTTOM: return SHEET_SIDE::TOP;
        case SHEET_SIDE::LEFT:   return SHEET_SIDE::RIGHT;
        case SHEET_SIDE::RIGHT:  return SHEET_SIDE::LEFT;
        default:                 return SHEET_SIDE::UNDEFINED;
        }
    }

    bool IsMovableFromAnchorPoint() const override { return true; }

    void CreateGraphicShape( const RENDER_SETTINGS* aSettings, std::vector<VECTOR2I>& aPoints,
                             const VECTOR2I& aPos ) const override;
 
    int GetPenWidth() const override;

    int GetNumber() const { return m_number; }

    void SetNumber( int aNumber );
 
    void SetSide( SHEET_SIDE aEdge );
 
    SHEET_SIDE GetSide() const;

    void ConstrainOnEdge( const VECTOR2I& aPos, bool aAllowEdgeSwitch );

    SCH_SHEET* GetParent() const { return (SCH_SHEET*) m_parent; }
 
    bool IsLocked() const override;
 
#if defined(DEBUG)
    void Show( int nestLevel, std::ostream& os ) const override;
#endif
 
    // Geometric transforms (used in block operations):
 
    void Move( const VECTOR2I& aMoveVector ) override
    {
        Offset( aMoveVector );
    }
 
    void MirrorVertically( int aCenter ) override;
    void MirrorHorizontally( int aCenter ) override;
    void Rotate( const VECTOR2I& aCenter, bool aRotateCCW ) override;
 
    bool Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const override
    {
        return SCH_ITEM::Matches( GetText(), aSearchData );
    }
 
    bool Replace( const EDA_SEARCH_DATA& aSearchData, void* aAuxData = nullptr ) override
    {
        return EDA_TEXT::Replace( aSearchData );
    }
 
    bool IsReplaceable() const override { return true; }
 
    void GetEndPoints( std::vector< DANGLING_END_ITEM >& aItemList ) override;
 
    bool IsConnectable() const override { return true; }
 
    bool HasConnectivityChanges( const SCH_ITEM* aItem,
                                 const SCH_SHEET_PATH* aInstance = nullptr ) const override;
 
    wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
 
    BITMAPS GetMenuImage() const override;
 
    void SetPosition( const VECTOR2I& aPosition ) override
    {
        ConstrainOnEdge( aPosition, true );
    }
 
    void CalcEdit( const VECTOR2I& aPosition ) override { ConstrainOnEdge( aPosition, true ); }
 
    bool IsPointClickableAnchor( const VECTOR2I& aPos ) const override
    {
        return m_isDangling && GetPosition() == aPos;
    }
 
    bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;
 
    EDA_ITEM* Clone() const override;
 
    double Similarity( const SCH_ITEM& aOther ) const override;
 
    bool operator==( const SCH_ITEM& aOther ) const override;
 
protected:
    void swapData( SCH_ITEM* aItem ) override;
 
private:
    int m_number;       
 
    SHEET_SIDE m_edge;
};
 
#endif // SCH_SHEEET_PIN_H