KiCad PCB EDA Suite
block_commande.h File Reference

This file is part of the common library. More...

#include <base_struct.h>
#include <undo_redo_container.h>
#include <gr_basic.h>
#include <eda_rect.h>

Go to the source code of this file.

Classes

class  BLOCK_SELECTOR
 

Enumerations

enum  BLOCK_STATE_T {
  STATE_NO_BLOCK, STATE_BLOCK_INIT, STATE_BLOCK_END, STATE_BLOCK_MOVE,
  STATE_BLOCK_STOP
}
 
enum  BLOCK_COMMAND_T {
  BLOCK_IDLE, BLOCK_MOVE, BLOCK_DUPLICATE, BLOCK_DUPLICATE_AND_INCREMENT,
  BLOCK_COPY, BLOCK_DELETE, BLOCK_PASTE, BLOCK_CUT,
  BLOCK_DRAG, BLOCK_DRAG_ITEM, BLOCK_ROTATE, BLOCK_FLIP,
  BLOCK_ZOOM, BLOCK_ABORT, BLOCK_PRESELECT_MOVE, BLOCK_MOVE_EXACT,
  BLOCK_SELECT_ITEMS_ONLY, BLOCK_MIRROR_X, BLOCK_MIRROR_Y
}
 

Functions

void AbortBlockCurrentCommand (EDA_DRAW_PANEL *aPanel, wxDC *aDC)
 Function AbortBlockCurrentCommand cancels the current block operation. More...
 
void DrawAndSizingBlockOutlines (EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aPosition, bool aErase)
 Function DrawAndSizingBlockOutlines redraws the outlines of the block which shows the search area for block commands. More...
 

Detailed Description

This file is part of the common library.

See also
common.h

Definition in file block_commande.h.

Enumeration Type Documentation

Enumerator
BLOCK_IDLE 
BLOCK_MOVE 
BLOCK_DUPLICATE 
BLOCK_DUPLICATE_AND_INCREMENT 
BLOCK_COPY 
BLOCK_DELETE 
BLOCK_PASTE 
BLOCK_CUT 
BLOCK_DRAG 
BLOCK_DRAG_ITEM 
BLOCK_ROTATE 
BLOCK_FLIP 
BLOCK_ZOOM 
BLOCK_ABORT 
BLOCK_PRESELECT_MOVE 
BLOCK_MOVE_EXACT 
BLOCK_SELECT_ITEMS_ONLY 
BLOCK_MIRROR_X 
BLOCK_MIRROR_Y 

Definition at line 51 of file block_commande.h.

Enumerator
STATE_NO_BLOCK 
STATE_BLOCK_INIT 
STATE_BLOCK_END 
STATE_BLOCK_MOVE 
STATE_BLOCK_STOP 

Definition at line 41 of file block_commande.h.

Function Documentation

void AbortBlockCurrentCommand ( EDA_DRAW_PANEL aPanel,
wxDC *  aDC 
)

Function AbortBlockCurrentCommand cancels the current block operation.

Definition at line 179 of file common/legacy_gal/block.cpp.

References BLOCK_ABORT, BLOCK_IDLE, EDA_DRAW_PANEL::CallMouseCapture(), BLOCK_SELECTOR::ClearItemsList(), EDA_DRAW_FRAME::DisplayToolMsg(), EDA_DRAW_PANEL::GetCurrentCursor(), EDA_DRAW_PANEL::GetParent(), EDA_DRAW_PANEL::GetScreen(), EDA_DRAW_FRAME::HandleBlockEnd(), EDA_DRAW_PANEL::IsMouseCaptured(), BASE_SCREEN::m_BlockLocate, BLOCK_SELECTOR::SetCommand(), BASE_SCREEN::SetCurItem(), EDA_DRAW_PANEL_GAL::SetDefaultCursor(), EDA_DRAW_PANEL::SetMouseCapture(), BLOCK_SELECTOR::SetState(), and STATE_NO_BLOCK.

Referenced by LIB_EDIT_FRAME::HandleBlockEnd(), SCH_EDIT_FRAME::HandleBlockEnd(), BLOCK_SELECTOR::InitData(), and BLOCK_SELECTOR::IsIdle().

