235 lines
7.6 KiB
C++
235 lines
7.6 KiB
C++
/*
|
|
* 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
|
|
* Copyright (C) 1992-2019 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 <plotter.h>
|
|
#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
|
|
{
|
|
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
|
|
int m_size; ///< Line pensize
|
|
PLOT_DASH_TYPE m_style; ///< Line style
|
|
COLOR4D m_color; ///< Line color
|
|
|
|
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;
|
|
}
|
|
|
|
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; }
|
|
|
|
PLOT_DASH_TYPE GetDefaultStyle() const;
|
|
|
|
void SetLineStyle( const PLOT_DASH_TYPE aStyle );
|
|
void SetLineStyle( const int aStyleId );
|
|
PLOT_DASH_TYPE GetLineStyle() const;
|
|
|
|
/// @return the style name from the style id
|
|
/// (mainly to write it in .sch file
|
|
static const char* GetLineStyleName( PLOT_DASH_TYPE aStyle );
|
|
|
|
/// @return the style id from the style name
|
|
/// (mainly to read style from .sch file
|
|
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;
|
|
|
|
COLOR4D GetDefaultColor() const;
|
|
|
|
int GetDefaultWidth() const;
|
|
|
|
void SetLineWidth( const int aSize );
|
|
|
|
int GetLineSize() const { return m_size; }
|
|
|
|
void ViewGetLayers( int aLayers[], int& aCount ) const override;
|
|
|
|
const EDA_RECT GetBoundingBox() const override;
|
|
|
|
/**
|
|
* Function GetLength
|
|
* @return The length of the line segment.
|
|
*/
|
|
double GetLength() const;
|
|
|
|
void Print( wxDC* aDC, const wxPoint& aOffset ) override;
|
|
|
|
int GetPenSize() const override;
|
|
|
|
void Move( const wxPoint& aMoveVector ) override;
|
|
void MoveStart( const wxPoint& aMoveVector );
|
|
void MoveEnd( const wxPoint& aMoveVector );
|
|
|
|
void MirrorX( int aXaxis_position ) override;
|
|
void MirrorY( int aYaxis_position ) override;
|
|
void Rotate( wxPoint aPosition ) override;
|
|
void RotateStart( wxPoint aPosition );
|
|
void RotateEnd( wxPoint aPosition );
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param aLine - Line to compare.
|
|
* @return New line that combines the two or NULL on non-overlapping segments.
|
|
*/
|
|
SCH_LINE* MergeOverlap( SCH_LINE* aLine );
|
|
|
|
/**
|
|
* Check if two lines are in the same quadrant as each other, using a reference point as
|
|
* the origin
|
|
*
|
|
* @param aLine - Line to compare
|
|
* @param aPosition - Point to reference against lines
|
|
* @return true if lines are mostly in different quadrants of aPosition, false otherwise
|
|
*/
|
|
bool IsSameQuadrant( SCH_LINE* aLine, const wxPoint& aPosition );
|
|
|
|
bool IsParallel( SCH_LINE* aLine );
|
|
|
|
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;
|
|
|
|
void GetConnectionPoints( std::vector< wxPoint >& aPoints ) const override;
|
|
|
|
void GetSelectedPoints( std::vector< wxPoint >& aPoints ) const;
|
|
|
|
bool CanConnect( const SCH_ITEM* aItem ) const override;
|
|
|
|
wxString GetSelectMenuText( EDA_UNITS aUnits ) const override;
|
|
|
|
BITMAP_DEF GetMenuImage() const override;
|
|
|
|
void GetNetListItem( NETLIST_OBJECT_LIST& aNetListItems, SCH_SHEET_PATH* aSheetPath ) override;
|
|
|
|
bool operator <( const SCH_ITEM& aItem ) const override;
|
|
|
|
wxPoint GetPosition() const override { return m_start; }
|
|
void SetPosition( const wxPoint& aPosition ) override;
|
|
|
|
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 ) override;
|
|
|
|
EDA_ITEM* Clone() const override;
|
|
|
|
void SwapData( SCH_ITEM* aItem ) override;
|
|
|
|
void GetMsgPanelInfo( EDA_UNITS aUnits, std::vector<MSG_PANEL_ITEM>& aList ) override;
|
|
|
|
#if defined(DEBUG)
|
|
void Show( int nestLevel, std::ostream& os ) const override;
|
|
#endif
|
|
|
|
/**
|
|
* Returns if the line is a graphic (non electrical line)
|
|
*
|
|
* Currently, anything on the internal NOTES layer is a graphic line
|
|
*/
|
|
bool IsGraphicLine() const;
|
|
|
|
private:
|
|
bool doIsConnected( const wxPoint& aPosition ) const override;
|
|
};
|
|
|
|
|
|
#endif // _SCH_LINE_H_
|