board_item.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2012 Jean-Pierre Charras, [email protected]
 * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#include <wx/debug.h>
#include <wx/msgdlg.h>
 
#include <i18n_utility.h>
#include <macros.h>
#include <board.h>
#include <board_item_index.h>
#include <board_design_settings.h>
#include <board_design_settings_defaults.h>
#include <lset.h>
#include <pcb_group.h>
#include <pcb_generator.h>
#include <footprint.h>
#include <font/font.h>
#include <properties/property.h>
#include <properties/property_mgr.h>
 
 
bool BOARD_ITEM::FitsEnabledLayers( const LSET& aEnabledLayers, int aCopperLayerCount ) const
{
    return IsLayerAgnostic() || ( GetLayerSet() & aEnabledLayers ).any();
}
 
 
bool BOARD_ITEM::IsGroupableType() const
{
    switch ( Type() )
    {
    case PCB_FOOTPRINT_T:
    case PCB_PAD_T:
    case PCB_SHAPE_T:
    case PCB_REFERENCE_IMAGE_T:
    case PCB_FIELD_T:
    case PCB_TEXT_T:
    case PCB_TEXTBOX_T:
    case PCB_TABLE_T:
    case PCB_DRILL_CHART_T:
    case PCB_DRILL_MAP_T:
    case PCB_GROUP_T:
    case PCB_GENERATOR_T:
    case PCB_TRACE_T:
    case PCB_VIA_T:
    case PCB_ARC_T:
    case PCB_DIMENSION_T:
    case PCB_DIM_ALIGNED_T:
    case PCB_DIM_LEADER_T:
    case PCB_DIM_CENTER_T:
    case PCB_DIM_RADIAL_T:
    case PCB_DIM_ORTHOGONAL_T:
    case PCB_ZONE_T:
    case PCB_BARCODE_T:
    case PCB_POINT_T:
    case PCB_GRID_ITEM_T:
        return true;
    default:
        return false;
    }
}
 
 
void BOARD_ITEM::CopyFrom( const BOARD_ITEM* aOther )
{
    wxCHECK( aOther, /* void */ );
    *this = *aOther;
}
 
 
const BOARD* BOARD_ITEM::GetBoard() const
{
    if( Type() == PCB_T )
        return static_cast<const BOARD*>( this );
 
    return static_cast<const BOARD*>( findParent( PCB_T ) );
}
 
 
BOARD* BOARD_ITEM::GetBoard()
{
    if( Type() == PCB_T )
        return static_cast<BOARD*>( this );
 
    return static_cast<BOARD*>( findParent( PCB_T ) );
}
 
 
BOARD_ITEM::~BOARD_ITEM()
{
    // Backup for code paths that skip ::Remove(). Do not use the parent chain, it may be freed.
    if( m_owningIndex )
        m_owningIndex->UnbindItem( *this );
}
 
 
FOOTPRINT* BOARD_ITEM::GetParentFootprint() const
{
    return static_cast<FOOTPRINT*>( findParent( PCB_FOOTPRINT_T ) );
}
 
 
void BOARD_ITEM::SetUuid( const KIID& aUuid )
{
    if( m_Uuid == aUuid )
        return;
 
    // Use the index that holds us, not GetBoard(). The parent chain may name a wrong or dead
    // board.
    if( BOARD_ITEM_INDEX* owningIndex = m_owningIndex )
    {
        owningIndex->Rebind( *this, aUuid );
        return;
    }
 
    SetUuidDirect( aUuid );
}
 
 
void BOARD_ITEM::SetUuidDirect( const KIID& aUuid )
{
    const_cast<KIID&>( m_Uuid ) = aUuid;
}
 
 
bool BOARD_ITEM::IsLocked() const
{
    if( EDA_GROUP* group = GetParentGroup() )
    {
        if( group->AsEdaItem()->IsLocked() )
            return true;
    }
 
    if( !GetBoard() || GetBoard()->GetBoardUse() == BOARD_USE::FPHOLDER )
        return false;
 
    return m_isLocked;
}
 
 
STROKE_PARAMS BOARD_ITEM::GetStroke() const
{
    wxFAIL_MSG( wxString( "GetStroke() not defined by " ) + GetClass() );
 
    return STROKE_PARAMS( pcbIUScale.mmToIU( DEFAULT_LINE_WIDTH ) );
}
 
 
void BOARD_ITEM::SetStroke( const STROKE_PARAMS& aStroke )
{
    wxFAIL_MSG( wxString( "SetStroke() not defined by " ) + GetClass() );
}
 
 
const KIFONT::METRICS& BOARD_ITEM::GetFontMetrics() const
{
    return KIFONT::METRICS::Default();
}
 
 
int BOARD_ITEM::GetMaxError() const
{
    if( const BOARD* board = GetBoard() )
        return board->GetDesignSettings().m_MaxError;
 
    return ARC_HIGH_DEF;
}
 
 
PCB_LAYER_ID BOARD_ITEM::GetLayer() const
{
    wxASSERT_MSG( IsSingleLayerType( Type() ),
                  wxString::Format( wxT( "GetLayer() must be overridden for multi-layer types (%s)." ), GetClass() ) );
 
    return m_layer;
}
 
 
PCB_LAYER_ID BOARD_ITEM::GetFlippedLayer( PCB_LAYER_ID aLayer ) const
{
    const BOARD* board = GetBoard();
 
    if( board )
        return board->FlipLayer( aLayer );
 
    return ::FlipLayer( aLayer );
}
 