180 {
181  BASE_SCREEN* screen = aPanel->GetScreen();
182 
183  if( aPanel->IsMouseCaptured() ) // Erase current drawing on screen
184  {
185  aPanel->SetMouseCapture( NULL, NULL );
186  screen->SetCurItem( NULL );
187 
188  // Delete the picked wrapper if this is a picked list.
189  screen->m_BlockLocate.ClearItemsList();
190  }
191 
194  aPanel->GetParent()->HandleBlockEnd( aDC );
195 
197  aPanel->GetParent()->DisplayToolMsg( wxEmptyString );
198 
199  // ugly, but temporary
200  auto gal_panel = dynamic_cast<EDA_DRAW_PANEL_GAL*>( aPanel );
201 
202  if( gal_panel )
203  gal_panel->SetDefaultCursor();
204 }
virtual BASE_SCREEN * GetScreen()=0
void SetCurItem(EDA_ITEM *aItem)
Function SetCurItem sets the currently selected object, m_CurrentItem.
Definition: base_screen.h:231
BLOCK_SELECTOR m_BlockLocate
Block description for block commands.
Definition: base_screen.h:214
void ClearItemsList()
Function ClearItemsList clear only the list of EDA_ITEM pointers, it does NOT delete the EDA_ITEM obj...
virtual EDA_DRAW_FRAME * GetParent() const =0
void SetState(BLOCK_STATE_T aState)
Class BASE_SCREEN handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:76
virtual void SetMouseCapture(MOUSE_CAPTURE_CALLBACK aMouseCaptureCallback, END_MOUSE_CAPTURE_CALLBACK aEndMouseCaptureCallback)
Function SetMouseCapture sets the mouse capture and end mouse capture callbacks to aMouseCaptureCallb...
virtual bool HandleBlockEnd(wxDC *DC)
Handle the "end" of a block command, i.e.
void DisplayToolMsg(const wxString &msg)
virtual void SetDefaultCursor()
void SetCommand(BLOCK_COMMAND_T aCommand)
void DrawAndSizingBlockOutlines ( EDA_DRAW_PANEL aPanel,
wxDC *  aDC,
const wxPoint &  aPosition,
bool  aErase 
)

Function DrawAndSizingBlockOutlines redraws the outlines of the block which shows the search area for block commands.

The first point of the rectangle showing the area is initialized by InitBlockLocateDatas(). The other point of the rectangle is the mouse cursor position.

Definition at line 544 of file eeschema/block.cpp.

References BLOCK_SELECTOR::Draw(), FRAME_SCH_LIB_EDITOR, g_XorMode, BLOCK_SELECTOR::GetColor(), EDA_DRAW_FRAME::GetCrossHairPosition(), EDA_RECT::GetEnd(), EDA_RECT::GetHeight(), EDA_RECT::GetOrigin(), EDA_DRAW_PANEL::GetParent(), EDA_DRAW_PANEL::GetScreen(), KIGFX::SCH_VIEW::GetSelectionArea(), BLOCK_SELECTOR::GetState(), SCH_DRAW_PANEL::GetView(), EDA_RECT::GetWidth(), BASE_SCREEN::m_BlockLocate, EDA_RECT::SetEnd(), BLOCK_SELECTOR::SetLastCursorPosition(), BLOCK_SELECTOR::SetMoveVector(), BLOCK_SELECTOR::SetState(), STATE_BLOCK_END, and STATE_BLOCK_INIT.

Referenced by LIB_EDIT_FRAME::HandleBlockEnd(), PCB_EDIT_FRAME::HandleBlockEnd(), SCH_EDIT_FRAME::HandleBlockEnd(), BLOCK_SELECTOR::InitData(), and BLOCK_SELECTOR::IsIdle().

546 {
547  auto panel =static_cast<SCH_DRAW_PANEL*>(aPanel);
548  auto area = panel->GetView()->GetSelectionArea();
549  auto frame = static_cast<EDA_BASE_FRAME*>(aPanel->GetParent());
550 
552  bool isLibEdit = frame->IsType( FRAME_SCH_LIB_EDITOR );
553 
554  block = &aPanel->GetScreen()->m_BlockLocate;
555  block->SetMoveVector( wxPoint( 0, 0 ) );
556  block->SetLastCursorPosition( aPanel->GetParent()->GetCrossHairPosition( isLibEdit ) );
557  block->SetEnd( aPanel->GetParent()->GetCrossHairPosition() );
558 
559  panel->GetView()->ClearPreview();
560  panel->GetView()->ClearHiddenFlags();
561 
562  area->SetOrigin( block->GetOrigin() );;
563  area->SetEnd( block->GetEnd() );
564 
565  panel->GetView()->SetVisible( area );
566  panel->GetView()->Hide( area, false );
567  panel->GetView()->Update( area );
568 
569  if( block->GetState() == STATE_BLOCK_INIT )
570  {
571  if( block->GetWidth() || block->GetHeight() )
572  // 2nd point exists: the rectangle is not surface anywhere
573  block->SetState( STATE_BLOCK_END );
574  }
575 }
virtual BASE_SCREEN * GetScreen()=0
BLOCK_SELECTOR m_BlockLocate
Block description for block commands.
Definition: base_screen.h:214
const wxPoint GetOrigin() const
Definition: eda_rect.h:112
KIGFX::PREVIEW::SELECTION_AREA * GetSelectionArea() const
Definition: sch_view.h:85
void SetMoveVector(const wxPoint &aMoveVector)
int GetHeight() const
Definition: eda_rect.h:118
virtual EDA_DRAW_FRAME * GetParent() const =0
void SetState(BLOCK_STATE_T aState)
void SetEnd(int x, int y)
Definition: eda_rect.h:134
KIGFX::SCH_VIEW * GetView() const
Definition: solve.cpp:178
const wxPoint GetEnd() const
Definition: eda_rect.h:114
BLOCK_STATE_T GetState() const
Class EDA_BASE_FRAME is the base frame for deriving all KiCad main window classes.
int GetWidth() const
Definition: eda_rect.h:117
void SetLastCursorPosition(const wxPoint &aPosition)
Function SetLastCursorPosition sets the last cursor position to aPosition.
wxPoint GetCrossHairPosition(bool aInvertY=false) const
Return the current cross hair position in logical (drawing) coordinates.