kicad/pcbnew/edtxtmod.cpp

463 lines
13 KiB
C++
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
* Copyright (C) 1992-2011 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 edtxtmod.cpp
* @brief Edit module text.
*/
#include <fctsys.h>
#include <gr_basic.h>
#include <common.h>
#include <class_drawpanel.h>
#include <drawtxt.h>
#include <trigo.h>
#include <wxBasePcbFrame.h>
#include <macros.h>
#include <pcbnew.h>
#include <protos.h>
#include <class_board.h>
#include <class_module.h>
#include <class_text_mod.h>
#include <class_pcb_text.h>
static void Show_MoveTexte_Module( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aPosition,
bool aErase );
static void AbortMoveTextModule( EDA_DRAW_PANEL* Panel, wxDC* DC );
wxPoint MoveVector; // Move vector for move edge, exported
// to dialog_edit mod_text.cpp
static wxPoint TextInitialPosition; // Mouse cursor initial position for
// undo/abort move command
static int TextInitialOrientation; // module text initial orientation for
// undo/abort move+rot command+rot
/* Add a new graphical text to the active module (footprint)
* Note there always are 2 texts: reference and value.
2011-12-12 08:37:05 +00:00
* New texts have the member TEXTE_MODULE.GetType() set to TEXT_is_DIVERS
*/
TEXTE_MODULE* PCB_BASE_FRAME::CreateTextModule( MODULE* Module, wxDC* DC )
{
TEXTE_MODULE* Text;
Text = new TEXTE_MODULE( Module );
/* Add the new text object to the beginning of the draw item list. */
2009-08-11 10:27:21 +00:00
if( Module )
Module->m_Drawings.PushFront( Text );
Text->SetFlags( IS_NEW );
Text->m_Text = wxT( "text" );
GetDesignSettings().m_ModuleTextWidth = Clamp_Text_PenSize( GetDesignSettings().m_ModuleTextWidth,
MIN( GetDesignSettings().m_ModuleTextSize.x, GetDesignSettings().m_ModuleTextSize.y ), true );
Text->m_Size = GetDesignSettings().m_ModuleTextSize;
Text->m_Thickness = GetDesignSettings().m_ModuleTextWidth;
Text->m_Pos = GetScreen()->GetCrossHairPosition();
Text->SetLocalCoord();
2009-08-11 10:27:21 +00:00
InstallTextModOptionsFrame( Text, NULL );
m_canvas->MoveCursorToCrossHair();
Text->ClearFlags();
2009-08-11 10:27:21 +00:00
if( DC )
Text->Draw( m_canvas, DC, GR_OR );
Text->DisplayInfo( this );
return Text;
}
/* Rotate text 90 degrees.
*/
void PCB_BASE_FRAME::RotateTextModule( TEXTE_MODULE* Text, wxDC* DC )
{
if( Text == NULL )
return;
MODULE* module = (MODULE*) Text->GetParent();
if( module && module->GetFlags() == 0 && Text->GetFlags() == 0 ) // prepare undo command
{
2009-08-11 10:27:21 +00:00
if( this->m_Ident == PCB_FRAME )
SaveCopyInUndoList( module, UR_CHANGED );
2009-08-11 10:27:21 +00:00
}
2008-04-29 03:18:02 +00:00
// we expect MoveVector to be (0,0) if there is no move in progress
Text->Draw( m_canvas, DC, GR_XOR, MoveVector );
Text->m_Orient += 900;
while( Text->m_Orient >= 1800 )
Text->m_Orient -= 1800;
Text->Draw( m_canvas, DC, GR_XOR, MoveVector );
Text->DisplayInfo( this );
2009-08-11 10:27:21 +00:00
if( module )
module->m_LastEdit_Time = time( NULL );
OnModify();
}
/*
* Deletes text in module (if not the reference or value)
*/
void PCB_BASE_FRAME::DeleteTextModule( TEXTE_MODULE* Text )
{
MODULE* Module;
if( Text == NULL )
return;
Module = (MODULE*) Text->GetParent();
2011-12-12 08:37:05 +00:00
if( Text->GetType() == TEXT_is_DIVERS )
{
m_canvas->RefreshDrawingRect( Text->GetBoundingBox() );
2008-04-29 03:18:02 +00:00
Text->DeleteStructure();
OnModify();
Module->m_LastEdit_Time = time( NULL );
}
}
/*
* Abort text move in progress.
*
* If a text is selected, its initial coordinates are regenerated.
*/
static void AbortMoveTextModule( EDA_DRAW_PANEL* Panel, wxDC* DC )
{
BASE_SCREEN* screen = Panel->GetScreen();
TEXTE_MODULE* Text = (TEXTE_MODULE*) screen->GetCurItem();
MODULE* Module;
Panel->SetMouseCapture( NULL, NULL );
if( Text == NULL )
return;
Module = (MODULE*) Text->GetParent();
2008-04-29 03:18:02 +00:00
Text->DrawUmbilical( Panel, DC, GR_XOR, -MoveVector );
2008-04-01 05:21:50 +00:00
Text->Draw( Panel, DC, GR_XOR, MoveVector );
2009-08-11 14:10:34 +00:00
// If the text was moved (the move does not change internal data)
// it could be rotated while moving. So set old value for orientation
if( Text->IsMoving() )
2009-08-11 14:10:34 +00:00
Text->m_Orient = TextInitialOrientation;
/* Redraw the text */
Panel->RefreshDrawingRect( Text->GetBoundingBox() );
2008-04-29 03:18:02 +00:00
// leave it at (0,0) so we can use it Rotate when not moving.
MoveVector.x = MoveVector.y = 0;
Text->ClearFlags();
Module->ClearFlags();
screen->SetCurItem( NULL );
}
/* Start a text move.
*/
void PCB_BASE_FRAME::StartMoveTexteModule( TEXTE_MODULE* Text, wxDC* DC )
{
MODULE* Module;
if( Text == NULL )
return;
Module = (MODULE*) Text->GetParent();
Text->SetFlags( IS_MOVED );
Module->SetFlags( IN_EDIT );
MoveVector.x = MoveVector.y = 0;
2008-04-29 03:18:02 +00:00
TextInitialPosition = Text->m_Pos;
2009-08-11 10:27:21 +00:00
TextInitialOrientation = Text->m_Orient;
// Center cursor on initial position of text
GetScreen()->SetCrossHairPosition( TextInitialPosition );
m_canvas->MoveCursorToCrossHair();
Text->DisplayInfo( this );
SetCurItem( Text );
m_canvas->SetMouseCapture( Show_MoveTexte_Module, AbortMoveTextModule );
m_canvas->CallMouseCapture( DC, wxDefaultPosition, true );
}
/* Place the text a the cursor position when the left mouse button is clicked.
*/
void PCB_BASE_FRAME::PlaceTexteModule( TEXTE_MODULE* Text, wxDC* DC )
{
if( Text != NULL )
{
m_canvas->RefreshDrawingRect( Text->GetBoundingBox() );
Text->DrawUmbilical( m_canvas, DC, GR_XOR, -MoveVector );
2008-04-29 03:18:02 +00:00
/* Update the coordinates for anchor. */
MODULE* Module = (MODULE*) Text->GetParent();
if( Module )
{
2009-08-11 14:10:34 +00:00
// Prepare undo command (a rotation can be made while moving)
EXCHG( Text->m_Orient, TextInitialOrientation );
2009-08-11 10:27:21 +00:00
if( m_Ident == PCB_FRAME )
SaveCopyInUndoList( Module, UR_CHANGED );
2009-08-11 14:10:34 +00:00
else
SaveCopyInUndoList( Module, UR_MODEDIT );
EXCHG( Text->m_Orient, TextInitialOrientation );
2009-08-11 14:10:34 +00:00
// Set the new position for text.
Text->m_Pos = GetScreen()->GetCrossHairPosition();
2009-08-11 10:27:21 +00:00
wxPoint textRelPos = Text->m_Pos - Module->m_Pos;
RotatePoint( &textRelPos, -Module->m_Orient );
2011-12-12 08:37:05 +00:00
Text->SetPos0( textRelPos );
Text->ClearFlags();
Module->ClearFlags();
Module->m_LastEdit_Time = time( NULL );
OnModify();
/* Redraw text. */
m_canvas->RefreshDrawingRect( Text->GetBoundingBox() );
}
2009-08-11 14:10:34 +00:00
else
{
Text->m_Pos = GetScreen()->GetCrossHairPosition();
}
}
2008-04-29 03:18:02 +00:00
// leave it at (0,0) so we can use it Rotate when not moving.
MoveVector.x = MoveVector.y = 0;
m_canvas->SetMouseCapture( NULL, NULL );
}
static void Show_MoveTexte_Module( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aPosition,
bool aErase )
{
BASE_SCREEN* screen = aPanel->GetScreen();
TEXTE_MODULE* Text = (TEXTE_MODULE*) screen->GetCurItem();
if( Text == NULL )
return;
// Erase umbilical and text if necessary
if( aErase )
{
Text->DrawUmbilical( aPanel, aDC, GR_XOR, -MoveVector );
Text->Draw( aPanel, aDC, GR_XOR, MoveVector );
}
MoveVector = TextInitialPosition - screen->GetCrossHairPosition();
// Draw umbilical if text moved
if( MoveVector.x || MoveVector.y )
Text->DrawUmbilical( aPanel, aDC, GR_XOR, -MoveVector );
// Redraw text
Text->Draw( aPanel, aDC, GR_XOR, MoveVector );
}
void PCB_BASE_FRAME::ResetTextSize( BOARD_ITEM* aItem, wxDC* aDC )
{
wxSize newSize;
int newThickness;
TEXTE_PCB* pcbText = NULL;
TEXTE_MODULE* moduleText = NULL;
EDA_TEXT* text;
switch( aItem->Type() )
{
case PCB_TEXT_T:
newSize = GetDesignSettings().m_PcbTextSize;
newThickness = GetDesignSettings().m_PcbTextWidth;
pcbText = (TEXTE_PCB*) aItem;
text = (EDA_TEXT*) pcbText;
break;
case PCB_MODULE_TEXT_T:
newSize = GetDesignSettings().m_ModuleTextSize;
newThickness = GetDesignSettings().m_ModuleTextWidth;
moduleText = (TEXTE_MODULE*) aItem;
text = (EDA_TEXT*) moduleText;
break;
default:
// Exit if aItem is not a text field
return;
break;
}
// Exit if there's nothing to do
if( text->GetSize() == newSize && text->GetThickness() == newThickness )
return;
// Push item to undo list
switch( aItem->Type() )
{
case PCB_TEXT_T:
SaveCopyInUndoList( pcbText, UR_CHANGED );
break;
case PCB_MODULE_TEXT_T:
SaveCopyInUndoList( moduleText->GetParent(), UR_CHANGED );
break;
default:
break;
}
// Apply changes
text->SetSize( newSize );
text->SetThickness( newThickness );
if( aDC )
m_canvas->Refresh();
OnModify();
}
void PCB_BASE_FRAME::ResetModuleTextSizes( int aType, wxDC* aDC )
{
MODULE* module;
BOARD_ITEM* boardItem;
TEXTE_MODULE* item;
ITEM_PICKER itemWrapper( NULL, UR_CHANGED );
PICKED_ITEMS_LIST undoItemList;
unsigned int ii;
module = GetBoard()->m_Modules;
// Prepare undo list
while( module )
{
2012-02-05 13:02:46 +00:00
itemWrapper.SetItem( module );
switch( aType )
{
case TEXT_is_REFERENCE:
item = module->m_Reference;
if( item->GetSize() != GetDesignSettings().m_ModuleTextSize || item->GetThickness() != GetDesignSettings().m_ModuleTextWidth )
undoItemList.PushItem( itemWrapper );
break;
case TEXT_is_VALUE:
item = module->m_Value;
2012-02-05 13:02:46 +00:00
if( item->GetSize() != GetDesignSettings().m_ModuleTextSize ||
item->GetThickness() != GetDesignSettings().m_ModuleTextWidth )
undoItemList.PushItem( itemWrapper );
break;
case TEXT_is_DIVERS:
// Go through all other module text fields
for( boardItem = module->m_Drawings; boardItem; boardItem = boardItem->Next() )
{
if( boardItem->Type() == PCB_MODULE_TEXT_T )
{
item = (TEXTE_MODULE*) boardItem;
if( item->GetSize() != GetDesignSettings().m_ModuleTextSize
|| item->GetThickness() != GetDesignSettings().m_ModuleTextWidth )
{
undoItemList.PushItem( itemWrapper );
break;
}
}
}
break;
default:
break;
}
module = module->Next();
}
// Exit if there's nothing to do
if( !undoItemList.GetCount() )
return;
SaveCopyInUndoList( undoItemList, UR_CHANGED );
// Apply changes to modules in the undo list
for( ii = 0; ii < undoItemList.GetCount(); ii++ )
{
module = (MODULE*) undoItemList.GetPickedItem( ii );
switch( aType )
{
case TEXT_is_REFERENCE:
module->m_Reference->SetThickness( GetDesignSettings().m_ModuleTextWidth );
module->m_Reference->SetSize( GetDesignSettings().m_ModuleTextSize );
break;
case TEXT_is_VALUE:
module->m_Value->SetThickness( GetDesignSettings().m_ModuleTextWidth );
module->m_Value->SetSize( GetDesignSettings().m_ModuleTextSize );
break;
case TEXT_is_DIVERS:
for( boardItem = module->m_Drawings; boardItem; boardItem = boardItem->Next() )
{
if( boardItem->Type() == PCB_MODULE_TEXT_T )
{
item = (TEXTE_MODULE*) boardItem;
item->SetThickness( GetDesignSettings().m_ModuleTextWidth );
item->SetSize( GetDesignSettings().m_ModuleTextSize );
}
}
break;
}
}
if( aDC )
m_canvas->Refresh();
OnModify();
}