electron
/
kicad
mirror of https://gitlab.com/kicad/code/kicad.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve graphical feedback while placing a meander.

This commit is contained in:
Jeff Young 2023-10-09 15:22:16 +01:00
parent 60a2439a53
commit b662ff4956
7 changed files with 144 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
pcbnew/board_commit.h
View File

@ -54,8 +54,7 @@ public:
BOARD* GetBoard() const;
virtual void Push( const wxString& aMessage = wxT( "A commit" ),
int aCommitFlags = 0 ) override;
virtual void Push( const wxString& aMessage = wxEmptyString, int aCommitFlags = 0 ) override;
virtual void Revert() override;
COMMIT& Stage( EDA_ITEM* aItem, CHANGE_TYPE aChangeType,

147
pcbnew/generators/pcb_generator_meanders.cpp
View File

@ -25,12 +25,13 @@
#include <pcb_generator.h>
#include <generators_mgr.h>
#include <array>
#include <optional>
#include <magic_enum.hpp>
#include <wx/debug.h>
#include <geometry/shape_circle.h>
#include <kiplatform/ui.h>
#include <collectors.h>
#include <pcb_track.h>
#include <pcb_shape.h>
@ -39,9 +40,10 @@
#include <tool/edit_points.h>
#include <tools/drawing_tool.h>
#include <tools/generator_tool.h>
#include <tools/pcb_picker_tool.h>
#include <tools/pcb_selection_tool.h>
#include <preview_items/draw_context.h>
#include <preview_items/preview_utils.h>
#include <view/view.h>
#include <router/pns_meander_placer_base.h>
@ -208,6 +210,7 @@ public:
void EditStart( GENERATOR_TOOL* aTool, BOARD* aBoard, PCB_BASE_EDIT_FRAME* aFrame,
BOARD_COMMIT* aCommit ) override
{
if( aCommit )
aCommit->Modify( this );
int layer = GetLayer();
@ -572,11 +575,9 @@ public:
// LINE does not have a separate remover, as LINEs are never truly a member of the tree
for( PNS::LINKED_ITEM* li : line->Links() )
{
if( li->Parent() )
{
if( li->Parent() && aCommit )
aCommit->Remove( li->Parent() );
}
}
world->Remove( *line );
@ -631,14 +632,12 @@ public:
m_tuningInfo = placer->TuningInfo( aFrame->GetUserUnits() );
m_tuningStatus = placer->TuningStatus();
if( !aCommit->Empty() )
aCommit->Push( "Update meander" );
return true;
}
void EditPush( GENERATOR_TOOL* aTool, BOARD* aBoard, PCB_BASE_EDIT_FRAME* aFrame,
BOARD_COMMIT* aCommit ) override
BOARD_COMMIT* aCommit, const wxString& aCommitMsg = wxEmptyString,
int aCommitFlags = 0 ) override
{
PNS::ROUTER* router = aTool->Router();
@ -663,7 +662,7 @@ public:
}
}
aCommit->Push( "Meander edit", APPEND_UNDO );
aCommit->Push( aCommitMsg, aCommitFlags );
}
bool MakeEditPoints( std::shared_ptr<EDIT_POINTS> points ) const override
@ -1026,29 +1025,129 @@ const wxString PCB_GENERATOR_MEANDERS::DISPLAY_NAME = _HKI( "Meanders" );
const wxString PCB_GENERATOR_MEANDERS::GENERATOR_TYPE = wxS( "meanders" );
#define HITTEST_THRESHOLD_PIXELS 5
int DRAWING_TOOL::PlaceMeander( const TOOL_EVENT& aEvent )
{
VECTOR2I tableSize;
PCB_PICKER_TOOL* picker = m_toolMgr->GetTool<PCB_PICKER_TOOL>();
m_frame->SetActiveLayer( Edge_Cuts );
m_toolMgr->RunAction( PCB_ACTIONS::selectionClear );
std::vector<BOARD_ITEM*> preview;
std::vector<BOARD_ITEM*> items;
// Deactivate other tools; particularly important if another PICKER is currently running
Activate();
PCB_SHAPE* circle = new PCB_SHAPE( nullptr, SHAPE_T::CIRCLE );
circle->SetEnd( VECTOR2I( pcbIUScale.mmToIU( 2 ), 0 ) );
circle->SetLayer( m_frame->GetActiveLayer() );
m_pickerItem = nullptr;
m_meander = nullptr;
preview.push_back( circle );
picker->SetCursor( KICURSOR::BULLSEYE );
PCB_GENERATOR_MEANDERS* generator = new PCB_GENERATOR_MEANDERS( m_board );
items.push_back( generator );
if( InteractivePlaceWithPreview( aEvent, items, preview, nullptr ) != -1 )
picker->SetClickHandler(
[this]( const VECTOR2D& aPosition ) -> bool
{
m_toolMgr->RunAction<PCB_GENERATOR*>( PCB_ACTIONS::regenerateItem, generator );
if( m_pickerItem )
{
if( !m_meander )
{
// First click; create a meander generator
m_toolMgr->GetTool<PCB_SELECTION_TOOL>()->UnbrightenItem( m_pickerItem );
m_frame->SetActiveLayer( m_pickerItem->GetLayer() );
m_meander = new PCB_GENERATOR_MEANDERS( m_board, m_pickerItem->GetLayer() );
int dummyDist;
int dummyClearance = std::numeric_limits<int>::max() / 2;
VECTOR2I closestPt;
m_pickerItem->GetEffectiveShape()->Collide( aPosition, dummyClearance,
&dummyDist, &closestPt );
m_meander->SetPosition( closestPt );
}
else
{
// Second click; we're done
BOARD_COMMIT commit( m_frame );
GENERATOR_TOOL* generatorTool = m_toolMgr->GetTool<GENERATOR_TOOL>();
m_meander->EditStart( generatorTool, m_board, m_frame, &commit );
m_meander->Update( generatorTool, m_board, m_frame, &commit );
m_meander->EditPush( generatorTool, m_board, m_frame, &commit,
_( "Place Meander" ) );
return false; // exit picker tool
}
}
return true;
} );
picker->SetMotionHandler(
[this]( const VECTOR2D& aPos )
{
BOARD* board = m_frame->GetBoard();
PCB_SELECTION_TOOL* selTool = m_toolMgr->GetTool<PCB_SELECTION_TOOL>();
GENERAL_COLLECTORS_GUIDE guide = m_frame->GetCollectorsGuide();
GENERAL_COLLECTOR collector;
collector.m_Threshold = KiROUND( getView()->ToWorld( HITTEST_THRESHOLD_PIXELS ) );
collector.Collect( board, { PCB_TRACE_T, PCB_ARC_T }, aPos, guide );
if( collector.GetCount() > 1 )
selTool->GuessSelectionCandidates( collector, aPos );
BOARD_ITEM* item = collector.GetCount() == 1 ? collector[ 0 ] : nullptr;
if( !m_meander )
{
// First click not yet made; we're in brighten-track-under-cursor mode
if( m_pickerItem != item )
{
if( m_pickerItem )
selTool->UnbrightenItem( m_pickerItem );
m_pickerItem = item;
if( m_pickerItem )
selTool->BrightenItem( m_pickerItem );
}
}
else
{
// First click alread made; we're in preview-meander mode
m_meander->SetEnd( aPos );
if( m_meander->GetPosition() != m_meander->GetEnd() )
{
GENERATOR_TOOL* generatorTool = m_toolMgr->GetTool<GENERATOR_TOOL>();
m_meander->EditStart( generatorTool, m_board, m_frame, nullptr );
m_meander->Update( generatorTool, m_board, m_frame, nullptr );
}
}
} );
picker->SetCancelHandler(
[this]()
{
if( m_pickerItem )
m_toolMgr->GetTool<PCB_SELECTION_TOOL>()->UnbrightenItem( m_pickerItem );
delete m_meander;
m_meander = nullptr;
} );
picker->SetFinalizeHandler(
[this]( const int& aFinalState )
{
// Ensure the cursor gets changed & updated
m_frame->GetCanvas()->SetCurrentCursor( KICURSOR::ARROW );
m_frame->GetCanvas()->Refresh();
} );
m_toolMgr->RunAction( ACTIONS::pickerTool, &aEvent );
return 0;
}

