board_item.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wandadoo.fr
 * Copyright (C) 1992-2020 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 BOARD_ITEM_STRUCT_H
#define BOARD_ITEM_STRUCT_H


#include <eda_item.h>
#include <eda_units.h>
#include <convert_to_biu.h>
#include <gr_basic.h>
#include <layer_ids.h>
#include <geometry/geometry_utils.h>

class BOARD;
class BOARD_ITEM_CONTAINER;
class SHAPE_POLY_SET;
class PCB_BASE_FRAME;
class SHAPE;
class PCB_GROUP;


class BOARD_ITEM : public EDA_ITEM
{
public:
 BOARD_ITEM( BOARD_ITEM* aParent, KICAD_T idtype ) :
 EDA_ITEM( aParent, idtype ),
 m_layer( F_Cu ),
 m_group( nullptr )
 {
 }

 void SetParentGroup( PCB_GROUP* aGroup ) { m_group = aGroup; }
 PCB_GROUP* GetParentGroup() const { return m_group; }

 // Do not create a copy constructor & operator=.
 // The ones generated by the compiler are adequate.
 int GetX() const
 {
 wxPoint p = GetPosition();
 return p.x;
 }

 int GetY() const
 {
 wxPoint p = GetPosition();
 return p.y;
 }

 virtual wxPoint GetCenter() const
 {
 return GetBoundingBox().GetCenter();
 }

 void SetX( int aX )
 {
 wxPoint p( aX, GetY() );
 SetPosition( p );
 }

 void SetY( int aY )
 {
 wxPoint p( GetX(), aY );
 SetPosition( p );
 }

 virtual bool IsConnected() const
 {
 return false;
 }

 virtual bool IsOnCopperLayer() const
 {
 return IsCopperLayer( GetLayer() );
 }

 static wxPoint ZeroOffset;

 virtual std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER ) const;

 BOARD_ITEM_CONTAINER* GetParent() const { return (BOARD_ITEM_CONTAINER*) m_parent; }

 BOARD_ITEM_CONTAINER* GetParentFootprint() const;

 virtual PCB_LAYER_ID GetLayer() const { return m_layer; }

 virtual LSET GetLayerSet() const { return LSET( m_layer ); }
 virtual void SetLayerSet( LSET aLayers )
 {
 wxFAIL_MSG( "Attempted to SetLayerSet() on a single-layer object." );

 // Derived classes which support multiple layers must implement this
 }

 virtual void SetLayer( PCB_LAYER_ID aLayer )
 {
 m_layer = aLayer;
 }

 virtual BOARD_ITEM* Duplicate() const
 {
 EDA_ITEM* dupe = Clone();
 const_cast<KIID&>( dupe->m_Uuid ) = KIID();

 return static_cast<BOARD_ITEM*>( dupe );
 }

 virtual void SwapData( BOARD_ITEM* aImage );

 virtual bool IsOnLayer( PCB_LAYER_ID aLayer ) const
 {
 return m_layer == aLayer;
 }

 bool IsTrack() const
 {
 return ( Type() == PCB_TRACE_T ) || ( Type() == PCB_VIA_T );
 }

 virtual bool IsLocked() const;

 virtual void SetLocked( bool aLocked )
 {
 SetState( LOCKED, aLocked );
 }

 void DeleteStructure();

 virtual void Move( const wxPoint& aMoveVector )
 {
 wxFAIL_MSG( "virtual BOARD_ITEM::Move called for " + GetClass() );
 }

 void Move( const VECTOR2I& aMoveVector )
 {
 Move( wxPoint( aMoveVector.x, aMoveVector.y ) );
 }

 virtual void Rotate( const wxPoint& aRotCentre, double aAngle );

 void Rotate( const VECTOR2I& aRotCentre, double aAngle )
 {
 Rotate( wxPoint( aRotCentre.x, aRotCentre.y ), aAngle );
 }

 virtual void Flip( const wxPoint& aCentre, bool aFlipLeftRight );

 void Flip( const VECTOR2I& aCentre, bool aFlipLeftRight )
 {
 Flip( wxPoint( aCentre.x, aCentre.y ), aFlipLeftRight );
 }

 virtual const BOARD* GetBoard() const;
 virtual BOARD* GetBoard();

 wxString GetLayerName() const;

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

 virtual void TransformShapeWithClearanceToPolygon( SHAPE_POLY_SET& aCornerBuffer,
 PCB_LAYER_ID aLayer, int aClearanceValue,
 int aError, ERROR_LOC aErrorLoc,
 bool ignoreLineWidth = false ) const;

 struct ptr_cmp
 {
 bool operator() ( const BOARD_ITEM* a, const BOARD_ITEM* b ) const;
 };

protected:
 virtual wxString layerMaskDescribe() const;

 PCB_LAYER_ID m_layer;
 PCB_GROUP* m_group;
};

#ifndef SWIG
DECLARE_ENUM_TO_WXANY( PCB_LAYER_ID );
#endif


class DELETED_BOARD_ITEM : public BOARD_ITEM
{
public:
 DELETED_BOARD_ITEM() :
 BOARD_ITEM( nullptr, NOT_USED )
 {}

 wxString GetSelectMenuText( EDA_UNITS aUnits ) const override
 {
 return _( "(Deleted Item)" );
 }

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

 // pure virtuals:
 void SetPosition( const wxPoint& ) override {}
 wxPoint GetPosition() const override { return wxPoint(0, 0); }

 static DELETED_BOARD_ITEM* GetInstance()
 {
 static DELETED_BOARD_ITEM* item = nullptr;

 if( !item )
 item = new DELETED_BOARD_ITEM();

 return item;
 }

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


#endif /* BOARD_ITEM_STRUCT_H */