1075 lines
29 KiB
C++
1075 lines
29 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2012 Jean-Pierre Charras, jean-pierre.charras@ujf-grenoble.fr
|
|
* Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
|
|
* Copyright (C) 2012 Wayne Stambaugh <stambaughw@verizon.net>
|
|
* Copyright (C) 1992-2012 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
|
|
*/
|
|
|
|
/**
|
|
* @file class_module.cpp
|
|
* @brief MODULE class implementation.
|
|
*/
|
|
|
|
#include <fctsys.h>
|
|
#include <gr_basic.h>
|
|
#include <wxstruct.h>
|
|
#include <plot_common.h>
|
|
#include <class_drawpanel.h>
|
|
#include <trigo.h>
|
|
#include <confirm.h>
|
|
#include <kicad_string.h>
|
|
#include <pcbcommon.h>
|
|
#include <pcbnew.h>
|
|
#include <colors_selection.h>
|
|
#include <richio.h>
|
|
#include <filter_reader.h>
|
|
#include <macros.h>
|
|
#include <3d_struct.h>
|
|
#include <msgpanel.h>
|
|
|
|
#include <drag.h>
|
|
#include <class_board.h>
|
|
#include <class_edge_mod.h>
|
|
#include <class_module.h>
|
|
|
|
|
|
MODULE::MODULE( BOARD* parent ) :
|
|
BOARD_ITEM( (BOARD_ITEM*) parent, PCB_MODULE_T )
|
|
{
|
|
m_Attributs = MOD_DEFAULT;
|
|
m_Layer = LAYER_N_FRONT;
|
|
m_Orient = 0;
|
|
m_ModuleStatus = 0;
|
|
flag = 0;
|
|
m_CntRot90 = m_CntRot180 = 0;
|
|
m_Surface = 0.0;
|
|
m_Link = 0;
|
|
m_LastEditTime = time( NULL );
|
|
m_LocalClearance = 0;
|
|
m_LocalSolderMaskMargin = 0;
|
|
m_LocalSolderPasteMargin = 0;
|
|
m_LocalSolderPasteMarginRatio = 0.0;
|
|
m_ZoneConnection = UNDEFINED_CONNECTION; // Use zone setting by default
|
|
m_ThermalWidth = 0; // Use zone setting by default
|
|
m_ThermalGap = 0; // Use zone setting by default
|
|
|
|
m_Reference = new TEXTE_MODULE( this, TEXT_is_REFERENCE );
|
|
|
|
m_Value = new TEXTE_MODULE( this, TEXT_is_VALUE );
|
|
|
|
// Reserve one void 3D entry, to avoid problems with void list
|
|
m_3D_Drawings.PushBack( new S3D_MASTER( this ) );
|
|
}
|
|
|
|
|
|
MODULE::MODULE( const MODULE& aModule ) :
|
|
BOARD_ITEM( aModule )
|
|
{
|
|
m_Pos = aModule.m_Pos;
|
|
m_LibRef = aModule.m_LibRef;
|
|
m_Layer = aModule.m_Layer;
|
|
m_Attributs = aModule.m_Attributs;
|
|
m_ModuleStatus = aModule.m_ModuleStatus;
|
|
m_Orient = aModule.m_Orient;
|
|
m_BoundaryBox = aModule.m_BoundaryBox;
|
|
m_CntRot90 = aModule.m_CntRot90;
|
|
m_CntRot180 = aModule.m_CntRot180;
|
|
m_LastEditTime = aModule.m_LastEditTime;
|
|
m_Link = aModule.m_Link;
|
|
m_Path = aModule.m_Path; //is this correct behavior?
|
|
|
|
m_LocalClearance = aModule.m_LocalClearance;
|
|
m_LocalSolderMaskMargin = aModule.m_LocalSolderMaskMargin;
|
|
m_LocalSolderPasteMargin = aModule.m_LocalSolderPasteMargin;
|
|
m_LocalSolderPasteMarginRatio = aModule.m_LocalSolderPasteMarginRatio;
|
|
m_ZoneConnection = aModule.m_ZoneConnection;
|
|
m_ThermalWidth = aModule.m_ThermalWidth;
|
|
m_ThermalGap = aModule.m_ThermalGap;
|
|
|
|
// Copy reference and value.
|
|
m_Reference = new TEXTE_MODULE( *aModule.m_Reference );
|
|
m_Reference->SetParent( this );
|
|
|
|
m_Value = new TEXTE_MODULE( *aModule.m_Value );
|
|
m_Value->SetParent( this );
|
|
|
|
// Copy auxiliary data: Pads
|
|
// m_Pads.DeleteAll();
|
|
|
|
for( D_PAD* pad = aModule.m_Pads; pad; pad = pad->Next() )
|
|
{
|
|
D_PAD* newpad = new D_PAD( *pad );
|
|
newpad->SetParent( this );
|
|
m_Pads.PushBack( newpad );
|
|
}
|
|
|
|
// Copy auxiliary data: Drawings
|
|
for( BOARD_ITEM* item = aModule.m_Drawings; item; item = item->Next() )
|
|
{
|
|
BOARD_ITEM* newItem;
|
|
|
|
switch( item->Type() )
|
|
{
|
|
case PCB_MODULE_TEXT_T:
|
|
case PCB_MODULE_EDGE_T:
|
|
newItem = (BOARD_ITEM*)item->Clone();
|
|
newItem->SetParent( this );
|
|
m_Drawings.PushBack( newItem );
|
|
break;
|
|
|
|
default:
|
|
wxLogMessage( wxT( "MODULE::Copy() Internal Err: unknown type" ) );
|
|
break;
|
|
}
|
|
}
|
|
|
|
// Copy auxiliary data: 3D_Drawings info
|
|
for( S3D_MASTER* item = aModule.m_3D_Drawings; item; item = item->Next() )
|
|
{
|
|
if( item->m_Shape3DName.IsEmpty() ) // do not copy empty shapes.
|
|
continue;
|
|
|
|
S3D_MASTER* t3d = m_3D_Drawings;
|
|
|
|
t3d = new S3D_MASTER( this );
|
|
t3d->Copy( item );
|
|
m_3D_Drawings.PushBack( t3d );
|
|
}
|
|
|
|
// Ensure there is at least one item in m_3D_Drawings.
|
|
if( m_3D_Drawings.GetCount() == 0 )
|
|
m_3D_Drawings.PushBack( new S3D_MASTER( this ) ); // push a void item
|
|
|
|
m_Doc = aModule.m_Doc;
|
|
m_KeyWord = aModule.m_KeyWord;
|
|
|
|
// Ensure auxiliary data is up to date
|
|
CalculateBoundingBox();
|
|
}
|
|
|
|
|
|
MODULE::~MODULE()
|
|
{
|
|
delete m_Reference;
|
|
delete m_Value;
|
|
}
|
|
|
|
|
|
/* Draw the anchor cross (vertical)
|
|
* Must be done after the pads, because drawing the hole will erase overwrite
|
|
* every thing already drawn.
|
|
*/
|
|
void MODULE::DrawAncre( EDA_DRAW_PANEL* panel, wxDC* DC, const wxPoint& offset,
|
|
int dim_ancre, GR_DRAWMODE draw_mode )
|
|
{
|
|
int anchor_size = DC->DeviceToLogicalXRel( dim_ancre );
|
|
|
|
GRSetDrawMode( DC, draw_mode );
|
|
|
|
if( GetBoard()->IsElementVisible( ANCHOR_VISIBLE ) )
|
|
{
|
|
EDA_COLOR_T color = g_ColorsSettings.GetItemColor( ANCHOR_VISIBLE );
|
|
GRLine( panel->GetClipBox(), DC,
|
|
m_Pos.x - offset.x - anchor_size, m_Pos.y - offset.y,
|
|
m_Pos.x - offset.x + anchor_size, m_Pos.y - offset.y,
|
|
0, color );
|
|
GRLine( panel->GetClipBox(), DC,
|
|
m_Pos.x - offset.x, m_Pos.y - offset.y - anchor_size,
|
|
m_Pos.x - offset.x, m_Pos.y - offset.y + anchor_size,
|
|
0, color );
|
|
}
|
|
}
|
|
|
|
|
|
void MODULE::Copy( MODULE* aModule )
|
|
{
|
|
m_Pos = aModule->m_Pos;
|
|
m_Layer = aModule->m_Layer;
|
|
m_LibRef = aModule->m_LibRef;
|
|
m_Attributs = aModule->m_Attributs;
|
|
m_ModuleStatus = aModule->m_ModuleStatus;
|
|
m_Orient = aModule->m_Orient;
|
|
m_BoundaryBox = aModule->m_BoundaryBox;
|
|
m_CntRot90 = aModule->m_CntRot90;
|
|
m_CntRot180 = aModule->m_CntRot180;
|
|
m_LastEditTime = aModule->m_LastEditTime;
|
|
m_Link = aModule->m_Link;
|
|
m_Path = aModule->m_Path; //is this correct behavior?
|
|
SetTimeStamp( GetNewTimeStamp() );
|
|
|
|
m_LocalClearance = aModule->m_LocalClearance;
|
|
m_LocalSolderMaskMargin = aModule->m_LocalSolderMaskMargin;
|
|
m_LocalSolderPasteMargin = aModule->m_LocalSolderPasteMargin;
|
|
m_LocalSolderPasteMarginRatio = aModule->m_LocalSolderPasteMarginRatio;
|
|
m_ZoneConnection = aModule->m_ZoneConnection;
|
|
m_ThermalWidth = aModule->m_ThermalWidth;
|
|
m_ThermalGap = aModule->m_ThermalGap;
|
|
|
|
// Copy reference and value.
|
|
m_Reference->Copy( aModule->m_Reference );
|
|
m_Value->Copy( aModule->m_Value );
|
|
|
|
// Copy auxiliary data: Pads
|
|
m_Pads.DeleteAll();
|
|
|
|
for( D_PAD* pad = aModule->m_Pads; pad; pad = pad->Next() )
|
|
{
|
|
D_PAD* newpad = new D_PAD( this );
|
|
newpad->Copy( pad );
|
|
m_Pads.PushBack( newpad );
|
|
}
|
|
|
|
// Copy auxiliary data: Drawings
|
|
m_Drawings.DeleteAll();
|
|
|
|
for( BOARD_ITEM* item = aModule->m_Drawings; item; item = item->Next() )
|
|
{
|
|
switch( item->Type() )
|
|
{
|
|
case PCB_MODULE_TEXT_T:
|
|
TEXTE_MODULE * textm;
|
|
textm = new TEXTE_MODULE( this );
|
|
textm->Copy( (TEXTE_MODULE*) item );
|
|
m_Drawings.PushBack( textm );
|
|
break;
|
|
|
|
case PCB_MODULE_EDGE_T:
|
|
EDGE_MODULE * edge;
|
|
edge = new EDGE_MODULE( this );
|
|
edge->Copy( (EDGE_MODULE*) item );
|
|
m_Drawings.PushBack( edge );
|
|
break;
|
|
|
|
default:
|
|
wxLogMessage( wxT( "MODULE::Copy() Internal Err: unknown type" ) );
|
|
break;
|
|
}
|
|
}
|
|
|
|
// Copy auxiliary data: 3D_Drawings info
|
|
m_3D_Drawings.DeleteAll();
|
|
|
|
// Ensure there is one (or more) item in m_3D_Drawings
|
|
m_3D_Drawings.PushBack( new S3D_MASTER( this ) ); // push a void item
|
|
|
|
for( S3D_MASTER* item = aModule->m_3D_Drawings; item; item = item->Next() )
|
|
{
|
|
if( item->m_Shape3DName.IsEmpty() ) // do not copy empty shapes.
|
|
continue;
|
|
|
|
S3D_MASTER* t3d = m_3D_Drawings;
|
|
|
|
if( t3d && t3d->m_Shape3DName.IsEmpty() ) // The first entry can
|
|
{ // exist, but is empty : use it.
|
|
t3d->Copy( item );
|
|
}
|
|
else
|
|
{
|
|
t3d = new S3D_MASTER( this );
|
|
t3d->Copy( item );
|
|
m_3D_Drawings.PushBack( t3d );
|
|
}
|
|
}
|
|
|
|
m_Doc = aModule->m_Doc;
|
|
m_KeyWord = aModule->m_KeyWord;
|
|
|
|
// Ensure auxiliary data is up to date
|
|
CalculateBoundingBox();
|
|
}
|
|
|
|
|
|
/**
|
|
* Function Draw
|
|
* Draws the footprint to the current Device Context
|
|
* @param aPanel = draw panel, Used to know the clip box
|
|
* @param aDC = Current Device Context
|
|
* @param aDrawMode = GR_OR, GR_XOR..
|
|
* @param aOffset = draw offset (usually wxPoint(0,0)
|
|
*/
|
|
void MODULE::Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC, GR_DRAWMODE aDrawMode, const wxPoint& aOffset )
|
|
{
|
|
if( (m_Flags & DO_NOT_DRAW) || (IsMoving()) )
|
|
return;
|
|
|
|
for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
|
|
{
|
|
if( pad->IsMoving() )
|
|
continue;
|
|
|
|
pad->Draw( aPanel, aDC, aDrawMode, aOffset );
|
|
}
|
|
|
|
BOARD* brd = GetBoard();
|
|
|
|
// Draws footprint anchor
|
|
DrawAncre( aPanel, aDC, aOffset, DIM_ANCRE_MODULE, aDrawMode );
|
|
|
|
// Draw graphic items
|
|
if( brd->IsElementVisible( MOD_REFERENCES_VISIBLE ) )
|
|
{
|
|
if( !(m_Reference->IsMoving()) )
|
|
m_Reference->Draw( aPanel, aDC, aDrawMode, aOffset );
|
|
}
|
|
|
|
if( brd->IsElementVisible( MOD_VALUES_VISIBLE ) )
|
|
{
|
|
if( !(m_Value->IsMoving()) )
|
|
m_Value->Draw( aPanel, aDC, aDrawMode, aOffset );
|
|
}
|
|
|
|
for( BOARD_ITEM* item = m_Drawings; item; item = item->Next() )
|
|
{
|
|
if( item->IsMoving() )
|
|
continue;
|
|
|
|
switch( item->Type() )
|
|
{
|
|
case PCB_MODULE_TEXT_T:
|
|
case PCB_MODULE_EDGE_T:
|
|
item->Draw( aPanel, aDC, aDrawMode, aOffset );
|
|
break;
|
|
|
|
default:
|
|
break;
|
|
}
|
|
}
|
|
|
|
// Enable these line to draw m_BoundaryBox (debug tests purposes only)
|
|
#if 0
|
|
GRRect( aPanel->GetClipBox(), aDC, m_BoundaryBox, 0, BROWN );
|
|
#endif
|
|
|
|
}
|
|
|
|
|
|
/**
|
|
* Function DrawEdgesOnly
|
|
* Draws the footprint edges only to the current Device Context
|
|
* @param panel = The active Draw Panel (used to know the clip box)
|
|
* @param DC = current Device Context
|
|
* @param offset = draw offset (usually wxPoint(0,0)
|
|
* @param draw_mode = GR_OR, GR_XOR, GR_AND
|
|
*/
|
|
void MODULE::DrawEdgesOnly( EDA_DRAW_PANEL* panel, wxDC* DC, const wxPoint& offset,
|
|
GR_DRAWMODE draw_mode )
|
|
{
|
|
for( BOARD_ITEM* item = m_Drawings; item; item = item->Next() )
|
|
{
|
|
switch( item->Type() )
|
|
{
|
|
case PCB_MODULE_EDGE_T:
|
|
item->Draw( panel, DC, draw_mode, offset );
|
|
break;
|
|
|
|
default:
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
void MODULE::CalculateBoundingBox()
|
|
{
|
|
m_BoundaryBox = GetFootPrintRect();
|
|
m_Surface = std::abs( (double) m_BoundaryBox.GetWidth() * m_BoundaryBox.GetHeight() );
|
|
}
|
|
|
|
|
|
EDA_RECT MODULE::GetFootPrintRect() const
|
|
{
|
|
EDA_RECT area;
|
|
|
|
area.SetOrigin( m_Pos );
|
|
area.SetEnd( m_Pos );
|
|
area.Inflate( Millimeter2iu( 0.25 ) ); // Give a min size to the area
|
|
|
|
for( EDGE_MODULE* edge = (EDGE_MODULE*) m_Drawings.GetFirst(); edge; edge = edge->Next() )
|
|
if( edge->Type() == PCB_MODULE_EDGE_T )
|
|
area.Merge( edge->GetBoundingBox() );
|
|
|
|
for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
|
|
area.Merge( pad->GetBoundingBox() );
|
|
|
|
return area;
|
|
}
|
|
|
|
|
|
EDA_RECT MODULE::GetBoundingBox() const
|
|
{
|
|
EDA_RECT area = GetFootPrintRect();
|
|
|
|
// Calculate extended area including text fields
|
|
area.Merge( m_Reference->GetBoundingBox() );
|
|
area.Merge( m_Value->GetBoundingBox() );
|
|
|
|
// Add the Clearance shape size: (shape around the pads when the
|
|
// clearance is shown. Not optimized, but the draw cost is small
|
|
// (perhaps smaller than optimization).
|
|
int biggest_clearance = GetBoard()->GetBiggestClearanceValue();
|
|
area.Inflate( biggest_clearance );
|
|
|
|
return area;
|
|
}
|
|
|
|
|
|
/* Virtual function, from EDA_ITEM.
|
|
* display module info on MsgPanel
|
|
*/
|
|
void MODULE::GetMsgPanelInfo( std::vector< MSG_PANEL_ITEM >& aList )
|
|
{
|
|
int nbpad;
|
|
char bufcar[512], Line[512];
|
|
wxString msg;
|
|
BOARD* board = GetBoard();
|
|
|
|
aList.push_back( MSG_PANEL_ITEM( m_Reference->GetText(), m_Value->GetText(), DARKCYAN ) );
|
|
|
|
// Display last date the component was edited (useful in Module Editor).
|
|
time_t edit_time = m_LastEditTime;
|
|
strcpy( Line, ctime( &edit_time ) );
|
|
strtok( Line, " \n\r" );
|
|
strcpy( bufcar, strtok( NULL, " \n\r" ) ); strcat( bufcar, " " );
|
|
strcat( bufcar, strtok( NULL, " \n\r" ) ); strcat( bufcar, ", " );
|
|
strtok( NULL, " \n\r" );
|
|
strcat( bufcar, strtok( NULL, " \n\r" ) );
|
|
msg = FROM_UTF8( bufcar );
|
|
aList.push_back( MSG_PANEL_ITEM( _( "Last Change" ), msg, BROWN ) );
|
|
|
|
// display time stamp in schematic
|
|
msg.Printf( wxT( "%8.8lX" ), m_TimeStamp );
|
|
aList.push_back( MSG_PANEL_ITEM( _( "Netlist path" ), m_Path, BROWN ) );
|
|
aList.push_back( MSG_PANEL_ITEM( _( "Layer" ), board->GetLayerName( m_Layer ), RED ) );
|
|
|
|
EDA_ITEM* PtStruct = m_Pads;
|
|
nbpad = 0;
|
|
|
|
while( PtStruct )
|
|
{
|
|
nbpad++;
|
|
PtStruct = PtStruct->Next();
|
|
}
|
|
|
|
msg.Printf( wxT( "%d" ), nbpad );
|
|
aList.push_back( MSG_PANEL_ITEM( _( "Pads" ), msg, BLUE ) );
|
|
|
|
msg = wxT( ".." );
|
|
|
|
if( IsLocked() )
|
|
msg[0] = 'L';
|
|
|
|
if( m_ModuleStatus & MODULE_is_PLACED )
|
|
msg[1] = 'P';
|
|
|
|
aList.push_back( MSG_PANEL_ITEM( _( "Stat" ), msg, MAGENTA ) );
|
|
|
|
msg.Printf( wxT( "%.1f" ), (float) m_Orient / 10 );
|
|
aList.push_back( MSG_PANEL_ITEM( _( "Orient" ), msg, BROWN ) );
|
|
|
|
/* Controls on right side of the dialog */
|
|
switch( m_Attributs & 255 )
|
|
{
|
|
case 0:
|
|
msg = _("Normal");
|
|
break;
|
|
|
|
case MOD_CMS:
|
|
msg = _("Insert");
|
|
break;
|
|
|
|
case MOD_VIRTUAL:
|
|
msg = _("Virtual");
|
|
break;
|
|
|
|
default:
|
|
msg = wxT("???");
|
|
break;
|
|
}
|
|
|
|
aList.push_back( MSG_PANEL_ITEM( _( "Attrib" ), msg, BROWN ) );
|
|
aList.push_back( MSG_PANEL_ITEM( _( "Module" ), m_LibRef, BLUE ) );
|
|
|
|
msg = _( "No 3D shape" );
|
|
// Search the first active 3D shape in list
|
|
for( S3D_MASTER* struct3D = m_3D_Drawings; struct3D; struct3D = struct3D->Next() )
|
|
{
|
|
if( !struct3D->m_Shape3DName.IsEmpty() )
|
|
{
|
|
msg = struct3D->m_Shape3DName;
|
|
break;
|
|
}
|
|
}
|
|
|
|
aList.push_back( MSG_PANEL_ITEM( _( "3D-Shape" ), msg, RED ) );
|
|
|
|
wxString doc = _( "Doc: " ) + m_Doc;
|
|
wxString keyword = _( "KeyW: " ) + m_KeyWord;
|
|
aList.push_back( MSG_PANEL_ITEM( doc, keyword, BLACK ) );
|
|
}
|
|
|
|
|
|
bool MODULE::HitTest( const wxPoint& aPosition )
|
|
{
|
|
if( m_BoundaryBox.Contains( aPosition ) )
|
|
return true;
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
bool MODULE::HitTest( const EDA_RECT& aRect ) const
|
|
{
|
|
if( m_BoundaryBox.GetX() < aRect.GetX() )
|
|
return false;
|
|
|
|
if( m_BoundaryBox.GetY() < aRect.GetY() )
|
|
return false;
|
|
|
|
if( m_BoundaryBox.GetRight() > aRect.GetRight() )
|
|
return false;
|
|
|
|
if( m_BoundaryBox.GetBottom() > aRect.GetBottom() )
|
|
return false;
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
D_PAD* MODULE::FindPadByName( const wxString& aPadName ) const
|
|
{
|
|
wxString buf;
|
|
|
|
for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
|
|
{
|
|
pad->ReturnStringPadName( buf );
|
|
#if 1
|
|
if( buf.CmpNoCase( aPadName ) == 0 ) // why case insensitive?
|
|
#else
|
|
if( buf == aPadName )
|
|
#endif
|
|
return pad;
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
|
|
D_PAD* MODULE::GetPad( const wxPoint& aPosition, LAYER_MSK aLayerMask )
|
|
{
|
|
for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
|
|
{
|
|
// ... and on the correct layer.
|
|
if( ( pad->GetLayerMask() & aLayerMask ) == 0 )
|
|
continue;
|
|
|
|
if( pad->HitTest( aPosition ) )
|
|
return pad;
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
|
|
void MODULE::Add3DModel( S3D_MASTER* a3DModel )
|
|
{
|
|
a3DModel->SetParent( this );
|
|
m_3D_Drawings.PushBack( a3DModel );
|
|
}
|
|
|
|
|
|
void MODULE::AddPad( D_PAD* aPad )
|
|
{
|
|
aPad->SetParent( this );
|
|
m_Pads.PushBack( aPad );
|
|
}
|
|
|
|
|
|
// see class_module.h
|
|
SEARCH_RESULT MODULE::Visit( INSPECTOR* inspector, const void* testData,
|
|
const KICAD_T scanTypes[] )
|
|
{
|
|
KICAD_T stype;
|
|
SEARCH_RESULT result = SEARCH_CONTINUE;
|
|
const KICAD_T* p = scanTypes;
|
|
bool done = false;
|
|
|
|
#if 0 && defined(DEBUG)
|
|
std::cout << GetClass().mb_str() << ' ';
|
|
#endif
|
|
|
|
while( !done )
|
|
{
|
|
stype = *p;
|
|
|
|
switch( stype )
|
|
{
|
|
case PCB_MODULE_T:
|
|
result = inspector->Inspect( this, testData ); // inspect me
|
|
++p;
|
|
break;
|
|
|
|
case PCB_PAD_T:
|
|
result = IterateForward( m_Pads, inspector, testData, p );
|
|
++p;
|
|
break;
|
|
|
|
case PCB_MODULE_TEXT_T:
|
|
result = inspector->Inspect( m_Reference, testData );
|
|
|
|
if( result == SEARCH_QUIT )
|
|
break;
|
|
|
|
result = inspector->Inspect( m_Value, testData );
|
|
|
|
if( result == SEARCH_QUIT )
|
|
break;
|
|
|
|
// m_Drawings can hold TYPETEXTMODULE also, so fall thru
|
|
|
|
case PCB_MODULE_EDGE_T:
|
|
result = IterateForward( m_Drawings, inspector, testData, p );
|
|
|
|
// skip over any types handled in the above call.
|
|
for( ; ; )
|
|
{
|
|
switch( stype = *++p )
|
|
{
|
|
case PCB_MODULE_TEXT_T:
|
|
case PCB_MODULE_EDGE_T:
|
|
continue;
|
|
|
|
default:
|
|
;
|
|
}
|
|
|
|
break;
|
|
}
|
|
|
|
break;
|
|
|
|
default:
|
|
done = true;
|
|
break;
|
|
}
|
|
|
|
if( result == SEARCH_QUIT )
|
|
break;
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
|
|
wxString MODULE::GetSelectMenuText() const
|
|
{
|
|
wxString text;
|
|
|
|
text << _( "Footprint" ) << wxT( " " ) << GetReference();
|
|
text << wxT( " (" ) << GetLayerName() << wxT( ")" );
|
|
|
|
return text;
|
|
}
|
|
|
|
|
|
EDA_ITEM* MODULE::Clone() const
|
|
{
|
|
return new MODULE( *this );
|
|
}
|
|
|
|
/* Test for validity of the name in a library of the footprint
|
|
* ( no spaces, dir separators ... )
|
|
* return true if the given name is valid
|
|
* static function
|
|
*/
|
|
bool MODULE::IsLibNameValid( const wxString & aName )
|
|
{
|
|
const wxChar * invalids = ReturnStringLibNameInvalidChars( false );
|
|
|
|
if( aName.find_first_of( invalids ) != std::string::npos )
|
|
return false;
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
/* Test for validity of the name of a footprint to be used in a footprint library
|
|
* ( no spaces, dir separators ... )
|
|
* param bool aUserReadable = false to get the list of invalid chars
|
|
* true to get a readable form (i.e ' ' = 'space' '\t'= 'tab')
|
|
* return a constant string giving the list of invalid chars in lib name
|
|
* static function
|
|
*/
|
|
const wxChar* MODULE::ReturnStringLibNameInvalidChars( bool aUserReadable )
|
|
{
|
|
static const wxChar invalidChars[] = wxT("%$\t \"\\/");
|
|
static const wxChar invalidCharsReadable[] = wxT("% $ 'tab' 'space' \\ \" /");
|
|
|
|
if( aUserReadable )
|
|
return invalidCharsReadable;
|
|
else
|
|
return invalidChars;
|
|
}
|
|
|
|
|
|
void MODULE::Move( const wxPoint& aMoveVector )
|
|
{
|
|
wxPoint newpos = m_Pos + aMoveVector;
|
|
SetPosition( newpos );
|
|
}
|
|
|
|
|
|
void MODULE::Rotate( const wxPoint& aRotCentre, double aAngle )
|
|
{
|
|
wxPoint newpos = m_Pos;
|
|
RotatePoint( &newpos, aRotCentre, aAngle );
|
|
SetPosition( newpos );
|
|
SetOrientation( GetOrientation() + aAngle );
|
|
}
|
|
|
|
|
|
void MODULE::Flip( const wxPoint& aCentre )
|
|
{
|
|
TEXTE_MODULE* text;
|
|
|
|
// Move module to its final position:
|
|
wxPoint finalPos = m_Pos;
|
|
|
|
finalPos.y = aCentre.y - ( finalPos.y - aCentre.y ); /// Mirror the Y position
|
|
|
|
SetPosition( finalPos );
|
|
|
|
// Flip layer
|
|
SetLayer( BOARD::ReturnFlippedLayerNumber( GetLayer() ) );
|
|
|
|
// Reverse mirror orientation.
|
|
NEGATE( m_Orient );
|
|
NORMALIZE_ANGLE_POS( m_Orient );
|
|
|
|
// Mirror pads to other side of board about the x axis, i.e. vertically.
|
|
for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
|
|
pad->Flip( m_Pos.y );
|
|
|
|
// Mirror reference.
|
|
text = m_Reference;
|
|
text->m_Pos.y -= m_Pos.y;
|
|
text->m_Pos.y = -text->m_Pos.y;
|
|
text->m_Pos.y += m_Pos.y;
|
|
NEGATE(text->m_Pos0.y);
|
|
text->m_Mirror = false;
|
|
NEGATE_AND_NORMALIZE_ANGLE_POS( text->m_Orient );
|
|
text->SetLayer( GetLayer() );
|
|
text->SetLayer( BOARD::ReturnFlippedLayerNumber( text->GetLayer() ) );
|
|
|
|
if( GetLayer() == LAYER_N_BACK )
|
|
text->SetLayer( SILKSCREEN_N_BACK );
|
|
|
|
if( GetLayer() == LAYER_N_FRONT )
|
|
text->SetLayer( SILKSCREEN_N_FRONT );
|
|
|
|
if( (GetLayer() == SILKSCREEN_N_BACK)
|
|
|| (GetLayer() == ADHESIVE_N_BACK) || (GetLayer() == LAYER_N_BACK) )
|
|
text->m_Mirror = true;
|
|
|
|
// Mirror value.
|
|
text = m_Value;
|
|
text->m_Pos.y -= m_Pos.y;
|
|
NEGATE( text->m_Pos.y );
|
|
text->m_Pos.y += m_Pos.y;
|
|
NEGATE( text->m_Pos0.y );
|
|
text->m_Mirror = false;
|
|
NEGATE_AND_NORMALIZE_ANGLE_POS( text->m_Orient );
|
|
text->SetLayer( GetLayer() );
|
|
text->SetLayer( BOARD::ReturnFlippedLayerNumber( text->GetLayer() ) );
|
|
|
|
if( GetLayer() == LAYER_N_BACK )
|
|
text->SetLayer( SILKSCREEN_N_BACK );
|
|
|
|
if( GetLayer() == LAYER_N_FRONT )
|
|
text->SetLayer( SILKSCREEN_N_FRONT );
|
|
|
|
if( (GetLayer() == SILKSCREEN_N_BACK)
|
|
|| (GetLayer() == ADHESIVE_N_BACK) || (GetLayer() == LAYER_N_BACK) )
|
|
text->m_Mirror = true;
|
|
|
|
// Reverse mirror module graphics and texts.
|
|
for( EDA_ITEM* item = m_Drawings; item; item = item->Next() )
|
|
{
|
|
switch( item->Type() )
|
|
{
|
|
case PCB_MODULE_EDGE_T:
|
|
{
|
|
EDGE_MODULE* em = (EDGE_MODULE*) item;
|
|
|
|
wxPoint s = em->GetStart();
|
|
s.y -= m_Pos.y;
|
|
s.y = -s.y;
|
|
s.y += m_Pos.y;
|
|
em->SetStart( s );
|
|
|
|
wxPoint e = em->GetEnd();
|
|
e.y -= m_Pos.y;
|
|
e.y = -e.y;
|
|
e.y += m_Pos.y;
|
|
em->SetEnd( e );
|
|
|
|
NEGATE( em->m_Start0.y );
|
|
NEGATE( em->m_End0.y );
|
|
|
|
if( em->GetShape() == S_ARC )
|
|
{
|
|
em->SetAngle( -em->GetAngle() );
|
|
}
|
|
|
|
em->SetLayer( BOARD::ReturnFlippedLayerNumber( em->GetLayer() ) );
|
|
}
|
|
break;
|
|
|
|
case PCB_MODULE_TEXT_T:
|
|
// Reverse mirror position and mirror.
|
|
text = (TEXTE_MODULE*) item;
|
|
text->m_Pos.y -= m_Pos.y;
|
|
text->m_Pos.y = -text->m_Pos.y;
|
|
text->m_Pos.y += m_Pos.y;
|
|
NEGATE( text->m_Pos0.y );
|
|
text->m_Mirror = false;
|
|
NEGATE_AND_NORMALIZE_ANGLE_POS( text->m_Orient );
|
|
|
|
text->SetLayer( GetLayer() );
|
|
text->SetLayer( BOARD::ReturnFlippedLayerNumber( text->GetLayer() ) );
|
|
|
|
if( GetLayer() == LAYER_N_BACK )
|
|
text->SetLayer( SILKSCREEN_N_BACK );
|
|
|
|
if( GetLayer() == LAYER_N_FRONT )
|
|
text->SetLayer( SILKSCREEN_N_FRONT );
|
|
|
|
if( GetLayer() == SILKSCREEN_N_BACK
|
|
|| GetLayer() == ADHESIVE_N_BACK
|
|
|| GetLayer() == LAYER_N_BACK )
|
|
{
|
|
text->m_Mirror = true;
|
|
}
|
|
|
|
break;
|
|
|
|
default:
|
|
wxMessageBox( wxT( "MODULE::Flip() error: Unknown Draw Type" ) );
|
|
break;
|
|
}
|
|
}
|
|
|
|
CalculateBoundingBox();
|
|
}
|
|
|
|
|
|
void MODULE::SetPosition( const wxPoint& newpos )
|
|
{
|
|
wxPoint delta = newpos - m_Pos;
|
|
|
|
m_Pos += delta;
|
|
m_Reference->SetTextPosition( m_Reference->GetTextPosition() + delta );
|
|
m_Value->SetTextPosition( m_Value->GetTextPosition() + delta );
|
|
|
|
for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
|
|
{
|
|
pad->SetPosition( pad->GetPosition() + delta );
|
|
}
|
|
|
|
for( EDA_ITEM* item = m_Drawings; item; item = item->Next() )
|
|
{
|
|
switch( item->Type() )
|
|
{
|
|
case PCB_MODULE_EDGE_T:
|
|
{
|
|
EDGE_MODULE* pt_edgmod = (EDGE_MODULE*) item;
|
|
pt_edgmod->SetDrawCoord();
|
|
break;
|
|
}
|
|
|
|
case PCB_MODULE_TEXT_T:
|
|
{
|
|
TEXTE_MODULE* text = (TEXTE_MODULE*) item;
|
|
text->m_Pos += delta;
|
|
break;
|
|
}
|
|
|
|
default:
|
|
wxMessageBox( wxT( "Draw type undefined." ) );
|
|
break;
|
|
}
|
|
}
|
|
|
|
CalculateBoundingBox();
|
|
}
|
|
|
|
void MODULE::MoveAnchorPosition( const wxPoint& aMoveVector )
|
|
{
|
|
/* Move the reference point of the footprint
|
|
* the footprints elements (pads, outlines, edges .. ) are moved
|
|
* but:
|
|
* - the footprint position is not modified.
|
|
* - the relative (local) coordinates of these items are modified
|
|
*/
|
|
|
|
wxPoint footprintPos = GetPosition();
|
|
|
|
/* Update the relative coordinates:
|
|
* The coordinates are relative to the anchor point.
|
|
* Calculate deltaX and deltaY from the anchor. */
|
|
wxPoint moveVector = aMoveVector;
|
|
RotatePoint( &moveVector, -GetOrientation() );
|
|
|
|
// Update of the reference and value.
|
|
m_Reference->SetPos0( m_Reference->GetPos0() + moveVector );
|
|
m_Reference->SetDrawCoord();
|
|
m_Value->SetPos0( m_Value->GetPos0() + moveVector );
|
|
m_Value->SetDrawCoord();
|
|
|
|
// Update the pad local coordinates.
|
|
for( D_PAD* pad = Pads(); pad; pad = pad->Next() )
|
|
{
|
|
pad->SetPos0( pad->GetPos0() + moveVector );
|
|
pad->SetPosition( pad->GetPos0() + footprintPos );
|
|
}
|
|
|
|
// Update the draw element coordinates.
|
|
for( EDA_ITEM* item = GraphicalItems(); item; item = item->Next() )
|
|
{
|
|
switch( item->Type() )
|
|
{
|
|
case PCB_MODULE_EDGE_T:
|
|
#undef STRUCT
|
|
#define STRUCT ( (EDGE_MODULE*) item )
|
|
STRUCT->m_Start0 += moveVector;
|
|
STRUCT->m_End0 += moveVector;
|
|
STRUCT->SetDrawCoord();
|
|
break;
|
|
|
|
case PCB_MODULE_TEXT_T:
|
|
#undef STRUCT
|
|
#define STRUCT ( (TEXTE_MODULE*) item )
|
|
STRUCT->SetPos0( STRUCT->GetPos0() + moveVector );
|
|
STRUCT->SetDrawCoord();
|
|
break;
|
|
|
|
default:
|
|
break;
|
|
}
|
|
}
|
|
|
|
CalculateBoundingBox();
|
|
}
|
|
|
|
void MODULE::SetOrientation( double newangle )
|
|
{
|
|
double angleChange = newangle - m_Orient; // change in rotation
|
|
wxPoint pt;
|
|
|
|
NORMALIZE_ANGLE_POS( newangle );
|
|
|
|
m_Orient = newangle;
|
|
|
|
for( D_PAD* pad = m_Pads; pad; pad = pad->Next() )
|
|
{
|
|
pt = pad->GetPos0();
|
|
|
|
pad->SetOrientation( pad->GetOrientation() + angleChange );
|
|
|
|
RotatePoint( &pt, m_Orient );
|
|
|
|
pad->SetPosition( GetPosition() + pt );
|
|
}
|
|
|
|
// Update of the reference and value.
|
|
m_Reference->SetDrawCoord();
|
|
m_Value->SetDrawCoord();
|
|
|
|
// Displace contours and text of the footprint.
|
|
for( BOARD_ITEM* item = m_Drawings; item; item = item->Next() )
|
|
{
|
|
if( item->Type() == PCB_MODULE_EDGE_T )
|
|
{
|
|
EDGE_MODULE* edge = (EDGE_MODULE*) item;
|
|
edge->SetDrawCoord();
|
|
}
|
|
|
|
else if( item->Type() == PCB_MODULE_TEXT_T )
|
|
{
|
|
TEXTE_MODULE* text = (TEXTE_MODULE*) item;
|
|
text->SetDrawCoord();
|
|
}
|
|
}
|
|
|
|
CalculateBoundingBox();
|
|
}
|
|
|
|
|
|
#if defined(DEBUG)
|
|
|
|
void MODULE::Show( int nestLevel, std::ostream& os ) const
|
|
{
|
|
BOARD* board = GetBoard();
|
|
|
|
// for now, make it look like XML, expand on this later.
|
|
NestedSpace( nestLevel, os ) << '<' << GetClass().Lower().mb_str() <<
|
|
" ref=\"" << m_Reference->GetText().mb_str() << '"' <<
|
|
" value=\"" << m_Value->GetText().mb_str() << '"' <<
|
|
" layer=\"" << board->GetLayerName( m_Layer ).mb_str() << '"' <<
|
|
">\n";
|
|
|
|
NestedSpace( nestLevel + 1, os ) << "<boundingBox" << m_BoundaryBox.GetPosition()
|
|
<< m_BoundaryBox.GetSize() << "/>\n";
|
|
|
|
NestedSpace( nestLevel + 1, os ) << "<orientation tenths=\"" << m_Orient
|
|
<< "\"/>\n";
|
|
|
|
EDA_ITEM* p;
|
|
|
|
NestedSpace( nestLevel + 1, os ) << "<mpads>\n";
|
|
p = m_Pads;
|
|
|
|
for( ; p; p = p->Next() )
|
|
p->Show( nestLevel + 2, os );
|
|
|
|
NestedSpace( nestLevel + 1, os ) << "</mpads>\n";
|
|
|
|
NestedSpace( nestLevel + 1, os ) << "<mdrawings>\n";
|
|
p = m_Drawings;
|
|
|
|
for( ; p; p = p->Next() )
|
|
p->Show( nestLevel + 2, os );
|
|
|
|
NestedSpace( nestLevel + 1, os ) << "</mdrawings>\n";
|
|
|
|
p = m_Son;
|
|
|
|
for( ; p; p = p->Next() )
|
|
{
|
|
p->Show( nestLevel + 1, os );
|
|
}
|
|
|
|
NestedSpace( nestLevel, os ) << "</" << GetClass().Lower().mb_str()
|
|
<< ">\n";
|
|
}
|
|
|
|
#endif
|