int BOARD_ITEM::BoardLayerCount() const
{
    const BOARD* board = GetBoard();
 
    if( board )
        return board->GetLayerSet().count();
 
    return 64;
}
 
 
int BOARD_ITEM::BoardCopperLayerCount() const
{
    const BOARD* board = GetBoard();
 
    if( board )
        return board->GetCopperLayerCount();
 
    return 32;
}
 
 
LSET BOARD_ITEM::BoardLayerSet() const
{
    const BOARD* board = GetBoard();
 
    if( board )
        return board->GetEnabledLayers();
 
    return LSET::AllLayersMask();
}
 
 
wxString BOARD_ITEM::GetLayerName() const
{
    return GetLayerName( m_layer );
}
 
 
wxString BOARD_ITEM::GetLayerName( PCB_LAYER_ID aLayer ) const
{
    const BOARD* board = GetBoard();
 
    if( board )
        return board->GetLayerName( aLayer );
 
    // If no parent, return standard name
    return BOARD::GetStandardLayerName( aLayer );
}
 
 
bool BOARD_ITEM::IsSideSpecific() const
{
    if( ( GetLayerSet() & LSET::SideSpecificMask() ).any() )
        return true;
 
    if( const BOARD* board = GetBoard() )
    {
        LAYER_T principalLayerType = board->GetLayerType( m_layer );
 
        if( principalLayerType == LT_FRONT || principalLayerType == LT_BACK )
            return true;
    }
 
    return false;
}
 
 
wxString BOARD_ITEM::LayerMaskDescribe() const
{
    const BOARD* board = GetBoard();
    LSET         layers = GetLayerSet();
    int          copperLayerCount = MAX_CU_LAYERS;
 
    if( board )
    {
        layers &= board->GetEnabledLayers();
        copperLayerCount = board->GetCopperLayerCount();
    }
 
    LSET copperLayers = layers & LSET::AllCuMask();
    LSET techLayers = layers & LSET::AllTechMask();
 
    // Try to be smart and useful.  Check all copper first.
    if( (int) copperLayers.count() == copperLayerCount )
        return _( "all copper layers" );
 
    for( LSET testLayers : { copperLayers, techLayers, layers } )
    {
        for( int layer = PCBNEW_LAYER_ID_START; layer < PCB_LAYER_ID_COUNT; ++layer )
        {
            if( testLayers[ layer ] )
            {
                wxString layerInfo = board ? board->GetLayerName( ToLAYER_ID( layer ) )
                                           : LayerName( ToLAYER_ID( layer ) );
 
                if( testLayers.count() > 1 )
                    layerInfo << wxS( " " ) + _( "and others" );
 
                return layerInfo;
            }
        }
    }
 
    // No copper, no technicals: no layer
    return _( "no layers" );
}
 
 
std::vector<int> BOARD_ITEM::ViewGetLayers() const
{
    // Basic fallback
    if( IsLocked() )
        return { m_layer, LAYER_LOCKED_ITEM_SHADOW };
 
    return { m_layer };
}
 
 
void BOARD_ITEM::DeleteStructure()
{
    BOARD_ITEM_CONTAINER* parent = GetParent();
 
    if( parent )
        parent->Remove( this );
 
    delete this;
}
 
 
void BOARD_ITEM::swapData( BOARD_ITEM* aImage )
{
    UNIMPLEMENTED_FOR( GetClass() );
}
 
 
void BOARD_ITEM::SwapItemData( BOARD_ITEM* aImage )
{
    if( aImage == nullptr )
        return;
 
    EDA_ITEM*  parent = GetParent();
    EDA_GROUP* group = GetParentGroup();
    EDA_GROUP* imageGroup = aImage->GetParentGroup();
    BOARD*     board = GetBoard();
 
    // Evict children from the item-by-id cache before the swap moves them to the
    // image.  The image is typically deleted after the swap (undo/redo, commit revert),
    // which would leave the cache holding dangling pointers to the destroyed children.
    if( board )
    {
        board->UncacheChildrenById( *this );
    }
 
    swapData( aImage );
    SetParent( parent );
 
    // Group membership is a back-reference, not item data, so keep each side's own.
    SetParentGroup( group );
    aImage->SetParentGroup( imageGroup );
 
    if( board )
    {
        board->CacheChildrenById( *this );
    }
}
 
 
BOARD_ITEM* BOARD_ITEM::Duplicate( bool addToParentGroup, BOARD_COMMIT* aCommit ) const
{
    BOARD_ITEM* dupe = static_cast<BOARD_ITEM*>( Clone() );
    dupe->ResetUuid();
 
    if( addToParentGroup )
    {
        wxCHECK_MSG( aCommit, dupe, "Must supply a commit to update parent group" );
 
        if( EDA_GROUP* group = dupe->GetParentGroup() )
        {
            aCommit->Modify( group->AsEdaItem(), nullptr, RECURSE_MODE::NO_RECURSE );
            group->AddItem( dupe );
        }
    }
 
    return dupe;
}
 
 
void BOARD_ITEM::TransformShapeToPolygon( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer,
                                          int aClearance, int aError, ERROR_LOC aErrorLoc,
                                          bool ignoreLineWidth ) const
{
    wxCHECK_MSG( false, /* void */,
                 wxString::Format( wxT( "%s doesn't implement TransformShapeToPolygon()" ), GetClass() ) );
}
 
 
double BOARD_ITEM::GetCoverageArea( int aTextMargin ) const
{
    SHAPE_POLY_SET poly;
    TransformShapeToPolygon( poly, UNDEFINED_LAYER, 0, ARC_LOW_DEF, ERROR_OUTSIDE );
    return polygonArea( poly );
}
 
 
double BOARD_ITEM::polygonArea( SHAPE_POLY_SET& aPolySet )
{
    for( int ii = 0; ii < aPolySet.OutlineCount(); ii++ )
    {
        aPolySet.Outline( ii ).SetClosed( true );
 
        for( int jj = 0; jj < aPolySet.HoleCount( ii ); jj++ )
            aPolySet.Hole( ii, jj ).SetClosed( true );
    }
 
    return aPolySet.Area();
}
 
 
bool BOARD_ITEM::ptr_cmp::operator() ( const BOARD_ITEM* a, const BOARD_ITEM* b ) const
{
    if( a->Type() != b->Type() )
        return a->Type() < b->Type();
 
    if( a->GetLayerSet() != b->GetLayerSet() )
        return a->GetLayerSet().Seq() < b->GetLayerSet().Seq();
 
    if( a->m_Uuid != b->m_Uuid )       // UUIDs *should* always be unique (for valid boards anyway)
        return a->m_Uuid < b->m_Uuid;
 
    return a < b;                      // But just in case; ptrs are guaranteed to be different
}
 
 
std::shared_ptr<SHAPE> BOARD_ITEM::GetEffectiveShape( PCB_LAYER_ID, FLASHING, DRC_CONSTRAINT_T ) const
{
    static std::shared_ptr<SHAPE> shape;
 
    UNIMPLEMENTED_FOR( GetClass() );
 
    return shape;
}
 
 
std::shared_ptr<SHAPE_SEGMENT> BOARD_ITEM::GetEffectiveHoleShape( PCB_LAYER_ID, DRC_CONSTRAINT_T ) const
{
    static std::shared_ptr<SHAPE_SEGMENT> slot;
 
    UNIMPLEMENTED_FOR( GetClass() );
 
    return slot;
}
 
 
VECTOR2I BOARD_ITEM::GetFPRelativePosition() const
{
    if( FOOTPRINT* parentFP = GetParentFootprint() )
        return parentFP->GetTransform().InverseApply( GetPosition() );
 
    return GetPosition();
}
 
 
void BOARD_ITEM::SetFPRelativePosition( const VECTOR2I& aPos )
{
    if( FOOTPRINT* parentFP = GetParentFootprint() )
        SetPosition( parentFP->GetTransform().Apply( aPos ) );
    else
        SetPosition( aPos );
}
 
 
void BOARD_ITEM::Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle )
{
    wxMessageBox( wxT( "virtual BOARD_ITEM::Rotate used, should not occur" ), GetClass() );
}
 
 
void BOARD_ITEM::Flip( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection )
{
    wxMessageBox( wxT( "virtual BOARD_ITEM::Flip used, should not occur" ), GetClass() );
}
 
 
void BOARD_ITEM::Mirror( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection )
{
    wxMessageBox( wxT( "virtual BOARD_ITEM::Mirror used, should not occur" ), GetClass() );
}
 
 
wxString BOARD_ITEM::GetParentAsString() const
{
    if( FOOTPRINT* fp = dynamic_cast<FOOTPRINT*>( m_parent ) )
        return fp->GetReference();
 
    return m_parent->m_Uuid.AsString();
}
 
 
const std::vector<wxString>* BOARD_ITEM::GetEmbeddedFonts()
{
    if( BOARD* board = GetBoard() )
        return board->GetFontFiles();
 
    return nullptr;
}
 
 
static struct BOARD_ITEM_DESC
{
    BOARD_ITEM_DESC()
    {
        ENUM_MAP<PCB_LAYER_ID>& layerEnum = ENUM_MAP<PCB_LAYER_ID>::Instance();
 
        if( layerEnum.Choices().GetCount() == 0 )
        {
            layerEnum.Undefined( UNDEFINED_LAYER );
 
            for( PCB_LAYER_ID layer : LSET::AllLayersMask() )
                layerEnum.Map( layer, LSET::Name( layer ) );
        }
 
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        REGISTER_TYPE( BOARD_ITEM );
        propMgr.InheritsAfter( TYPE_HASH( BOARD_ITEM ), TYPE_HASH( EDA_ITEM ) );
 
        propMgr.AddProperty( new PROPERTY<BOARD_ITEM, wxString>( _HKI( "Parent" ),
                     NO_SETTER( BOARD_ITEM, wxString ), &BOARD_ITEM::GetParentAsString ) )
                .SetIsHiddenFromLibraryEditors()
                .SetIsHiddenFromPropertiesManager();
 
        auto isNotFootprintHolder =
                []( INSPECTABLE* aItem ) -> bool
                {
                    BOARD_ITEM* item = dynamic_cast<BOARD_ITEM*>( aItem );
                    return item && item->GetBoard() && !item->GetBoard()->IsFootprintHolder();
                };
 
        propMgr.AddProperty( new PROPERTY<BOARD_ITEM, int>( _HKI( "Position X" ),
                    &BOARD_ITEM::SetX, &BOARD_ITEM::GetX, PROPERTY_DISPLAY::PT_COORD,
                    ORIGIN_TRANSFORMS::ABS_X_COORD ) );
        propMgr.AddProperty( new PROPERTY<BOARD_ITEM, int>( _HKI( "Position Y" ),
                    &BOARD_ITEM::SetY, &BOARD_ITEM::GetY, PROPERTY_DISPLAY::PT_COORD,
                    ORIGIN_TRANSFORMS::ABS_Y_COORD ) );
        propMgr.AddProperty( new PROPERTY_ENUM<BOARD_ITEM, PCB_LAYER_ID>( _HKI( "Layer" ),
                    &BOARD_ITEM::SetLayer, &BOARD_ITEM::GetLayer ) ).SetIsCopyable();
        propMgr.AddProperty( new PROPERTY<BOARD_ITEM, bool>( _HKI( "Locked" ),
                    &BOARD_ITEM::SetLocked, &BOARD_ITEM::IsLocked ) )
               .SetAvailableFunc( isNotFootprintHolder );
    }
} _BOARD_ITEM_DESC;
 
IMPLEMENT_ENUM_TO_WXANY( PCB_LAYER_ID )