sch_line.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2009 Jean-Pierre Charras, [email protected]
 * Copyright (C) 1992-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_LINE_H_
#define _SCH_LINE_H_

#include <sch_item.h>

class NETLIST_OBJECT_LIST;


class SCH_LINE : public SCH_ITEM
{
public:
 static const enum wxPenStyle PenStyle[];

 SCH_LINE( const wxPoint& pos = wxPoint( 0, 0 ), int layer = LAYER_NOTES );

 SCH_LINE( const VECTOR2D& pos, int layer = LAYER_NOTES ) :
 SCH_LINE( wxPoint( pos.x, pos.y ), layer )
 {}

 SCH_LINE( const SCH_LINE& aLine );

 ~SCH_LINE() { }

 static inline bool ClassOf( const EDA_ITEM* aItem )
 {
 return aItem && SCH_LINE_T == aItem->Type();
 }

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

 bool IsType( const KICAD_T aScanTypes[] ) const override
 {
 if( SCH_ITEM::IsType( aScanTypes ) )
 return true;

 for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
 {
 if( *p == SCH_LINE_LOCATE_WIRE_T && m_layer == LAYER_WIRE )
 return true;
 else if ( *p == SCH_LINE_LOCATE_BUS_T && m_layer == LAYER_BUS )
 return true;
 else if ( *p == SCH_LINE_LOCATE_GRAPHIC_LINE_T && m_layer == LAYER_NOTES )
 return true;
 }

 return false;
 }

 bool IsEndPoint( const wxPoint& aPoint ) const
 {
 return aPoint == m_start || aPoint == m_end;
 }

 int GetAngleFrom( const wxPoint& aPoint ) const;
 int GetReverseAngleFrom( const wxPoint& aPoint ) const;

 bool IsNull() const { return m_start == m_end; }

 wxPoint GetStartPoint() const { return m_start; }
 void SetStartPoint( const wxPoint& aPosition ) { m_start = aPosition; }

 wxPoint GetEndPoint() const { return m_end; }
 void SetEndPoint( const wxPoint& aPosition ) { m_end = aPosition; }

 void SetLastResolvedState( const SCH_ITEM* aItem ) override
 {
 const SCH_LINE* aLine = dynamic_cast<const SCH_LINE*>( aItem );

 if( aLine )
 {
 m_lastResolvedLineStyle = aLine->m_lastResolvedLineStyle;
 m_lastResolvedWidth = aLine->m_lastResolvedWidth;
 m_lastResolvedColor = aLine->m_lastResolvedColor;
 }
 }

 PLOT_DASH_TYPE GetDefaultStyle() const;

 void SetLineStyle( const PLOT_DASH_TYPE aStyle );
 void SetLineStyle( const int aStyleId );
 PLOT_DASH_TYPE GetLineStyle() const;

 PLOT_DASH_TYPE GetEffectiveLineStyle() const;

 static const char* GetLineStyleName( PLOT_DASH_TYPE aStyle );

 static PLOT_DASH_TYPE GetLineStyleByName( const wxString& aStyleName );

 void SetLineColor( const COLOR4D& aColor );

 void SetLineColor( const double r, const double g, const double b, const double a );

 COLOR4D GetLineColor() const;

 void SetLineWidth( const int aSize );

 virtual bool HasLineStroke() const override { return true; }
 virtual STROKE_PARAMS GetStroke() const override { return m_stroke; }
 virtual void SetStroke( const STROKE_PARAMS& aStroke ) override { m_stroke = aStroke; }

 bool IsStrokeEquivalent( const SCH_LINE* aLine )
 {
 if( m_stroke.GetWidth() != aLine->GetStroke().GetWidth() )
 return false;

 if( m_stroke.GetColor() != aLine->GetStroke().GetColor() )
 return false;

 PLOT_DASH_TYPE style_a = m_stroke.GetPlotStyle();
 PLOT_DASH_TYPE style_b = aLine->GetStroke().GetPlotStyle();

 return style_a == style_b
 || ( style_a == PLOT_DASH_TYPE::DEFAULT && style_b == PLOT_DASH_TYPE::SOLID )
 || ( style_a == PLOT_DASH_TYPE::SOLID && style_b == PLOT_DASH_TYPE::DEFAULT );
 }

 bool UsesDefaultStroke() const;

 int GetLineSize() const { return m_stroke.GetWidth(); }

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

 const EDA_RECT GetBoundingBox() const override;

 double GetLength() const;

 void Print( const RENDER_SETTINGS* aSettings, const wxPoint& aOffset ) override;

 int GetPenWidth() const override;

 void Move( const wxPoint& aMoveVector ) override;
 void MoveStart( const wxPoint& aMoveVector );
 void MoveEnd( const wxPoint& aMoveVector );

 void MirrorVertically( int aCenter ) override;
 void MirrorHorizontally( int aCenter ) override;
 void Rotate( const wxPoint& aCenter ) override;
 void RotateStart( const wxPoint& aCenter );
 void RotateEnd( const wxPoint& aCenter );

 SCH_LINE* MergeOverlap( SCH_SCREEN* aScreen, SCH_LINE* aLine, bool aCheckJunctions );

 bool IsParallel( const SCH_LINE* aLine ) const;

 void GetEndPoints( std::vector<DANGLING_END_ITEM>& aItemList ) override;

 bool UpdateDanglingState( std::vector<DANGLING_END_ITEM>& aItemList,
 const SCH_SHEET_PATH* aPath = nullptr ) override;

 bool IsStartDangling() const { return m_startIsDangling; }
 bool IsEndDangling() const { return m_endIsDangling; }
 bool IsDangling() const override { return m_startIsDangling || m_endIsDangling; }

 bool IsConnectable() const override;

 std::vector<wxPoint> GetConnectionPoints() const override;

 bool ConnectionPropagatesTo( const EDA_ITEM* aItem ) const override;

 void GetSelectedPoints( std::vector< wxPoint >& aPoints ) const;

 bool CanConnect( const SCH_ITEM* aItem ) const override;

 wxString GetSelectMenuText( EDA_UNITS aUnits ) const override;

 BITMAPS GetMenuImage() const override;

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

 wxPoint GetPosition() const override { return m_start; }
 void SetPosition( const wxPoint& aPosition ) override;

 bool IsPointClickableAnchor( const wxPoint& aPos ) const override
 {
 return ( GetStartPoint() == aPos && IsStartDangling() )
 || ( GetEndPoint() == aPos && IsEndDangling() );
 }

 bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
 bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;

 void Plot( PLOTTER* aPlotter ) const override;

 EDA_ITEM* Clone() const override;

 void SwapData( SCH_ITEM* aItem ) override;

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

#if defined(DEBUG)
 void Show( int nestLevel, std::ostream& os ) const override;
#endif

 bool IsGraphicLine() const;

 bool IsWire() const;

 bool IsBus() const;

private:
 bool doIsConnected( const wxPoint& aPosition ) const override;

 bool m_startIsDangling; 
 bool m_endIsDangling; 
 wxPoint m_start; 
 wxPoint m_end; 
 STROKE_PARAMS m_stroke; 

 // If real-time connectivity gets disabled (due to being too slow on a particular
 // design), we can no longer rely on getting the NetClass to find netclass-specific
 // linestyles, linewidths and colors.
 mutable PLOT_DASH_TYPE m_lastResolvedLineStyle;
 mutable int m_lastResolvedWidth;
 mutable COLOR4D m_lastResolvedColor;
};


#endif // _SCH_LINE_H_