You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
510 lines
15 KiB
510 lines
15 KiB
/*
|
|
* 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 The 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
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
|
|
#include <core/mirror.h>
|
|
#include <eda_item.h>
|
|
#include <geometry/approximation.h>
|
|
#include <layer_ids.h>
|
|
#include <lseq.h>
|
|
#include <lset.h>
|
|
#include <stroke_params.h>
|
|
#include <geometry/eda_angle.h>
|
|
|
|
class BOARD;
|
|
class BOARD_DESIGN_SETTINGS;
|
|
class BOARD_ITEM_CONTAINER;
|
|
class SHAPE_POLY_SET;
|
|
class SHAPE_SEGMENT;
|
|
class PCB_BASE_FRAME;
|
|
class SHAPE;
|
|
class PCB_GROUP;
|
|
class FOOTPRINT;
|
|
|
|
namespace KIFONT
|
|
{
|
|
class METRICS;
|
|
}
|
|
|
|
|
|
/**
|
|
* Conditionally flashed vias and pads that interact with zones of different priority can be
|
|
* very squirrelly.
|
|
*
|
|
* In particular, when filling a higher-priority zone that does -not- connect to a via/pad, we
|
|
* don't know whether or not a lower-priority zone will subsequently connect -- so we can't
|
|
* determine clearance because we don't know what the final flashing state will be.
|
|
*
|
|
* We therefore force the flashing state if the highest-priority zone with the same net -can-
|
|
* connect (whether or not it does in the end), and otherwise force the zone-connection state
|
|
* to no-connection (even though a lower priority zone -might- have otherwise connected to it.
|
|
*/
|
|
enum ZONE_LAYER_OVERRIDE
|
|
{
|
|
ZLO_NONE,
|
|
ZLO_FORCE_FLASHED,
|
|
ZLO_FORCE_NO_ZONE_CONNECTION
|
|
};
|
|
|
|
/**
|
|
* A base class for any item which can be embedded within the #BOARD container class, and
|
|
* therefore instances of derived classes should only be found in Pcbnew or other programs
|
|
* that use class #BOARD and its contents.
|
|
*/
|
|
class BOARD_ITEM : public EDA_ITEM
|
|
{
|
|
public:
|
|
BOARD_ITEM( BOARD_ITEM* aParent, KICAD_T idtype, PCB_LAYER_ID aLayer = F_Cu ) :
|
|
EDA_ITEM( aParent, idtype, false, true ),
|
|
m_layer( aLayer ),
|
|
m_isKnockout( false ),
|
|
m_isLocked( false )
|
|
{
|
|
}
|
|
|
|
virtual void CopyFrom( const BOARD_ITEM* aOther );
|
|
|
|
// Do not create a copy constructor & operator=.
|
|
// The ones generated by the compiler are adequate.
|
|
int GetX() const
|
|
{
|
|
VECTOR2I p = GetPosition();
|
|
return p.x;
|
|
}
|
|
|
|
int GetY() const
|
|
{
|
|
VECTOR2I p = GetPosition();
|
|
return p.y;
|
|
}
|
|
|
|
/**
|
|
* This defaults to the center of the bounding box if not overridden.
|
|
*
|
|
* @return center point of the item
|
|
*/
|
|
virtual VECTOR2I GetCenter() const
|
|
{
|
|
return GetBoundingBox().GetCenter();
|
|
}
|
|
|
|
void SetX( int aX )
|
|
{
|
|
VECTOR2I p( aX, GetY() );
|
|
SetPosition( p );
|
|
}
|
|
|
|
void SetY( int aY )
|
|
{
|
|
VECTOR2I p( GetX(), aY );
|
|
SetPosition( p );
|
|
}
|
|
|
|
/**
|
|
* Returns information if the object is derived from BOARD_CONNECTED_ITEM.
|
|
*
|
|
* @return True if the object is of BOARD_CONNECTED_ITEM type, false otherwise.
|
|
*/
|
|
virtual bool IsConnected() const
|
|
{
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Return a measure of how likely the other object is to represent the same
|
|
* object. The scale runs from 0.0 (definitely different objects) to 1.0 (same)
|
|
*
|
|
* This is a pure virtual function. Derived classes must implement this.
|
|
*/
|
|
virtual double Similarity( const BOARD_ITEM& aItem ) const = 0;
|
|
virtual bool operator==( const BOARD_ITEM& aItem ) const = 0;
|
|
|
|
/**
|
|
* @return true if the object is on any copper layer, false otherwise.
|
|
*/
|
|
virtual bool IsOnCopperLayer() const
|
|
{
|
|
return IsCopperLayer( GetLayer() );
|
|
}
|
|
|
|
virtual bool HasHole() const
|
|
{
|
|
return false;
|
|
}
|
|
|
|
virtual bool HasDrilledHole() const
|
|
{
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Checks if the given object is tented (its copper shape is covered by solder mask) on a given
|
|
* side of the board.
|
|
* @param aLayer is the layer to check tenting mode for: F_Cu and F_Mask are treated identically
|
|
* as are B_Cu and B_Mask
|
|
* @return true if the object is tented on the given side
|
|
*/
|
|
virtual bool IsTented( PCB_LAYER_ID aLayer ) const
|
|
{
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* A value of wxPoint(0,0) which can be passed to the Draw() functions.
|
|
*/
|
|
static VECTOR2I ZeroOffset;
|
|
|
|
/**
|
|
* Some pad shapes can be complex (rounded/chamfered rectangle), even without considering
|
|
* custom shapes. This routine returns a COMPOUND shape (set of simple shapes which make
|
|
* up the pad for use with routing, collision determination, etc).
|
|
*
|
|
* @note This list can contain a SHAPE_SIMPLE (a simple single-outline non-intersecting
|
|
* polygon), but should never contain a SHAPE_POLY_SET (a complex polygon consisting of
|
|
* multiple outlines and/or holes).
|
|
*
|
|
* @param aLayer in case of items spanning multiple layers, only the shapes belonging to aLayer
|
|
* will be returned. Pass UNDEFINED_LAYER to return shapes for all layers.
|
|
* @param aFlash optional parameter allowing a caller to force the pad to be flashed (or not
|
|
* flashed) on the current layer (default is to honour the pad's setting and
|
|
* the current connections for the given layer).
|
|
*/
|
|
virtual std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
|
|
FLASHING aFlash = FLASHING::DEFAULT ) const;
|
|
|
|
virtual std::shared_ptr<SHAPE_SEGMENT> GetEffectiveHoleShape() const;
|
|
|
|
/**
|
|
* Invoke a function on all children.
|
|
*
|
|
* @note This function should not add or remove items to the parent.
|
|
*/
|
|
virtual void RunOnChildren( const std::function<void( BOARD_ITEM* )>& aFunction, RECURSE_MODE aMode ) const {}
|
|
|
|
BOARD_ITEM_CONTAINER* GetParent() const { return (BOARD_ITEM_CONTAINER*) m_parent; }
|
|
|
|
FOOTPRINT* GetParentFootprint() const;
|
|
|
|
VECTOR2I GetFPRelativePosition() const;
|
|
void SetFPRelativePosition( const VECTOR2I& aPos );
|
|
|
|
/**
|
|
* Check if this item has line stoke properties.
|
|
*
|
|
* @see #STROKE_PARAMS
|
|
*/
|
|
virtual bool HasLineStroke() const { return false; }
|
|
|
|
virtual STROKE_PARAMS GetStroke() const;
|
|
virtual void SetStroke( const STROKE_PARAMS& aStroke );
|
|
|
|
const KIFONT::METRICS& GetFontMetrics() const;
|
|
|
|
/**
|
|
* Return the primary layer this item is on.
|
|
*/
|
|
virtual PCB_LAYER_ID GetLayer() const { return m_layer; }
|
|
|
|
/**
|
|
* Return the total number of layers for the board that this item resides on.
|
|
*/
|
|
virtual int BoardLayerCount() const;
|
|
|
|
/**
|
|
* Return the total number of copper layers for the board that this item resides on.
|
|
*/
|
|
virtual int BoardCopperLayerCount() const;
|
|
|
|
/**
|
|
* Return the LSET for the board that this item resides on.
|
|
*/
|
|
virtual LSET BoardLayerSet() const;
|
|
|
|
/**
|
|
* Return a std::bitset of all layers on which the item physically resides.
|
|
*/
|
|
virtual LSET GetLayerSet() const
|
|
{
|
|
if( m_layer == UNDEFINED_LAYER )
|
|
return LSET();
|
|
else
|
|
return LSET( { m_layer } );
|
|
}
|
|
|
|
virtual void SetLayerSet( const LSET& aLayers )
|
|
{
|
|
if( aLayers.count() == 1 )
|
|
{
|
|
SetLayer( aLayers.Seq()[0] );
|
|
return;
|
|
}
|
|
|
|
wxFAIL_MSG( wxT( "Attempted to SetLayerSet() on a single-layer object." ) );
|
|
|
|
// Derived classes which support multiple layers must implement this
|
|
}
|
|
|
|
bool IsSideSpecific() const;
|
|
|
|
/**
|
|
* Set the layer this item is on.
|
|
*
|
|
* This method is virtual because some items (in fact: class DIMENSION)
|
|
* have a slightly different initialization.
|
|
*
|
|
* @param aLayer The layer number.
|
|
*/
|
|
virtual void SetLayer( PCB_LAYER_ID aLayer )
|
|
{
|
|
m_layer = aLayer;
|
|
}
|
|
|
|
/**
|
|
* Create a copy of this #BOARD_ITEM.
|
|
*/
|
|
virtual BOARD_ITEM* Duplicate() const;
|
|
|
|
/**
|
|
* Swap data between \a aItem and \a aImage.
|
|
*
|
|
* \a aItem and \a aImage should have the same type.
|
|
*
|
|
* Used in undo and redo commands to swap values between an item and its copy.
|
|
* Only values like layer, size .. which are modified by editing are swapped.
|
|
*
|
|
* @param aImage the item image which contains data to swap.
|
|
*/
|
|
void SwapItemData( BOARD_ITEM* aImage );
|
|
|
|
/**
|
|
* Test to see if this object is on the given layer.
|
|
*
|
|
* Virtual so objects like #PAD, which reside on multiple layers can do their own form
|
|
* of testing.
|
|
*
|
|
* @param aLayer The layer to test for.
|
|
* @return true if on given layer, else false.
|
|
*/
|
|
virtual bool IsOnLayer( PCB_LAYER_ID aLayer ) const
|
|
{
|
|
return m_layer == aLayer;
|
|
}
|
|
|
|
virtual bool IsKnockout() const { return m_isKnockout; }
|
|
virtual void SetIsKnockout( bool aKnockout ) { m_isKnockout = aKnockout; }
|
|
|
|
bool IsLocked() const override;
|
|
void SetLocked( bool aLocked ) override { m_isLocked = aLocked; }
|
|
|
|
virtual void StyleFromSettings( const BOARD_DESIGN_SETTINGS& settings ) { }
|
|
|
|
/**
|
|
* Delete this object after removing from its parent if it has one.
|
|
*/
|
|
void DeleteStructure();
|
|
|
|
/**
|
|
* Move this object.
|
|
*
|
|
* @param aMoveVector the move vector for this object.
|
|
*/
|
|
virtual void Move( const VECTOR2I& aMoveVector )
|
|
{
|
|
wxFAIL_MSG( wxT( "virtual BOARD_ITEM::Move called for " ) + GetClass() );
|
|
}
|
|
|
|
/**
|
|
* Rotate this object.
|
|
*
|
|
* @param aRotCentre the rotation center point.
|
|
*/
|
|
virtual void Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle );
|
|
|
|
/**
|
|
* Flip this object, i.e. change the board side for this object.
|
|
*
|
|
* @param aCentre the rotation point.
|
|
* @param aFlipDirection the flip direction
|
|
*/
|
|
virtual void Flip( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection );
|
|
|
|
/**
|
|
* Mirror this object relative to a given horizontal axis the layer is not changed.
|
|
*
|
|
* @param aCentre the mirror point.
|
|
* @param aMirrorAroundXAxis mirror across X axis instead of Y (the default).
|
|
*/
|
|
virtual void Mirror( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection );
|
|
|
|
/**
|
|
* Perform any normalization required after a user rotate and/or flip.
|
|
*/
|
|
virtual void Normalize() {}
|
|
|
|
/**
|
|
* Perform any normalization required to compare 2 graphics, especially
|
|
* if the can be rotated and/or flipped.
|
|
* Similar to Normalize(), but more changes can be made
|
|
*/
|
|
virtual void NormalizeForCompare() { Normalize(); }
|
|
|
|
/**
|
|
* Return the #BOARD in which this #BOARD_ITEM resides, or NULL if none.
|
|
*/
|
|
virtual const BOARD* GetBoard() const;
|
|
virtual BOARD* GetBoard();
|
|
|
|
/**
|
|
* For "parent" property.
|
|
* @return the parent footprint's ref or the parent item's UUID.
|
|
*/
|
|
wxString GetParentAsString() const;
|
|
|
|
/**
|
|
* Return the name of the PCB layer on which the item resides.
|
|
*
|
|
* @return the layer name associated with this item.
|
|
*/
|
|
wxString GetLayerName() const;
|
|
|
|
virtual std::vector<int> ViewGetLayers() const override;
|
|
|
|
/**
|
|
* Convert the item shape to a closed polygon. Circles and arcs are approximated by segments.
|
|
*
|
|
* @param aBuffer a buffer to store the polygon.
|
|
* @param aClearance the clearance around the pad.
|
|
* @param aError the maximum deviation from true circle.
|
|
* @param aErrorLoc should the approximation error be placed outside or inside the polygon?
|
|
* @param ignoreLineWidth used for edge cut items where the line width is only
|
|
* for visualization.
|
|
*/
|
|
virtual void TransformShapeToPolygon( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer,
|
|
int aClearance, int aError, ERROR_LOC aErrorLoc,
|
|
bool ignoreLineWidth = false ) const;
|
|
|
|
/**
|
|
* Convert the item shape to a polyset. Circles and arcs are approximated by segments; hatched
|
|
* fills will be included.
|
|
*
|
|
* @param aBuffer a buffer to store the polygon.
|
|
* @param aClearance the clearance around the pad.
|
|
* @param aError the maximum deviation from true circle.
|
|
* @param aErrorLoc should the approximation error be placed outside or inside the polygon?
|
|
* @param ignoreLineWidth used for edge cut items where the line width is only
|
|
* for visualization.
|
|
*/
|
|
virtual void TransformShapeToPolySet( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer,
|
|
int aClearance, int aError, ERROR_LOC aErrorLoc ) const
|
|
{
|
|
TransformShapeToPolygon( aBuffer, aLayer, aClearance, aError, aErrorLoc );
|
|
}
|
|
|
|
enum COMPARE_FLAGS : int
|
|
{
|
|
DRC = 0x01
|
|
};
|
|
|
|
struct ptr_cmp
|
|
{
|
|
bool operator() ( const BOARD_ITEM* a, const BOARD_ITEM* b ) const;
|
|
};
|
|
|
|
protected:
|
|
/**
|
|
* Return a string (to be shown to the user) describing a layer mask.
|
|
*/
|
|
virtual wxString layerMaskDescribe() const;
|
|
|
|
virtual void swapData( BOARD_ITEM* aImage );
|
|
|
|
protected:
|
|
PCB_LAYER_ID m_layer;
|
|
bool m_isKnockout;
|
|
|
|
bool m_isLocked;
|
|
};
|
|
|
|
#ifndef SWIG
|
|
DECLARE_ENUM_TO_WXANY( PCB_LAYER_ID );
|
|
#endif
|
|
|
|
|
|
/**
|
|
* A singleton item of this class is returned for a weak reference that no longer exists.
|
|
*
|
|
* Its sole purpose is to flag the item as having been deleted.
|
|
*/
|
|
class DELETED_BOARD_ITEM : public BOARD_ITEM
|
|
{
|
|
public:
|
|
DELETED_BOARD_ITEM() :
|
|
BOARD_ITEM( nullptr, NOT_USED )
|
|
{}
|
|
|
|
wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override
|
|
{
|
|
return _( "(Deleted Item)" );
|
|
}
|
|
|
|
wxString GetClass() const override
|
|
{
|
|
return wxT( "DELETED_BOARD_ITEM" );
|
|
}
|
|
|
|
// pure virtuals:
|
|
void SetPosition( const VECTOR2I& ) override {}
|
|
VECTOR2I GetPosition() const override { return VECTOR2I( 0, 0 ); }
|
|
|
|
static DELETED_BOARD_ITEM* GetInstance()
|
|
{
|
|
static DELETED_BOARD_ITEM* item = nullptr;
|
|
|
|
if( !item )
|
|
item = new DELETED_BOARD_ITEM();
|
|
|
|
return item;
|
|
}
|
|
|
|
double Similarity( const BOARD_ITEM& aItem ) const override
|
|
{
|
|
return ( this == &aItem ) ? 1.0 : 0.0;
|
|
}
|
|
|
|
bool operator==( const BOARD_ITEM& aBoardItem ) const override
|
|
{
|
|
return ( this == &aBoardItem );
|
|
}
|
|
|
|
bool operator==( const DELETED_BOARD_ITEM& aOther ) const
|
|
{
|
|
return ( this == &aOther );
|
|
}
|
|
|
|
#if defined(DEBUG)
|
|
void Show( int , std::ostream& ) const override {}
|
|
#endif
|
|
};
|