kicad/pcbnew/edit_pcb_text.cpp

241 lines
6.5 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 edit_pcb_text.cpp
* @brief Editimg of text on copper and technical layers (TEXTE_PCB class)
*/
2008-12-20 17:28:25 +00:00
#include <fctsys.h>
#include <gr_basic.h>
#include <class_drawpanel.h>
#include <pcbnew.h>
#include <wxPcbStruct.h>
#include <macros.h>
#include <class_board.h>
#include <class_pcb_text.h>
2008-12-20 17:28:25 +00:00
#include <protos.h>
2009-08-03 07:55:08 +00:00
static void Move_Texte_Pcb( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aPosition,
bool aErase );
static void Abort_Edit_Pcb_Text( EDA_DRAW_PANEL* Panel, wxDC* DC );
2008-12-20 17:28:25 +00:00
static TEXTE_PCB s_TextCopy( (BOARD_ITEM*) NULL ); /* copy of the edited text
* (used to undo/redo/abort
* a complex edition command
*/
2008-12-20 17:28:25 +00:00
/*
* Abort current text edit progress.
*
* If a text is selected, its initial coord are regenerated
2008-12-20 17:28:25 +00:00
*/
void Abort_Edit_Pcb_Text( EDA_DRAW_PANEL* Panel, wxDC* DC )
2008-12-20 17:28:25 +00:00
{
2009-08-03 07:55:08 +00:00
TEXTE_PCB* TextePcb = (TEXTE_PCB*) Panel->GetScreen()->GetCurItem();
( (PCB_EDIT_FRAME*) Panel->GetParent() )->SetCurItem( NULL );
2008-12-20 17:28:25 +00:00
Panel->SetMouseCapture( NULL, NULL );
2009-08-03 07:55:08 +00:00
if( TextePcb == NULL ) // Should not occur
return;
TextePcb->Draw( Panel, DC, GR_XOR );
if( TextePcb->IsNew() ) // If new: remove it
2008-12-20 17:28:25 +00:00
{
2009-08-03 07:55:08 +00:00
TextePcb->DeleteStructure();
return;
2008-12-20 17:28:25 +00:00
}
2009-08-03 07:55:08 +00:00
SwapData(TextePcb, &s_TextCopy);
TextePcb->ClearFlags();
TextePcb->Draw( Panel, DC, GR_OR );
2008-12-20 17:28:25 +00:00
}
/*
* Place the current text being moving
*/
void PCB_EDIT_FRAME::Place_Texte_Pcb( TEXTE_PCB* TextePcb, wxDC* DC )
2008-12-20 17:28:25 +00:00
{
m_canvas->SetMouseCapture( NULL, NULL );
2009-08-03 07:55:08 +00:00
SetCurItem( NULL );
2008-12-20 17:28:25 +00:00
if( TextePcb == NULL )
return;
TextePcb->Draw( m_canvas, DC, GR_OR );
OnModify();
2009-08-03 07:55:08 +00:00
if( TextePcb->IsNew() ) // If new: prepare undo command
2009-08-03 07:55:08 +00:00
{
SaveCopyInUndoList( TextePcb, UR_NEW );
TextePcb->ClearFlags();
2009-08-03 07:55:08 +00:00
return;
}
if( TextePcb->IsMoving() ) // If moved only
{
SaveCopyInUndoList( TextePcb, UR_MOVED, TextePcb->m_Pos - s_TextCopy.m_Pos );
}
2009-08-03 07:55:08 +00:00
else
{
// Restore initial params
SwapData( TextePcb, &s_TextCopy);
// Prepare undo command
SaveCopyInUndoList( TextePcb, UR_CHANGED );
SwapData( TextePcb, &s_TextCopy);
// Restore current params
}
TextePcb->ClearFlags();
2008-12-20 17:28:25 +00:00
}
/* Initialize parameters to move a pcb text
2008-12-20 17:28:25 +00:00
*/
void PCB_EDIT_FRAME::StartMoveTextePcb( TEXTE_PCB* TextePcb, wxDC* DC )
2008-12-20 17:28:25 +00:00
{
if( TextePcb == NULL )
return;
2009-08-03 07:55:08 +00:00
// if it is an existing item: prepare a copy to undo/abort command
if( !TextePcb->IsNew() )
2009-08-03 07:55:08 +00:00
s_TextCopy.Copy( TextePcb );
TextePcb->Draw( m_canvas, DC, GR_XOR );
TextePcb->SetFlags( IS_MOVED );
TextePcb->DisplayInfo( this );
GetScreen()->SetCrossHairPosition( TextePcb->GetPosition() );
m_canvas->MoveCursorToCrossHair();
m_canvas->SetMouseCapture( Move_Texte_Pcb, Abort_Edit_Pcb_Text );
2008-12-20 17:28:25 +00:00
SetCurItem( TextePcb );
m_canvas->CallMouseCapture( DC, wxDefaultPosition, false );
2008-12-20 17:28:25 +00:00
}
/* Move PCB text following the cursor. */
static void Move_Texte_Pcb( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aPosition,
bool aErase )
2008-12-20 17:28:25 +00:00
{
TEXTE_PCB* TextePcb = (TEXTE_PCB*) aPanel->GetScreen()->GetCurItem();
2008-12-20 17:28:25 +00:00
if( TextePcb == NULL )
return;
if( aErase )
TextePcb->Draw( aPanel, aDC, GR_XOR );
2008-12-20 17:28:25 +00:00
TextePcb->m_Pos = aPanel->GetScreen()->GetCrossHairPosition();
2008-12-20 17:28:25 +00:00
TextePcb->Draw( aPanel, aDC, GR_XOR );
2008-12-20 17:28:25 +00:00
}
void PCB_EDIT_FRAME::Delete_Texte_Pcb( TEXTE_PCB* TextePcb, wxDC* DC )
2008-12-20 17:28:25 +00:00
{
if( TextePcb == NULL )
return;
TextePcb->Draw( m_canvas, DC, GR_XOR );
2008-12-20 17:28:25 +00:00
2009-08-03 07:55:08 +00:00
SaveCopyInUndoList( TextePcb, UR_DELETED );
TextePcb->UnLink();
m_canvas->SetMouseCapture( NULL, NULL );
2008-12-20 17:28:25 +00:00
SetCurItem( NULL );
}
TEXTE_PCB* PCB_EDIT_FRAME::Create_Texte_Pcb( wxDC* DC )
2008-12-20 17:28:25 +00:00
{
TEXTE_PCB* TextePcb;
TextePcb = new TEXTE_PCB( GetBoard() );
2008-12-20 17:28:25 +00:00
/* Add text to the board item list. */
GetBoard()->Add( TextePcb );
2008-12-20 17:28:25 +00:00
/* Update text properties. */
TextePcb->SetFlags( IS_NEW );
2009-08-03 07:55:08 +00:00
TextePcb->SetLayer( ( (PCB_SCREEN*) GetScreen() )->m_Active_Layer );
TextePcb->m_Mirror = false;
if( TextePcb->GetLayer() == LAYER_N_BACK )
TextePcb->m_Mirror = true;
2008-12-20 17:28:25 +00:00
++PCBNew * Removed Pcb_Frame argument from BOARD() constructor, since it precludes having a BOARD being edited by more than one editor, it was a bad design. And this meant removing m_PcbFrame from BOARD. * removed BOARD::SetWindowFrame(), and BOARD::m_PcbFrame * Removed the global BOARD_DESIGN_SETTINGS which was in class_board.cpp * added BOARD_DESIGN_SETTINGS to the BOARD class, a full instance * a couple dialogs now only change BOARD_DESIGN_SETTINGS when OK is pressed, such as dialog_mask_clearance, dialog_drc, etc. * Removed common/pcbcommon.cpp's int g_CurrentVersionPCB = 1 and replaced it with build_version.h's #define BOARD_FILE_VERSION, although there may be a better place for this constant. * Made the public functions in PARAM_CFG_ARRAY be type const. void SaveParam(..) const and void ReadParam(..) const * PARAM_CFG_BASE now has virtual destructor since we have various way of destroying the derived class and boost::ptr_vector must be told about this. * Pass const PARAM_CFG_ARRAY& instead of PARAM_CFG_ARRAY so that we can use an automatic PARAM_CFG_ARRAY which is on the stack.\ * PCB_EDIT_FRAME::GetProjectFileParameters() may no longer cache the array, since it has to access the current BOARD and the BOARD can change. Remember BOARD_DESIGN_SETTINGS are now in the BOARD. * Made the m_BoundingBox member private, this was a brutally hard task, and indicative of the lack of commitment to accessors and object oriented design on the part of KiCad developers. We must do better. Added BOARD::GetBoundingBox, SetBoundingBox(), ComputeBoundingBox(). * Added PCB_BASE_FRAME::GetBoardBoundingBox() which calls BOARD::ComputeBoundingBox()
2011-12-05 06:15:33 +00:00
TextePcb->m_Size = GetBoard()->GetDesignSettings().m_PcbTextSize;
TextePcb->m_Pos = GetScreen()->GetCrossHairPosition();
++PCBNew * Removed Pcb_Frame argument from BOARD() constructor, since it precludes having a BOARD being edited by more than one editor, it was a bad design. And this meant removing m_PcbFrame from BOARD. * removed BOARD::SetWindowFrame(), and BOARD::m_PcbFrame * Removed the global BOARD_DESIGN_SETTINGS which was in class_board.cpp * added BOARD_DESIGN_SETTINGS to the BOARD class, a full instance * a couple dialogs now only change BOARD_DESIGN_SETTINGS when OK is pressed, such as dialog_mask_clearance, dialog_drc, etc. * Removed common/pcbcommon.cpp's int g_CurrentVersionPCB = 1 and replaced it with build_version.h's #define BOARD_FILE_VERSION, although there may be a better place for this constant. * Made the public functions in PARAM_CFG_ARRAY be type const. void SaveParam(..) const and void ReadParam(..) const * PARAM_CFG_BASE now has virtual destructor since we have various way of destroying the derived class and boost::ptr_vector must be told about this. * Pass const PARAM_CFG_ARRAY& instead of PARAM_CFG_ARRAY so that we can use an automatic PARAM_CFG_ARRAY which is on the stack.\ * PCB_EDIT_FRAME::GetProjectFileParameters() may no longer cache the array, since it has to access the current BOARD and the BOARD can change. Remember BOARD_DESIGN_SETTINGS are now in the BOARD. * Made the m_BoundingBox member private, this was a brutally hard task, and indicative of the lack of commitment to accessors and object oriented design on the part of KiCad developers. We must do better. Added BOARD::GetBoundingBox, SetBoundingBox(), ComputeBoundingBox(). * Added PCB_BASE_FRAME::GetBoardBoundingBox() which calls BOARD::ComputeBoundingBox()
2011-12-05 06:15:33 +00:00
TextePcb->m_Thickness = GetBoard()->GetDesignSettings().m_PcbTextWidth;
2008-12-20 17:28:25 +00:00
InstallTextPCBOptionsFrame( TextePcb, DC );
2008-12-20 17:28:25 +00:00
if( TextePcb->m_Text.IsEmpty() )
{
2009-08-03 07:55:08 +00:00
TextePcb->DeleteStructure();
2008-12-20 17:28:25 +00:00
TextePcb = NULL;
}
else
{
2008-12-20 17:28:25 +00:00
StartMoveTextePcb( TextePcb, DC );
}
2008-12-20 17:28:25 +00:00
return TextePcb;
}
void PCB_EDIT_FRAME::Rotate_Texte_Pcb( TEXTE_PCB* TextePcb, wxDC* DC )
2008-12-20 17:28:25 +00:00
{
int angle = 900;
int drawmode = GR_XOR;
if( TextePcb == NULL )
return;
/* Erase previous text. */
TextePcb->Draw( m_canvas, DC, GR_XOR );
2008-12-20 17:28:25 +00:00
TextePcb->m_Orient += angle;
NORMALIZE_ANGLE_POS( TextePcb->m_Orient );
2008-12-20 17:28:25 +00:00
/* Redraw text in new position. */
TextePcb->Draw( m_canvas, DC, drawmode );
TextePcb->DisplayInfo( this );
if( TextePcb->GetFlags() == 0 ) // i.e. not edited, or moved
2009-08-03 07:55:08 +00:00
SaveCopyInUndoList( TextePcb, UR_ROTATED, TextePcb->m_Pos );
else // set flag edit, to show it was a complex command
TextePcb->SetFlags( IN_EDIT );
2008-12-20 17:28:25 +00:00
OnModify();
2008-12-20 17:28:25 +00:00
}