kicad/eeschema/sch_line.h

274 lines
9.1 KiB
C
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2009 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
2021-03-25 21:13:01 +00:00
* 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_
2019-05-10 19:57:24 +00:00
#include <sch_item.h>
class NETLIST_OBJECT_LIST;
/**
* Segment description base class to describe items which have 2 end points (track, wire,
* draw line ...)
*/
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();
}
2016-09-25 17:06:49 +00:00
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 )
{
2020-11-14 14:29:11 +00:00
if( *p == SCH_LINE_LOCATE_WIRE_T && m_layer == LAYER_WIRE )
return true;
2020-11-14 14:29:11 +00:00
else if ( *p == SCH_LINE_LOCATE_BUS_T && m_layer == LAYER_BUS )
return true;
2020-11-14 14:29:11 +00:00
else if ( *p == SCH_LINE_LOCATE_GRAPHIC_LINE_T && m_layer == LAYER_NOTES )
2019-05-08 18:56:03 +00:00
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; }
2019-12-28 00:55:11 +00:00
PLOT_DASH_TYPE GetDefaultStyle() const;
2019-12-28 00:55:11 +00:00
void SetLineStyle( const PLOT_DASH_TYPE aStyle );
void SetLineStyle( const int aStyleId );
PLOT_DASH_TYPE GetLineStyle() const;
/// @return the style that the line should be drawn in
/// this might be set on the line or inherited from the line's netclass
PLOT_DASH_TYPE GetEffectiveLineStyle() const;
/// @return the style name from the style id
/// (mainly to write it in .sch file)
2019-12-28 00:55:11 +00:00
static const char* GetLineStyleName( PLOT_DASH_TYPE aStyle );
/// @return the style id from the style name
/// (mainly to read style from .sch file)
2019-12-28 00:55:11 +00:00
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 );
/// Returns COLOR4D::UNSPECIFIED if a custom color hasn't been set for this line
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 );
}
/**
* Test if the #SCH_LINE object uses the default stroke settings.
*
* The stroke settings include the line width, style, and color.
*
* @return True if the #SCH_LINE object uses the default stroke settings.
*/
bool UsesDefaultStroke() const;
int GetLineSize() const { return m_stroke.GetWidth(); }
void ViewGetLayers( int aLayers[], int& aCount ) const override;
2016-09-25 17:06:49 +00:00
const EDA_RECT GetBoundingBox() const override;
/**
* @return The length of the line segment.
*/
double GetLength() const;
2020-12-20 18:18:54 +00:00
void Print( const RENDER_SETTINGS* aSettings, const wxPoint& aOffset ) override;
2020-04-14 12:25:00 +00:00
int GetPenWidth() const override;
2016-09-24 18:53:15 +00:00
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 );
/**
* Check line against \a aLine to see if it overlaps and merge if it does.
*
* This method will return an equivalent of the union of line and \a aLine if the
* two lines overlap. This method is used to merge multiple line segments into a single
* line.
*
2021-03-25 21:13:01 +00:00
* @param aScreen is the current screen.
* @param aLine is the line to compare.
* @param aCheckJunctions is used to indicate if we need to check for a junction if the two
* segments are colinear and touch.
* @return New line that combines the two or NULL on non-overlapping segments.
*/
SCH_LINE* MergeOverlap( SCH_SCREEN* aScreen, SCH_LINE* aLine, bool aCheckJunctions );
2020-12-20 18:44:13 +00:00
bool IsParallel( const SCH_LINE* aLine ) const;
2016-09-24 18:53:15 +00:00
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; }
2016-09-25 17:06:49 +00:00
bool IsDangling() const override { return m_startIsDangling || m_endIsDangling; }
2016-09-24 18:53:15 +00:00
bool IsConnectable() const override;
std::vector<wxPoint> GetConnectionPoints() const override;
void GetSelectedPoints( std::vector< wxPoint >& aPoints ) const;
bool CanConnect( const SCH_ITEM* aItem ) const override;
2019-12-20 14:11:39 +00:00
wxString GetSelectMenuText( EDA_UNITS aUnits ) const override;
BITMAPS GetMenuImage() const override;
2016-09-24 18:53:15 +00:00
bool operator <( const SCH_ITEM& aItem ) const override;
2020-05-27 14:01:07 +00:00
wxPoint GetPosition() const override { return m_start; }
2016-09-24 18:53:15 +00:00
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;
2016-09-24 18:53:15 +00:00
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)
2016-09-25 17:06:49 +00:00
void Show( int nestLevel, std::ostream& os ) const override;
#endif
/**
2021-03-25 21:13:01 +00:00
* Return if the line is a graphic (non electrical line)
*
* Currently, anything on the internal NOTES layer is a graphic line
*/
bool IsGraphicLine() const;
/**
2021-03-25 21:13:01 +00:00
* Return true if the line is a wire.
*
* @return true if this line is on the wire layer.
*/
bool IsWire() const;
/**
2021-03-25 21:13:01 +00:00
* Return true if the line is a bus.
*
* @return true if this line is on the bus layer.
*/
bool IsBus() const;
private:
2016-09-24 18:53:15 +00:00
bool doIsConnected( const wxPoint& aPosition ) const override;
2021-03-25 21:13:01 +00:00
bool m_startIsDangling; ///< True if start point is not connected.
bool m_endIsDangling; ///< True if end point is not connected.
wxPoint m_start; ///< Line start point
wxPoint m_end; ///< Line end point
STROKE_PARAMS m_stroke; ///< Line stroke properties.
};
#endif // _SCH_LINE_H_