sch_shape.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_SHAPE_H
#define SCH_SHAPE_H
 
#include <sch_item.h>
#include <eda_shape.h>
 
 
class SCH_SHAPE : public SCH_ITEM, public EDA_SHAPE
{
public:
 SCH_SHAPE( SHAPE_T aShape = SHAPE_T::UNDEFINED, SCH_LAYER_ID aLayer = LAYER_NOTES,
 int aLineWidth = 0, FILL_T aFillType = FILL_T::NO_FILL, KICAD_T aType = SCH_SHAPE_T );
 
 // Do not create a copy constructor. The one generated by the compiler is adequate.
 
 virtual ~SCH_SHAPE() override {}
 
 wxString GetClass() const override
 {
 return wxT( "SCH_SHAPE" );
 }
 
 void SwapData( SCH_ITEM* aItem ) override;
 
 bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;
 bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
 
 int GetPenWidth() const override { return GetStroke().GetWidth(); }
 
 bool HasLineStroke() const override { return true; }
 STROKE_PARAMS GetStroke() const override { return m_stroke; }
 void SetStroke( const STROKE_PARAMS& aStroke ) override;
 
 int GetEffectiveWidth() const override;
 
 LINE_STYLE GetEffectiveLineStyle() const
 {
 if( m_stroke.GetLineStyle() == LINE_STYLE::DEFAULT )
 return LINE_STYLE::SOLID;
 else
 return m_stroke.GetLineStyle();
 }
 
 const BOX2I GetBoundingBox() const override;
 
 VECTOR2I GetPosition() const override { return getPosition(); }
 void SetPosition( const VECTOR2I& aPos ) override { setPosition( aPos ); }
 
 VECTOR2I GetCenter() const { return getCenter(); }
 
 void BeginEdit( const VECTOR2I& aStartPoint ) override { beginEdit( aStartPoint ); }
 bool ContinueEdit( const VECTOR2I& aPosition ) override { return continueEdit( aPosition ); }
 void CalcEdit( const VECTOR2I& aPosition ) override { calcEdit( aPosition ); }
 void EndEdit( bool aClosed = false ) override { endEdit(); }
 void SetEditState( int aState ) { setEditState( aState ); }
 
 void Move( const VECTOR2I& aOffset ) override;
 
 void Normalize();
 
 void MirrorHorizontally( int aCenter ) override;
 void MirrorVertically( int aCenter ) override;
 void Rotate( const VECTOR2I& aCenter, bool aRotateCCW ) override;
 
 void AddPoint( const VECTOR2I& aPosition );
 
 std::vector<SHAPE*> MakeEffectiveShapes( bool aEdgeOnly = false ) const override
 {
 return makeEffectiveShapes( aEdgeOnly, true );
 }
 
 void Print( const SCH_RENDER_SETTINGS* aSettings, int aUnit, int aBodyStyle,
 const VECTOR2I& aOffset, bool aForceNoFill, bool aDimmed ) override;
 
 void PrintBackground( const SCH_RENDER_SETTINGS* aSettings, int aUnit, int aBodyStyle,
 const VECTOR2I& aOffset, bool aDimmed ) override;
 
 void Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts,
 int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aDimmed ) override;
 
 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
 
 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override;
 
 BITMAPS GetMenuImage() const override;
 
 EDA_ITEM* Clone() const override;
 
 void ViewGetLayers( int aLayers[], int& aCount ) const override;
 
 double Similarity( const SCH_ITEM& aOther ) const override;
 
 bool operator==( const SCH_ITEM& aOther ) const override;
 
#if defined(DEBUG)
 void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
#endif
 
protected:
 void setFilled( bool aFlag ) override
 {
 m_fill = aFlag ? FILL_T::FILLED_WITH_COLOR : FILL_T::NO_FILL;
 }
 
 int compare( const SCH_ITEM& aOther, int aCompareFlags = 0 ) const override;
};
 
 
#endif // SCH_SHAPE_H