kicad/pcbnew/pcb_shape.h

167 lines
5.6 KiB
C
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2018 Jean-Pierre Charras jp.charras at wanadoo.fr
2022-01-30 10:52:52 +00:00
* Copyright (C) 1992-2022 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 PCB_SHAPE_H
#define PCB_SHAPE_H
2020-11-14 18:11:28 +00:00
#include <board_item.h>
#include <eda_shape.h>
class LINE_READER;
class EDA_DRAW_FRAME;
2020-11-13 15:15:52 +00:00
class FOOTPRINT;
class MSG_PANEL_ITEM;
2008-01-16 18:48:04 +00:00
class PCB_SHAPE : public BOARD_ITEM, public EDA_SHAPE
2008-01-16 18:48:04 +00:00
{
public:
2022-01-30 10:52:52 +00:00
PCB_SHAPE( BOARD_ITEM* aParent, KICAD_T aItemType, SHAPE_T aShapeType );
2022-01-30 10:52:52 +00:00
PCB_SHAPE( BOARD_ITEM* aParent = NULL, SHAPE_T aShapeType = SHAPE_T::SEGMENT );
// Do not create a copy constructor & operator=.
// The ones generated by the compiler are adequate.
~PCB_SHAPE();
2008-01-16 18:48:04 +00:00
2015-02-18 16:53:46 +00:00
static inline bool ClassOf( const EDA_ITEM* aItem )
{
return aItem && PCB_SHAPE_T == aItem->Type();
}
wxString GetClass() const override
{
return wxT( "PCB_SHAPE" );
}
wxString GetFriendlyName() const override { return EDA_SHAPE::GetFriendlyName(); }
2022-09-12 10:38:24 +00:00
bool IsType( const std::vector<KICAD_T>& aScanTypes ) const override;
void SetPosition( const VECTOR2I& aPos ) override { setPosition( aPos ); }
VECTOR2I GetPosition() const override { return getPosition(); }
2020-11-14 07:51:21 +00:00
VECTOR2I GetCenter() const override { return getCenter(); }
bool HasLineStroke() const override { return true; }
STROKE_PARAMS GetStroke() const override { return m_stroke; }
void SetStroke( const STROKE_PARAMS& aStroke ) override { m_stroke = aStroke; }
2022-01-30 10:52:52 +00:00
/**
* Return 4 corners for a rectangle or rotated rectangle (stored as a poly). Unimplemented
* for other shapes.
*/
std::vector<VECTOR2I> GetCorners() const;
/**
* Allows items to return their visual center rather than their anchor. For some shapes this
* is similar to GetCenter(), but for unfilled shapes a point on the outline is better.
*/
const VECTOR2I GetFocusPosition() const override;
2020-06-22 22:17:21 +00:00
/**
2021-06-04 13:04:30 +00:00
* Return the parent footprint or NULL if PCB_SHAPE does not belong to a footprint.
*
* @return the parent footprint or NULL.
*/
2020-11-13 15:15:52 +00:00
FOOTPRINT* GetParentFootprint() const;
/**
2021-06-04 13:04:30 +00:00
* Make a set of SHAPE objects representing the PCB_SHAPE. Caller owns the objects.
*/
std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
FLASHING aFlash = FLASHING::DEFAULT ) const override;
void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
2008-01-16 18:48:04 +00:00
2022-08-31 09:15:42 +00:00
const BOX2I GetBoundingBox() const override { return getBoundingBox(); }
2008-01-16 18:48:04 +00:00
bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override
2008-01-16 18:48:04 +00:00
{
return hitTest( aPosition, aAccuracy );
2008-01-16 18:48:04 +00:00
}
2008-01-22 20:36:46 +00:00
2022-08-31 09:33:46 +00:00
bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override
{
return hitTest( aRect, aContained, aAccuracy );
}
void NormalizeRect();
virtual void Move( const VECTOR2I& aMoveVector ) override;
2009-08-01 19:26:05 +00:00
virtual void Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle ) override;
2009-08-01 19:26:05 +00:00
virtual void Flip( const VECTOR2I& aCentre, bool aFlipLeftRight ) override;
virtual void Mirror( const VECTOR2I& aCentre, bool aMirrorAroundXAxis );
void Scale( double aScale );
2010-11-12 15:17:10 +00:00
/**
* Convert the shape to a closed polygon. Circles and arcs are approximated by segments.
2021-06-04 13:04:30 +00:00
*
* @param aBuffer is a buffer to store the polygon.
* @param aClearance is the clearance around the pad.
2021-06-04 13:04:30 +00:00
* @param aError is the maximum deviation from a true arc.
* @param aErrorLoc whether any approximation error should be placed inside or outside
* @param ignoreLineWidth is used for edge cut items where the line width is only for
* visualization
*/
void TransformShapeToPolygon( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
int aError, ERROR_LOC aErrorLoc,
bool ignoreLineWidth = false ) const override;
virtual wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override;
virtual BITMAPS GetMenuImage() const override;
2016-09-24 18:53:15 +00:00
virtual EDA_ITEM* Clone() const override;
2016-09-24 18:53:15 +00:00
virtual const BOX2I ViewBBox() const override;
///< @copydoc VIEW_ITEM::ViewGetLOD
double ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
#if defined(DEBUG)
void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
#endif
protected:
virtual void swapData( BOARD_ITEM* aImage ) override;
struct cmp_drawings
{
bool operator()( const BOARD_ITEM* aFirst, const BOARD_ITEM* aSecond ) const;
};
2022-01-16 21:15:20 +00:00
EDA_ANGLE getParentOrientation() const override;
VECTOR2I getParentPosition() const override;
2008-01-16 18:48:04 +00:00
};
#endif // PCB_SHAPE_H