sch_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) 2004 Jean-Pierre Charras, [email protected]
 * Copyright (C) 2004-2021 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */

#ifndef SCH_ITEM_H
#define SCH_ITEM_H

#include <unordered_map>
#include <set>

#include <eda_item.h>
#include <plotters/plotter.h> // for PLOT_DASH_TYPE definition

#include <default_values.h>
#include <sch_sheet_path.h>
#include <netclass.h>

class CONNECTION_GRAPH;
class SCH_CONNECTION;
class SCH_SHEET_PATH;
class SCHEMATIC;
class LINE_READER;
class SCH_EDIT_FRAME;
class wxFindReplaceData;
class PLOTTER;
class NETLIST_OBJECT;
class NETLIST_OBJECT_LIST;

using KIGFX::RENDER_SETTINGS;


enum FIELDS_AUTOPLACED
{
 FIELDS_AUTOPLACED_NO = 0,
 FIELDS_AUTOPLACED_AUTO,
 FIELDS_AUTOPLACED_MANUAL
};


enum DANGLING_END_T
{
 UNKNOWN = 0,
 WIRE_END,
 BUS_END,
 JUNCTION_END,
 PIN_END,
 LABEL_END,
 BUS_ENTRY_END,
 WIRE_ENTRY_END,
 SHEET_LABEL_END,
 NO_CONNECT_END,
};


class DANGLING_END_ITEM
{
public:
 DANGLING_END_ITEM( DANGLING_END_T aType, EDA_ITEM* aItem, const wxPoint& aPosition )
 {
 m_item = aItem;
 m_type = aType;
 m_pos = aPosition;
 m_parent = aItem;
 }

 DANGLING_END_ITEM( DANGLING_END_T aType, EDA_ITEM* aItem, const wxPoint& aPosition,
 const EDA_ITEM* aParent )
 {
 m_item = aItem;
 m_type = aType;
 m_pos = aPosition;
 m_parent = aParent;
 }

 bool operator==( const DANGLING_END_ITEM& aB ) const
 {
 return GetItem() == aB.GetItem()
 && GetPosition() == aB.GetPosition()
 && GetType() == aB.GetType()
 && GetParent() == aB.GetParent();
 }

 bool operator!=( const DANGLING_END_ITEM& aB ) const
 {
 return GetItem() != aB.GetItem()
 || GetPosition() != aB.GetPosition()
 || GetType() != aB.GetType()
 || GetParent() != aB.GetParent();;
 }

 bool operator<( const DANGLING_END_ITEM& rhs ) const
 {
 return( m_pos.x < rhs.m_pos.x || ( m_pos.x == rhs.m_pos.x && m_pos.y < rhs.m_pos.y )
 || ( m_pos == rhs.m_pos && m_item < rhs.m_item ) );
 }

 wxPoint GetPosition() const { return m_pos; }
 EDA_ITEM* GetItem() const { return m_item; }
 const EDA_ITEM* GetParent() const { return m_parent; }
 DANGLING_END_T GetType() const { return m_type; }

private:
 EDA_ITEM* m_item; 
 wxPoint m_pos; 
 DANGLING_END_T m_type; 
 const EDA_ITEM* m_parent; 
};


typedef std::vector<SCH_ITEM*> SCH_ITEM_SET;


class STROKE_PARAMS
{
public:
 STROKE_PARAMS( int aWidth = Mils2iu( DEFAULT_LINE_WIDTH_MILS ),
 PLOT_DASH_TYPE aPlotStyle = PLOT_DASH_TYPE::DEFAULT,
 const COLOR4D& aColor = COLOR4D::UNSPECIFIED ) :
 m_width( aWidth ),
 m_plotstyle( aPlotStyle ),
 m_color( aColor )
 {
 }

 int GetWidth() const { return m_width; }
 void SetWidth( int aWidth ) { m_width = aWidth; }

 PLOT_DASH_TYPE GetPlotStyle() const { return m_plotstyle; }
 void SetPlotStyle( PLOT_DASH_TYPE aPlotStyle ) { m_plotstyle = aPlotStyle; }

 COLOR4D GetColor() const { return m_color; }
 void SetColor( const COLOR4D& aColor ) { m_color = aColor; }

 bool operator!=( const STROKE_PARAMS& aOther )
 {
 return m_width != aOther.m_width
 || m_plotstyle != aOther.m_plotstyle
 || m_color != aOther.m_color;
 }

private:
 int m_width;
 PLOT_DASH_TYPE m_plotstyle;
 COLOR4D m_color;
};


class SCH_ITEM : public EDA_ITEM
{
public:
 SCH_ITEM( EDA_ITEM* aParent, KICAD_T aType );

 SCH_ITEM( const SCH_ITEM& aItem );

 SCH_ITEM& operator=( const SCH_ITEM& aPin );

 virtual ~SCH_ITEM();

 virtual wxString GetClass() const override
 {
 return wxT( "SCH_ITEM" );
 }

 virtual void SwapData( SCH_ITEM* aItem );

 SCH_ITEM* Duplicate( bool doClone = false ) const;