12
pcbnew/pcb_generator.cpp
View File

@ -47,15 +47,13 @@ void PCB_GENERATOR::EditStart( GENERATOR_TOOL* aTool, BOARD* aBoard, PCB_BASE_ED
{
aCommit->Modify( aItem );
} );
aCommit->Push( "Generator edit start" );
}
void PCB_GENERATOR::EditPush( GENERATOR_TOOL* aTool, BOARD* aBoard, PCB_BASE_EDIT_FRAME* aFrame,
BOARD_COMMIT* aCommit )
BOARD_COMMIT* aCommit, const wxString& aCommitMsg, int aCommitFlags )
{
aCommit->Push( "Generator edit end", APPEND_UNDO );
aCommit->Push( aCommitMsg, aCommitFlags );
}
@ -120,12 +118,6 @@ const BOX2I PCB_GENERATOR::GetBoundingBox() const
}
VECTOR2I PCB_GENERATOR::GetPosition() const
{
return m_origin;
}
void PCB_GENERATOR::Move( const VECTOR2I& aMoveVector )
{
m_origin += aMoveVector;

6
pcbnew/pcb_generator.h
View File

@ -50,7 +50,8 @@ public:
BOARD_COMMIT* aCommit );
virtual void EditPush( GENERATOR_TOOL* aTool, BOARD* aBoard, PCB_BASE_EDIT_FRAME* aFrame,
BOARD_COMMIT* aCommit );
BOARD_COMMIT* aCommit, const wxString& aCommitMsg = wxEmptyString,
int aCommitFlags = 0 );
virtual void EditRevert( GENERATOR_TOOL* aTool, BOARD* aBoard, PCB_BASE_EDIT_FRAME* aFrame,
BOARD_COMMIT* aCommit );
@ -72,7 +73,8 @@ public:
const BOX2I GetBoundingBox() const override;
VECTOR2I GetPosition() const override;
VECTOR2I GetPosition() const override { return m_origin; }
void SetPosition( const VECTOR2I& aPos ) override { m_origin = aPos; }
void Move( const VECTOR2I& aMoveVector ) override;

