kicad/pcbnew/dialogs/dialog_dimension_properties...

369 lines
13 KiB
C++
Raw Normal View History

2020-09-08 02:42:26 +00:00
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2020 Jon Evans <jon@craftyjon.com>
* Copyright (C) 2020 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 3 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, see <http://www.gnu.org/licenses/>.
*/
#include <board.h>
#include <board_commit.h>
#include <dimension.h>
2020-09-08 02:42:26 +00:00
#include <pcb_base_edit_frame.h>
#include <pcb_layer_box_selector.h>
#include <widgets/unit_binder.h>
2021-06-06 12:41:16 +00:00
#include <wx/msgdlg.h>
2020-09-08 02:42:26 +00:00
#include "dialog_dimension_properties.h"
DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES( PCB_BASE_EDIT_FRAME* aParent,
BOARD_ITEM* aItem ) :
DIALOG_DIMENSION_PROPERTIES_BASE( aParent ),
m_frame( aParent ),
m_cbLayerActual( m_cbLayer ),
m_txtValueActual( m_txtValue ),
m_textWidth( aParent, m_lblTextWidth, m_txtTextWidth, m_lblTextWidthUnits ),
m_textHeight( aParent, m_lblTextHeight, m_txtTextHeight, m_lblTextHeightUnits ),
m_textThickness( aParent, m_lblTextThickness, m_txtTextThickness, m_lblTextThicknessUnits ),
2020-09-08 02:42:26 +00:00
m_textPosX( aParent, m_lblTextPosX, m_txtTextPosX, m_lblTextPosXUnits ),
m_textPosY( aParent, m_lblTextPosY, m_txtTextPosY, m_lblTextPosYUnits ),
m_orientValidator( 1, &m_orientValue ),
m_lineThickness( aParent, m_lblLineThickness, m_txtLineThickness, m_lblLineThicknessUnits ),
m_arrowLength( aParent, m_lblArrowLength, m_txtArrowLength, m_lblArrowLengthUnits ),
m_extensionOffset( aParent, m_lblExtensionOffset, m_txtExtensionOffset, m_lblExtensionOffsetUnits )
2020-09-08 02:42:26 +00:00
{
wxASSERT( BaseType( aItem->Type() ) == PCB_DIMENSION_T );
m_dimension = static_cast<DIMENSION_BASE*>( aItem );
m_previewDimension = static_cast<DIMENSION_BASE*>( m_dimension->Clone() );
2020-09-12 14:23:07 +00:00
m_previewDimension->SetParent( m_frame->GetBoard() );
2020-09-08 02:42:26 +00:00
switch( m_dimension->Type() )
{
case PCB_DIM_LEADER_T:
// Hide the main format controls and keep the leader controls shown
m_sizerFormat->GetStaticBox()->Hide();
2020-09-17 00:54:58 +00:00
m_sizerCenter->GetStaticBox()->Hide();
m_cbLayerActual = m_cbLeaderLayer;
m_txtValueActual = m_txtLeaderValue;
// Remove a fewings from text format
m_lblTextPositionMode->Hide();
m_cbTextPositionMode->Hide();
break;
2020-09-17 00:54:58 +00:00
case PCB_DIM_CENTER_T:
m_sizerLeader->GetStaticBox()->Hide();
m_sizerFormat->GetStaticBox()->Hide();
m_sizerText->GetStaticBox()->Hide();
m_lblArrowLength->Hide();
m_txtArrowLength->Hide();
m_lblArrowLengthUnits->Hide();
m_lblExtensionOffset->Hide();
m_txtExtensionOffset->Hide();
m_lblExtensionOffsetUnits->Hide();
m_cbLayerActual = m_cbCenterLayer;
break;
default:
m_sizerLeader->GetStaticBox()->Hide();
2020-09-17 00:54:58 +00:00
m_sizerCenter->GetStaticBox()->Hide();
break;
}
// Fix the size after hiding/showing some of the properties
Layout();
2020-09-08 02:42:26 +00:00
// Configure display origin transforms
m_textPosX.SetCoordType( ORIGIN_TRANSFORMS::ABS_X_COORD );
m_textPosY.SetCoordType( ORIGIN_TRANSFORMS::ABS_Y_COORD );
// Configure the layers list selector. Note that footprints are built outside the current
// board and so we may need to show all layers if the text is on an unactivated layer.
if( !m_frame->GetBoard()->IsLayerEnabled( m_dimension->GetLayer() ) )
m_cbLayerActual->ShowNonActivatedLayers( true );
2020-09-08 02:42:26 +00:00
m_cbLayerActual->SetLayersHotkeys( false );
m_cbLayerActual->SetBoardFrame( aParent );
m_cbLayerActual->Resync();
2020-09-08 02:42:26 +00:00
m_orientValue = 0.0;
m_orientValidator.SetRange( -360.0, 360.0 );
m_cbTextOrientation->SetValidator( m_orientValidator );
m_orientValidator.SetWindow( m_cbTextOrientation );
// Handle decimal separators in combo dropdown
for( size_t i = 0; i < m_cbTextOrientation->GetCount(); ++i )
{
wxString item = m_cbTextOrientation->GetString( i );
item.Replace( '.', localeconv()->decimal_point[0] );
m_cbTextOrientation->SetString( i, item );
}
m_sdbSizerOK->SetDefault();
m_cbOverrideValue->Bind( wxEVT_CHECKBOX,
[&]( wxCommandEvent& evt )
{
m_txtValue->Enable( m_cbOverrideValue->GetValue() );
if( !m_cbOverrideValue->GetValue() )
m_txtValue->SetValue( m_dimension->GetValueText() );
} );
auto updateEventHandler =
[&]( wxCommandEvent& evt )
{
if( !m_cbOverrideValue->GetValue() )
m_txtValue->ChangeValue( m_dimension->GetValueText() );
updatePreviewText();
};
// No need to use m_txtValueActual here since we don't have previewing for leaders
m_txtValue->Bind( wxEVT_TEXT, updateEventHandler );
m_txtPrefix->Bind( wxEVT_TEXT, updateEventHandler );
m_txtSuffix->Bind( wxEVT_TEXT, updateEventHandler );
m_cbUnits->Bind( wxEVT_CHOICE, updateEventHandler );
m_cbUnitsFormat->Bind( wxEVT_CHOICE, updateEventHandler );
m_cbPrecision->Bind( wxEVT_CHOICE, updateEventHandler );
m_cbSuppressZeroes->Bind( wxEVT_CHECKBOX, updateEventHandler );
m_cbTextPositionMode->Bind( wxEVT_CHOICE,
[&]( wxCommandEvent& aEvt )
{
// manual mode
bool allowPositioning = ( m_cbTextPositionMode->GetSelection() == 2 );
m_txtTextPosX->Enable( allowPositioning );
m_txtTextPosY->Enable( allowPositioning );
} );
m_cbKeepAligned->Bind( wxEVT_CHECKBOX,
[&]( wxCommandEvent& aEvt )
{
m_cbTextOrientation->Enable( !m_cbKeepAligned->GetValue() );
} );
2020-11-16 11:16:44 +00:00
finishDialogSettings();
2020-09-08 02:42:26 +00:00
}
DIALOG_DIMENSION_PROPERTIES::~DIALOG_DIMENSION_PROPERTIES()
{
delete m_previewDimension;
2020-09-08 02:42:26 +00:00
}
bool DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow()
{
BOARD* board = m_frame->GetBoard();
m_txtValue->Enable( m_dimension->GetOverrideTextEnabled() );
m_cbOverrideValue->SetValue( m_dimension->GetOverrideTextEnabled() );
2020-09-08 02:42:26 +00:00
switch( m_dimension->GetUnitsMode() )
{
case DIM_UNITS_MODE::INCHES: m_cbUnits->SetSelection( 0 ); break;
case DIM_UNITS_MODE::MILS: m_cbUnits->SetSelection( 1 ); break;
case DIM_UNITS_MODE::MILLIMETRES: m_cbUnits->SetSelection( 2 ); break;
case DIM_UNITS_MODE::AUTOMATIC: m_cbUnits->SetSelection( 3 ); break;
}
2020-09-08 02:42:26 +00:00
m_cbUnitsFormat->SetSelection( static_cast<int>( m_dimension->GetUnitsFormat() ) );
m_cbPrecision->SetSelection( static_cast<int>( m_dimension->GetPrecision() ) );
2020-09-08 02:42:26 +00:00
m_txtPrefix->SetValue( board->ConvertKIIDsToCrossReferences( m_dimension->GetPrefix() ) );
m_txtSuffix->SetValue( board->ConvertKIIDsToCrossReferences( m_dimension->GetSuffix() ) );
2020-09-08 02:42:26 +00:00
if( m_cbLayerActual->SetLayerSelection( m_dimension->GetLayer() ) < 0 )
2020-09-08 02:42:26 +00:00
{
wxMessageBox( _( "This item was on a non-existing or forbidden layer.\n"
"It has been moved to the first allowed layer." ) );
m_cbLayerActual->SetSelection( 0 );
2020-09-08 02:42:26 +00:00
}
m_cbSuppressZeroes->SetValue( m_dimension->GetSuppressZeroes() );
PCB_TEXT& text = m_dimension->Text();
2020-09-08 02:42:26 +00:00
m_textWidth.SetValue( text.GetTextSize().x );
m_textHeight.SetValue( text.GetTextSize().y );
m_textThickness.SetValue( text.GetTextThickness() );
2020-09-08 02:42:26 +00:00
m_textPosX.SetValue( text.GetTextPos().x );
m_textPosY.SetValue( text.GetTextPos().y );
m_cbTextPositionMode->SetSelection( static_cast<int>( m_dimension->GetTextPositionMode() ) );
if( m_dimension->GetTextPositionMode() != DIM_TEXT_POSITION::MANUAL )
{
m_txtTextPosX->Disable();
m_txtTextPosY->Disable();
}
m_orientValue = text.GetTextAngleDegrees();
m_cbKeepAligned->SetValue( m_dimension->GetKeepTextAligned() );
m_cbTextOrientation->Enable( !m_dimension->GetKeepTextAligned() );
2020-09-08 02:42:26 +00:00
m_cbItalic->SetValue( text.IsItalic() );
m_cbMirrored->SetValue( text.IsMirrored() );
2020-09-08 02:42:26 +00:00
EDA_TEXT_HJUSTIFY_T hJustify = text.GetHorizJustify();
m_cbJustification->SetSelection( (int) hJustify + 1 );
m_lineThickness.SetValue( m_dimension->GetLineThickness() );
m_arrowLength.SetValue( m_dimension->GetArrowLength() );
m_extensionOffset.SetValue( m_dimension->GetExtensionOffset() );
// Do this last; it depends on the other settings
if( m_dimension->GetOverrideTextEnabled() )
{
wxString txt = board->ConvertKIIDsToCrossReferences( m_dimension->GetOverrideText() );
m_txtValueActual->SetValue( txt );
}
else
{
m_txtValueActual->SetValue( m_dimension->GetValueText() );
}
m_orientValidator.TransferToWindow();
if( m_dimension->Type() == PCB_DIM_LEADER_T )
{
LEADER* leader = static_cast<LEADER*>( m_dimension );
m_cbTextFrame->SetSelection( static_cast<int>( leader->GetTextFrame() ) );
}
2020-09-08 02:42:26 +00:00
return DIALOG_DIMENSION_PROPERTIES_BASE::TransferDataToWindow();
}
bool DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow()
{
if( !DIALOG_DIMENSION_PROPERTIES_BASE::TransferDataFromWindow() )
return false;
BOARD_COMMIT commit( m_frame );
commit.Modify( m_dimension );
// If no other command in progress, prepare undo command
// (for a command in progress, will be made later, at the completion of command)
bool pushCommit = ( m_dimension->GetEditFlags() == 0 );
/* set flag in edit to force undo/redo/abort proper operation,
* and avoid new calls to SaveCopyInUndoList for the same dimension
* this can occurs when a dimension is moved, and then rotated, edited ..
*/
if( !pushCommit )
m_dimension->SetFlags( IN_EDIT );
updateDimensionFromDialog( m_dimension );
if( pushCommit )
commit.Push( _( "Change dimension properties" ) );
2020-09-08 02:42:26 +00:00
return true;
}
void DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog( DIMENSION_BASE* aTarget )
{
BOARD* board = m_frame->GetBoard();
m_orientValidator.TransferFromWindow();
aTarget->SetOverrideTextEnabled( m_cbOverrideValue->GetValue() );
if( m_cbOverrideValue->GetValue() )
{
wxString txt = board->ConvertCrossReferencesToKIIDs( m_txtValueActual->GetValue() );
aTarget->SetOverrideText( txt );
}
aTarget->SetPrefix( board->ConvertCrossReferencesToKIIDs( m_txtPrefix->GetValue() ) );
aTarget->SetSuffix( board->ConvertCrossReferencesToKIIDs( m_txtSuffix->GetValue() ) );
aTarget->SetLayer( static_cast<PCB_LAYER_ID>( m_cbLayerActual->GetLayerSelection() ) );
switch( m_cbUnits->GetSelection() )
{
case 0:
aTarget->SetUnitsMode( DIM_UNITS_MODE::INCHES );
break;
case 1:
aTarget->SetUnitsMode( DIM_UNITS_MODE::MILS );
break;
case 2:
aTarget->SetUnitsMode( DIM_UNITS_MODE::MILLIMETRES );
break;
case 3:
aTarget->SetUnitsMode( DIM_UNITS_MODE::AUTOMATIC );
aTarget->SetUnits( m_frame->GetUserUnits() );
break;
}
aTarget->SetUnitsFormat( static_cast<DIM_UNITS_FORMAT>( m_cbUnitsFormat->GetSelection() ) );
aTarget->SetPrecision( m_cbPrecision->GetSelection() );
aTarget->SetSuppressZeroes( m_cbSuppressZeroes->GetValue() );
PCB_TEXT& text = aTarget->Text();
DIM_TEXT_POSITION tpm = static_cast<DIM_TEXT_POSITION>( m_cbTextPositionMode->GetSelection() );
aTarget->SetTextPositionMode( tpm );
if( tpm == DIM_TEXT_POSITION::MANUAL )
{
wxPoint pos( m_textPosX.GetValue(), m_textPosY.GetValue() );
text.SetPosition( pos );
}
aTarget->SetKeepTextAligned( m_cbKeepAligned->GetValue() );
text.SetTextAngle( KiROUND( m_orientValue * 10.0 ) );
text.SetTextWidth( m_textWidth.GetValue() );
text.SetTextHeight( m_textHeight.GetValue() );
text.SetTextThickness( m_textThickness.GetValue() );
text.SetItalic( m_cbItalic->GetValue() );
text.SetMirrored( m_cbMirrored->GetValue() );
int justification = m_cbJustification->GetSelection() - 1;
text.SetHorizJustify( static_cast<EDA_TEXT_HJUSTIFY_T>( justification ) );
aTarget->SetLineThickness( m_lineThickness.GetValue() );
aTarget->SetArrowLength( m_arrowLength.GetValue() );
aTarget->SetExtensionOffset( m_extensionOffset.GetValue() );
if( aTarget->Type() == PCB_DIM_LEADER_T )
{
LEADER* leader = static_cast<LEADER*>( aTarget );
leader->SetTextFrame( static_cast<DIM_TEXT_FRAME>( m_cbTextFrame->GetSelection() ) );
}
aTarget->Update();
}
void DIALOG_DIMENSION_PROPERTIES::updatePreviewText()
{
updateDimensionFromDialog( m_previewDimension );
m_staticTextPreview->SetLabel( m_previewDimension->Text().GetShownText() );
}