array_creator.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Created on: 11 Mar 2016, author John Beard
 * Copyright (C) 2016-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
 */

#include "array_creator.h"

#include <array_pad_number_provider.h>
#include <board_commit.h>
#include <pcb_group.h>
#include <pad.h>
#include <dialogs/dialog_create_array.h>
#include <tool/tool_manager.h>
#include <tools/board_reannotate_tool.h>
#include <tools/pcb_selection_tool.h>

static void TransformItem( const ARRAY_OPTIONS& aArrOpts, int aIndex, BOARD_ITEM& aItem )
{
 const ARRAY_OPTIONS::TRANSFORM transform = aArrOpts.GetTransform( aIndex, aItem.GetPosition() );

 aItem.Move( (wxPoint) transform.m_offset );
 aItem.Rotate( aItem.GetPosition(), transform.m_rotation * 10 );
}


void ARRAY_CREATOR::Invoke()
{
 // bail out if no items
 if( m_selection.Size() == 0 )
 return;

 FOOTPRINT* const fp = m_isFootprintEditor ? m_parent.GetBoard()->GetFirstFootprint() : nullptr;

 const bool enableArrayNumbering = m_isFootprintEditor;
 const wxPoint rotPoint = (wxPoint) m_selection.GetCenter();

 std::unique_ptr<ARRAY_OPTIONS> array_opts;

 DIALOG_CREATE_ARRAY dialog( &m_parent, array_opts, enableArrayNumbering, rotPoint );

 int ret = dialog.ShowModal();

 if( ret != wxID_OK || array_opts == nullptr )
 return;

 BOARD_COMMIT commit( &m_parent );

 ARRAY_PAD_NUMBER_PROVIDER pad_number_provider( fp, *array_opts );

 std::vector<EDA_ITEM*> all_added_items;

 // The first item in list is the original item. We do not modify it
 for( int ptN = 0; ptN < array_opts->GetArraySize(); ptN++ )
 {
 PCB_SELECTION items_for_this_block;

 for ( int i = 0; i < m_selection.Size(); ++i )
 {
 BOARD_ITEM* item = static_cast<BOARD_ITEM*>( m_selection[ i ] );

 if( item->Type() == PCB_PAD_T && !m_isFootprintEditor )
 {
 // If it is not the footprint editor, then duplicate the parent footprint instead
 item = static_cast<FOOTPRINT*>( item )->GetParent();
 }

 BOARD_ITEM* this_item = nullptr;

 if( ptN == 0 )
 {
 // the first point: we don't own this or add it, but
 // we might still modify it (position or label)
 this_item = item;
 }
 else
 {
 if( m_isFootprintEditor )
 {
 // Don't bother incrementing pads: the footprint won't update until commit,
 // so we can only do this once
 this_item = fp->DuplicateItem( item );
 }
 else
 {
 switch( item->Type() )
 {
 case PCB_FOOTPRINT_T:
 case PCB_SHAPE_T:
 case PCB_TEXT_T:
 case PCB_TRACE_T:
 case PCB_ARC_T:
 case PCB_VIA_T:
 case PCB_DIM_ALIGNED_T:
 case PCB_DIM_CENTER_T:
 case PCB_DIM_ORTHOGONAL_T:
 case PCB_DIM_LEADER_T:
 case PCB_TARGET_T:
 case PCB_ZONE_T:
 this_item = item->Duplicate();
 break;

 case PCB_GROUP_T:
 this_item = static_cast<PCB_GROUP*>( item )->DeepDuplicate();
 break;

 default:
 // Silently drop other items (such as footprint texts) from duplication
 break;
 }

 // @TODO: we should merge zones. This is a bit tricky, because
 // the undo command needs saving old area, if it is merged.
 }

 // Add new items to selection (footprints in the selection will be reannotated)
 items_for_this_block.Add( this_item );

 if( this_item )
 {
 // Because aItem is/can be created from a selected item, and inherits from
 // it this state, reset the selected stated of aItem:
 this_item->ClearSelected();

 if( this_item->Type() == PCB_GROUP_T )
 {
 static_cast<PCB_GROUP*>( this_item )->RunOnDescendants(
 [&]( BOARD_ITEM* aItem )
 {
 aItem->ClearSelected();
 commit.Add( aItem );
 });
 }
 else if( this_item->Type() == PCB_FOOTPRINT_T )
 {
 static_cast<FOOTPRINT*>( this_item )->RunOnChildren(
 [&]( BOARD_ITEM* aItem )
 {
 aItem->ClearSelected();
 });
 }

 commit.Add( this_item );
 }
 }

 // always transform the item
 if( this_item )
 {
 commit.Modify( this_item );
 TransformItem( *array_opts, ptN, *this_item );
 }

 // attempt to renumber items if the array parameters define
 // a complete numbering scheme to number by (as opposed to
 // implicit numbering by incrementing the items during creation
 if( this_item && array_opts->ShouldNumberItems() )
 {
 // Renumber non-aperture pads.
 if( this_item->Type() == PCB_PAD_T )
 {
 PAD& pad = static_cast<PAD&>( *this_item );

 if( pad.CanHaveNumber() )
 {
 wxString newNumber = pad_number_provider.GetNextPadNumber();
 pad.SetNumber( newNumber );
 }
 }
 }
 }

 if( !m_isFootprintEditor && array_opts->ShouldReannotateFootprints() )
 {
 m_toolMgr->GetTool<BOARD_REANNOTATE_TOOL>()->ReannotateDuplicates( items_for_this_block,
 all_added_items );
 }

 for( EDA_ITEM* item : items_for_this_block )
 all_added_items.push_back( item );
 }

 m_toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
 m_toolMgr->RunAction( PCB_ACTIONS::selectItems, true, &all_added_items );

 commit.Push( _( "Create an array" ) );
}