6
pcbnew/tools/drawing_tool.h
View File

@ -43,6 +43,8 @@ class BOARD;
class PCB_BASE_EDIT_FRAME;
class PCB_SHAPE;
class POLYGON_GEOM_MANAGER;
class PCB_GENERATOR_MEANDERS;
/**
* Tool responsible for drawing graphical elements like lines, arcs, circles, etc.
@ -350,6 +352,10 @@ private:
STROKE_PARAMS m_stroke; // Current stroke for multi-segment drawing
TEXT_ATTRIBUTES m_textAttrs;
BOARD_ITEM* m_pickerItem;
PCB_GENERATOR_MEANDERS* m_meander;
static const unsigned int WIDTH_STEP; // Amount of width change for one -/+ key press
static const unsigned int COORDS_PADDING; // Padding from coordinates limits for this tool

10
pcbnew/tools/generator_tool.cpp
View File

@ -113,7 +113,7 @@ int GENERATOR_TOOL::RegenerateAll( const TOOL_EVENT& aEvent )
{
gen->EditStart( this, board(), frame(), commit );
gen->Update( this, board(), frame(), commit );
gen->EditPush( this, board(), frame(), commit );
gen->EditPush( this, board(), frame(), commit, _( "Regenerate" ), APPEND_UNDO );
}
return 0;
@ -140,7 +140,7 @@ int GENERATOR_TOOL::RegenerateOutdated( const TOOL_EVENT& aEvent )
{
gen->EditStart( this, board(), frame(), commit );
gen->Update( this, board(), frame(), commit );
gen->EditPush( this, board(), frame(), commit );
gen->EditPush( this, board(), frame(), commit, _( "Regenerate Outdated" ), APPEND_UNDO );
}
return 0;
@ -188,7 +188,7 @@ int GENERATOR_TOOL::RegenerateSelected( const TOOL_EVENT& aEvent )
{
gen->EditStart( this, board(), frame(), commit );
gen->Update( this, board(), frame(), commit );
gen->EditPush( this, board(), frame(), commit );
gen->EditPush( this, board(), frame(), commit, _( "Regenerate Selected" ), APPEND_UNDO );
}
return 0;
@ -207,7 +207,7 @@ int GENERATOR_TOOL::RegenerateItem( const TOOL_EVENT& aEvent )
gen->EditStart( this, board(), frame(), commit );
gen->Update( this, board(), frame(), commit );
gen->EditPush( this, board(), frame(), commit );
gen->EditPush( this, board(), frame(), commit, _( "Regenerate Item" ) );
return 0;
}
@ -231,7 +231,7 @@ int GENERATOR_TOOL::GenEditAction( const TOOL_EVENT& aEvent )
}
else if( aEvent.IsAction( &PCB_ACTIONS::genPushEdit ) )
{
gen->EditPush( this, board(), frame(), commit );
gen->EditPush( this, board(), frame(), commit, wxEmptyString, APPEND_UNDO );
wxASSERT( commit->Empty() );
}

4
pcbnew/tools/pcb_actions.cpp
View File

@ -189,8 +189,8 @@ TOOL_ACTION PCB_ACTIONS::drawTextBox( TOOL_ACTION_ARGS()
TOOL_ACTION PCB_ACTIONS::placeMeanders( TOOL_ACTION_ARGS()
.Name( "pcbnew.InteractiveDrawing.placeMeanders" )
.Scope( AS_GLOBAL )
.MenuText( _( "Add Meanders" ) )
.Tooltip( _( "Add meanders for length tuning" ) )
.MenuText( _( "Add Meander" ) )
.Tooltip( _( "Add meander for length tuning" ) )
.Icon( BITMAPS::ps_tune_length )
.Flags( AF_ACTIVATE ) );