 virtual bool IsMovableFromAnchorPoint() const { return true; }

 wxPoint& GetStoredPos() { return m_storedPos; }
 void SetStoredPos( const wxPoint& aPos ) { m_storedPos = aPos; }

 SCHEMATIC* Schematic() const;

 virtual bool IsLocked() const { return false; }

 virtual void SetLocked( bool aLocked ) {}

 virtual bool IsHypertext() const { return false; }

 virtual void DoHypertextMenu( EDA_DRAW_FRAME* aFrame ) { }

 SCH_LAYER_ID GetLayer() const { return m_layer; }

 void SetLayer( SCH_LAYER_ID aLayer ) { m_layer = aLayer; }

 void ViewGetLayers( int aLayers[], int& aCount ) const override;

 virtual int GetPenWidth() const { return 0; }

 virtual void Print( const RENDER_SETTINGS* aSettings, const wxPoint& aOffset ) = 0;

 virtual void Move( const wxPoint& aMoveVector ) = 0;

 virtual void MirrorHorizontally( int aCenter ) = 0;

 virtual void MirrorVertically( int aCenter ) = 0;

 virtual void Rotate( const wxPoint& aCenter ) = 0;

 virtual void GetEndPoints( std::vector< DANGLING_END_ITEM >& aItemList ) {}

 virtual bool UpdateDanglingState( std::vector<DANGLING_END_ITEM>& aItemList,
 const SCH_SHEET_PATH* aPath = nullptr )
 {
 return false;
 }

 virtual bool IsDangling() const { return false; }

 virtual bool CanConnect( const SCH_ITEM* aItem ) const { return m_layer == aItem->GetLayer(); }

 virtual bool IsConnectable() const { return false; }

 virtual bool IsPointClickableAnchor( const wxPoint& aPos ) const { return false; }

 virtual std::vector<wxPoint> GetConnectionPoints() const { return {}; }

 void ClearConnections() { m_connections.clear(); }

 bool IsConnected( const wxPoint& aPoint ) const;

 SCH_CONNECTION* Connection( const SCH_SHEET_PATH* aSheet = nullptr ) const;

 SCH_ITEM_SET& ConnectedItems( const SCH_SHEET_PATH& aPath );

 void AddConnectionTo( const SCH_SHEET_PATH& aPath, SCH_ITEM* aItem );

 SCH_CONNECTION* InitializeConnection( const SCH_SHEET_PATH& aPath, CONNECTION_GRAPH* aGraph );

 SCH_CONNECTION* GetOrInitConnection( const SCH_SHEET_PATH& aPath, CONNECTION_GRAPH* aGraph );

 virtual bool ConnectionPropagatesTo( const EDA_ITEM* aItem ) const { return true; }

 bool IsConnectivityDirty() const { return m_connectivity_dirty; }

 void SetConnectivityDirty( bool aDirty = true ) { m_connectivity_dirty = aDirty; }

 virtual void SetLastResolvedState( const SCH_ITEM* aItem ) { }

 NETCLASSPTR NetClass( const SCH_SHEET_PATH* aSheet = nullptr ) const;

 FIELDS_AUTOPLACED GetFieldsAutoplaced() const { return m_fieldsAutoplaced; }

 void SetFieldsAutoplaced() { m_fieldsAutoplaced = FIELDS_AUTOPLACED_AUTO; }
 void ClearFieldsAutoplaced() { m_fieldsAutoplaced = FIELDS_AUTOPLACED_NO; }

 void AutoAutoplaceFields( SCH_SCREEN* aScreen )
 {
 if( GetFieldsAutoplaced() )
 AutoplaceFields( aScreen, GetFieldsAutoplaced() == FIELDS_AUTOPLACED_MANUAL );
 }

 virtual void AutoplaceFields( SCH_SCREEN* aScreen, bool aManual ) { }

 virtual void RunOnChildren( const std::function<void( SCH_ITEM* )>& aFunction ) { }

 virtual bool HasLineStroke() const { return false; }

 virtual STROKE_PARAMS GetStroke() const { wxCHECK( false, STROKE_PARAMS() ); }

 virtual void SetStroke( const STROKE_PARAMS& aStroke ) { wxCHECK( false, /* void */ ); }

 virtual void Plot( PLOTTER* aPlotter ) const;

 virtual bool operator <( const SCH_ITEM& aItem ) const;

private:
 friend class CONNECTION_GRAPH;

 virtual bool doIsConnected( const wxPoint& aPosition ) const { return false; }

protected:
 SCH_LAYER_ID m_layer;
 EDA_ITEMS m_connections; // List of items connected to this item.
 FIELDS_AUTOPLACED m_fieldsAutoplaced; // indicates status of field autoplacement
 wxPoint m_storedPos; // a temporary variable used in some move commands
 // to store a initial pos of the item or mouse cursor

 std::unordered_map<SCH_SHEET_PATH, SCH_ITEM_SET> m_connected_items;

 std::unordered_map<SCH_SHEET_PATH, SCH_CONNECTION*> m_connection_map;

 bool m_connectivity_dirty;
};

#endif /* SCH_ITEM_H */