KiCad PCB EDA Suite
Loading...
Searching...
No Matches
drc_re_abs_length_two_overlay_panel.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
24
25#include <base_units.h>
26#include <eda_base_frame.h>
27#include <widgets/unit_binder.h>
28
29#include <wx/checkbox.h>
30#include <wx/textctrl.h>
31#include <wx/stattext.h>
32
34 wxWindow* aParent, DRC_RE_ABSOLUTE_LENGTH_TWO_CONSTRAINT_DATA* aData, EDA_UNITS aUnits ) :
36 m_data( aData ),
38{
40
41 std::vector<DRC_RE_FIELD_POSITION> positions = m_data->GetFieldPositions();
42
43 wxWindow* eventSource = nullptr;
44
45 for( wxWindow* win = aParent; win; win = win->GetParent() )
46 {
47 if( dynamic_cast<EDA_BASE_FRAME*>( win ) )
48 {
49 eventSource = win;
50 break;
51 }
52 }
53
54 // Create opt length field
55 auto* optLengthField = AddField<wxTextCtrl>( wxS( "opt_length" ), positions[0], wxTE_CENTRE | wxTE_PROCESS_ENTER );
57 std::make_unique<UNIT_BINDER>( &m_unitsProvider, eventSource, nullptr, optLengthField->GetControl(),
58 optLengthField->GetLabel(), false, false );
59 optLengthField->SetUnitBinder( m_optLengthBinder.get() );
60 optLengthField->GetControl()->SetValidator( VALIDATOR_NUMERIC_CTRL( false, false ) );
61
62 // Create tolerance field
63 auto* toleranceField = AddField<wxTextCtrl>( wxS( "tolerance" ), positions[1], wxTE_CENTRE | wxTE_PROCESS_ENTER );
65 std::make_unique<UNIT_BINDER>( &m_unitsProvider, eventSource, nullptr, toleranceField->GetControl(),
66 toleranceField->GetLabel(), false, false );
67 toleranceField->SetUnitBinder( m_toleranceBinder.get() );
68 toleranceField->GetControl()->SetValidator( VALIDATOR_NUMERIC_CTRL( false, false ) );
69
70
71 DRC_RE_FIELD_POSITION checkboxPos( 80, 300, 170, _( "Time domain (ps)" ), LABEL_POSITION::NONE,
72 _( "The values are picoseconds instead of a length" ) );
73
74 m_timeDomainCheckbox = static_cast<wxCheckBox*>( AddCheckbox( wxS( "time_domain" ), checkboxPos )->GetControl() );
75 m_timeDomainCheckbox->SetValue( m_data->IsTimeDomain() );
76
77 m_timeDomainCheckbox->Bind( wxEVT_CHECKBOX,
78 [this]( wxCommandEvent& aEvent )
79 {
81 m_data->SetTimeDomain( m_timeDomainCheckbox->GetValue() );
84 aEvent.Skip();
85 } );
86
88
89 // Position all fields and update the panel layout
93}
94
95
97{
98 bool timeDomain = m_data->IsTimeDomain();
99
100 for( UNIT_BINDER* binder : { m_optLengthBinder.get(), m_toleranceBinder.get() } )
101 {
102 binder->SetUnits( timeDomain ? EDA_UNITS::PS : m_unitsProvider.GetUserUnits() );
103 binder->SetDataType( timeDomain ? EDA_DATA_TYPE::TIME : EDA_DATA_TYPE::DISTANCE );
104 }
105}
106
107
109{
110 return m_data->IsTimeDomain() ? aValue * pcbIUScale.IU_PER_PS : pcbIUScale.mmToIU( aValue );
111}
112
113
115{
116 return m_data->IsTimeDomain() ? aValue / pcbIUScale.IU_PER_PS : pcbIUScale.IUTomm( aValue );
117}
118
119
121{
122 if( !m_data )
123 return false;
124
125 m_optLengthBinder->ChangeDoubleValue( displayToIU( m_data->GetOptimumLength() ) );
126 m_toleranceBinder->ChangeDoubleValue( displayToIU( m_data->GetTolerance() ) );
127
128 return true;
129}
130
131
133{
134 if( !m_data )
135 return false;
136
137 m_data->SetOptimumLength( iuToDisplay( m_optLengthBinder->GetDoubleValue() ) );
138 m_data->SetTolerance( iuToDisplay( m_toleranceBinder->GetDoubleValue() ) );
139
140 return true;
141}
142
143
145 wxString* aValidationMessage )
146{
148
149 VALIDATION_RESULT result = m_data->Validate();
150
151 if( !result.isValid )
152 {
153 *aErrorCount = result.errors.size();
154
155 for( size_t i = 0; i < result.errors.size(); i++ )
156 *aValidationMessage += DRC_RULE_EDITOR_UTILS::FormatErrorMessage( i + 1, result.errors[i] );
157
158 return false;
159 }
160
161 return true;
162}
163
164
166{
167 if( !m_data )
168 return wxEmptyString;
169
170 return m_data->GenerateRule( aContext );
171}
constexpr EDA_IU_SCALE pcbIUScale
Definition base_units.h:128
BITMAPS GetOverlayBitmap() const override
Returns the bitmap to use for the overlay panel background.
DRC_RE_ABS_LENGTH_TWO_OVERLAY_PANEL(wxWindow *aParent, DRC_RE_ABSOLUTE_LENGTH_TWO_CONSTRAINT_DATA *aData, EDA_UNITS aUnits)
wxString GenerateRule(const RULE_GENERATION_CONTEXT &aContext) override
bool ValidateInputs(int *aErrorCount, wxString *aValidationMessage) override
DRC_RE_ABSOLUTE_LENGTH_TWO_CONSTRAINT_DATA * m_data
DRC_RE_OVERLAY_FIELD * AddCheckbox(const wxString &aId, const DRC_RE_FIELD_POSITION &aPosition)
Create and position a checkbox control on the bitmap overlay.
void SetMinimumHeightDIP(int aHeight)
Asks for a panel taller than its illustration.
DRC_RE_OVERLAY_FIELD * AddField(const wxString &aId, const DRC_RE_FIELD_POSITION &aPosition, long aStyle=0)
Create and position a field control on the bitmap overlay.
void SetBackgroundBitmap(BITMAPS aBitmap)
Set the background bitmap for this panel.
DRC_RE_BITMAP_OVERLAY_PANEL(wxWindow *aParent, wxWindowID aId=wxID_ANY)
void PositionFields()
Position all fields based on the current scale factor.
wxControl * GetControl() const
static wxString FormatErrorMessage(int aErrorCount, const wxString &aErrorMessage)
The base frame for deriving all KiCad main window classes.
#define _(s)
Base window classes and related definitions.
EDA_UNITS
Definition eda_units.h:45
Specifies the position and size of a field overlaid on a constraint bitmap.
Result of a validation operation.
wxString result
Test unit parsing edge cases and error handling.