2016-04-02 12:52:29 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
|
|
*
|
|
|
|
* Created on: 11 Mar 2016, author John Beard
|
2020-02-20 12:11:04 +00:00
|
|
|
* Copyright (C) 1992-2020 KiCad Developers, see AUTHORS.txt for contributors.
|
2016-04-02 12:52:29 +00:00
|
|
|
*
|
|
|
|
* 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"
|
2018-12-18 16:37:36 +00:00
|
|
|
|
2019-01-25 16:00:29 +00:00
|
|
|
#include <array_pad_name_provider.h>
|
2016-06-21 15:06:28 +00:00
|
|
|
#include <board_commit.h>
|
2018-12-18 16:37:36 +00:00
|
|
|
#include <pad_naming.h>
|
2016-04-02 12:52:29 +00:00
|
|
|
|
|
|
|
#include <dialogs/dialog_create_array.h>
|
|
|
|
|
2019-01-24 18:15:21 +00:00
|
|
|
/**
|
|
|
|
* Transform a #BOARD_ITEM from the given #ARRAY_OPTIONS and an index into the array.
|
|
|
|
*
|
|
|
|
* @param aArrOpts The array options that describe the array
|
|
|
|
* @param aIndex The index in the array of this item
|
|
|
|
* @param aItem The item to transform
|
|
|
|
*/
|
|
|
|
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 );
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2016-04-02 12:52:29 +00:00
|
|
|
void ARRAY_CREATOR::Invoke()
|
|
|
|
{
|
|
|
|
// bail out if no items
|
2019-06-01 11:11:05 +00:00
|
|
|
if( m_selection.Size() == 0 )
|
2016-04-02 12:52:29 +00:00
|
|
|
return;
|
|
|
|
|
2019-06-01 20:30:58 +00:00
|
|
|
MODULE* const module = m_editModules ? m_parent.GetBoard()->GetFirstModule() : nullptr;
|
2016-04-02 12:52:29 +00:00
|
|
|
|
2019-06-01 11:11:05 +00:00
|
|
|
const bool enableArrayNumbering = m_editModules;
|
|
|
|
const wxPoint rotPoint = (wxPoint) m_selection.GetCenter();
|
2016-04-02 12:52:29 +00:00
|
|
|
|
2019-05-15 17:07:34 +00:00
|
|
|
std::unique_ptr<ARRAY_OPTIONS> array_opts;
|
|
|
|
|
|
|
|
DIALOG_CREATE_ARRAY dialog( &m_parent, array_opts, enableArrayNumbering, rotPoint );
|
2016-04-02 12:52:29 +00:00
|
|
|
|
2019-05-15 17:07:34 +00:00
|
|
|
int ret = dialog.ShowModal();
|
2016-04-02 12:52:29 +00:00
|
|
|
|
2016-06-21 15:06:28 +00:00
|
|
|
if( ret != wxID_OK || array_opts == NULL )
|
|
|
|
return;
|
|
|
|
|
2017-04-19 12:15:11 +00:00
|
|
|
BOARD_COMMIT commit( &m_parent );
|
|
|
|
|
2019-01-25 16:00:29 +00:00
|
|
|
ARRAY_PAD_NAME_PROVIDER pad_name_provider( module, *array_opts );
|
|
|
|
|
2019-06-01 11:11:05 +00:00
|
|
|
for ( int i = 0; i < m_selection.Size(); ++i )
|
2016-04-02 12:52:29 +00:00
|
|
|
{
|
2019-06-01 11:11:05 +00:00
|
|
|
BOARD_ITEM* item = static_cast<BOARD_ITEM*>( m_selection[ i ] );
|
2016-04-02 12:52:29 +00:00
|
|
|
|
2019-06-01 11:11:05 +00:00
|
|
|
if( item->Type() == PCB_PAD_T && !m_editModules )
|
2016-04-02 12:52:29 +00:00
|
|
|
{
|
2016-06-21 15:06:28 +00:00
|
|
|
// If it is not the module editor, then duplicate the parent module instead
|
|
|
|
item = static_cast<MODULE*>( item )->GetParent();
|
2016-04-02 12:52:29 +00:00
|
|
|
}
|
|
|
|
|
2016-06-21 15:06:28 +00:00
|
|
|
// The first item in list is the original item. We do not modify it
|
2019-01-25 21:03:25 +00:00
|
|
|
for( int ptN = 0; ptN < array_opts->GetArraySize(); ptN++ )
|
2016-04-02 12:52:29 +00:00
|
|
|
{
|
2019-01-25 21:03:25 +00:00
|
|
|
BOARD_ITEM* this_item;
|
2016-04-02 12:52:29 +00:00
|
|
|
|
2019-01-25 21:03:25 +00:00
|
|
|
if( ptN == 0 )
|
2016-04-02 12:52:29 +00:00
|
|
|
{
|
2019-01-25 21:03:25 +00:00
|
|
|
// the first point: we don't own this or add it, but
|
|
|
|
// we might still modify it (position or label)
|
|
|
|
this_item = item;
|
2016-04-02 12:52:29 +00:00
|
|
|
}
|
2016-06-21 15:06:28 +00:00
|
|
|
else
|
2016-04-02 12:52:29 +00:00
|
|
|
{
|
2019-01-25 21:03:25 +00:00
|
|
|
// Need to create a new item
|
2020-02-20 12:11:04 +00:00
|
|
|
BOARD_ITEM* new_item = nullptr;
|
2016-04-02 12:52:29 +00:00
|
|
|
|
2019-06-01 11:11:05 +00:00
|
|
|
if( m_editModules )
|
2019-01-25 21:03:25 +00:00
|
|
|
{
|
|
|
|
// Don't bother incrementing pads: the module won't update
|
|
|
|
// until commit, so we can only do this once
|
2020-05-03 07:59:05 +00:00
|
|
|
new_item = module->DuplicateItem( item );
|
2019-01-25 21:03:25 +00:00
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
2020-02-20 12:11:04 +00:00
|
|
|
switch( item->Type() )
|
|
|
|
{
|
|
|
|
case PCB_MODULE_T:
|
|
|
|
case PCB_TEXT_T:
|
|
|
|
case PCB_LINE_T:
|
|
|
|
case PCB_TRACE_T:
|
|
|
|
case PCB_VIA_T:
|
|
|
|
case PCB_ZONE_AREA_T:
|
|
|
|
case PCB_TARGET_T:
|
2020-09-12 20:09:40 +00:00
|
|
|
case PCB_DIM_ALIGNED_T:
|
2020-09-17 00:54:58 +00:00
|
|
|
case PCB_DIM_CENTER_T:
|
|
|
|
case PCB_DIM_ORTHOGONAL_T:
|
2020-09-12 20:09:40 +00:00
|
|
|
case PCB_DIM_LEADER_T:
|
2020-02-20 12:11:04 +00:00
|
|
|
new_item = item->Duplicate();
|
|
|
|
break;
|
|
|
|
|
|
|
|
default:
|
|
|
|
// Silently drop other items (such as footprint texts) from duplication
|
|
|
|
break;
|
|
|
|
}
|
2018-07-24 18:41:08 +00:00
|
|
|
|
2019-03-08 10:32:34 +00:00
|
|
|
// PCB items keep the same numbering
|
|
|
|
|
|
|
|
// @TODO: renumber modules if asked. This needs UI to enable.
|
|
|
|
// something like this, but needs a "block offset" to prevent
|
|
|
|
// multiple selections overlapping.
|
|
|
|
// if( new_item->Type() == PCB_MODULE_T )
|
|
|
|
// static_cast<MODULE&>( *new_item ).IncrementReference( ptN );
|
2019-01-25 21:03:25 +00:00
|
|
|
|
|
|
|
// @TODO: we should merge zones. This is a bit tricky, because
|
|
|
|
// the undo command needs saving old area, if it is merged.
|
|
|
|
}
|
|
|
|
|
2020-01-12 01:29:12 +00:00
|
|
|
this_item = new_item;
|
2019-01-25 21:03:25 +00:00
|
|
|
|
|
|
|
if( new_item )
|
|
|
|
{
|
2019-06-01 11:11:05 +00:00
|
|
|
// 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_MODULE_T )
|
|
|
|
{
|
2020-08-10 13:22:02 +00:00
|
|
|
static_cast<MODULE*>( this_item )->RunOnChildren(
|
|
|
|
[&]( BOARD_ITEM* aItem )
|
|
|
|
{
|
|
|
|
aItem->ClearSelected();
|
|
|
|
});
|
2019-06-01 11:11:05 +00:00
|
|
|
}
|
|
|
|
|
2020-01-12 01:29:12 +00:00
|
|
|
commit.Add( new_item );
|
2019-01-25 21:03:25 +00:00
|
|
|
}
|
2016-06-21 15:06:28 +00:00
|
|
|
}
|
2016-04-02 12:52:29 +00:00
|
|
|
|
2019-01-25 21:03:25 +00:00
|
|
|
// always transform the item
|
|
|
|
if( this_item )
|
2016-06-21 15:06:28 +00:00
|
|
|
{
|
2019-01-25 21:03:25 +00:00
|
|
|
commit.Modify( this_item );
|
|
|
|
TransformItem( *array_opts, ptN, *this_item );
|
2016-06-21 15:06:28 +00:00
|
|
|
}
|
2016-04-02 12:52:29 +00:00
|
|
|
|
2016-06-21 15:06:28 +00:00
|
|
|
// 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
|
2019-01-25 21:03:25 +00:00
|
|
|
if( this_item && array_opts->ShouldNumberItems() )
|
2016-06-21 15:06:28 +00:00
|
|
|
{
|
2018-07-24 09:39:18 +00:00
|
|
|
// Renumber non-aperture pads.
|
2019-01-25 21:03:25 +00:00
|
|
|
if( this_item->Type() == PCB_PAD_T )
|
2016-04-02 12:52:29 +00:00
|
|
|
{
|
2019-01-25 21:03:25 +00:00
|
|
|
auto& pad = static_cast<D_PAD&>( *this_item );
|
2018-07-24 09:39:18 +00:00
|
|
|
|
2019-01-25 21:03:25 +00:00
|
|
|
if( PAD_NAMING::PadCanHaveName( pad ) )
|
2019-01-25 16:00:29 +00:00
|
|
|
{
|
|
|
|
wxString newName = pad_name_provider.GetNextPadName();
|
2019-01-25 21:03:25 +00:00
|
|
|
pad.SetName( newName );
|
2019-01-25 16:00:29 +00:00
|
|
|
}
|
2016-04-02 12:52:29 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2016-06-21 15:06:28 +00:00
|
|
|
|
|
|
|
commit.Push( _( "Create an array" ) );
|
2016-04-02 12:52:29 +00:00
|
|
|
}
|