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

◆ BLOCK_COMMAND_T

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.

◆ BLOCK_STATE_T

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

◆ AbortBlockCurrentCommand()

void AbortBlockCurrentCommand ( EDA_DRAW_PANEL aPanel,
wxDC *  aDC 
)

Function AbortBlockCurrentCommand cancels the current block operation.

Definition at line 201 of file common/legacy_wx/block.cpp.

202 {
203  BASE_SCREEN* screen = aPanel->GetScreen();
204 
205  if( aPanel->IsMouseCaptured() ) // Erase current drawing on screen
206  {
207  // Clear block outline.
208  aPanel->CallMouseCapture( aDC, wxDefaultPosition, false );
209  aPanel->SetMouseCapture( NULL, NULL );
210  screen->SetCurItem( NULL );
211 
212  // Delete the picked wrapper if this is a picked list.
213  screen->m_BlockLocate.ClearItemsList();
214  }
215 
218  aPanel->GetParent()->HandleBlockEnd( aDC );
219 
221  aPanel->GetParent()->DisplayToolMsg( wxEmptyString );
222  aPanel->SetCursor( (wxStockCursor) aPanel->GetCurrentCursor() );
223 }
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
int GetCurrentCursor() const
Function GetCurrentCursor.
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 void CallMouseCapture(wxDC *aDC, const wxPoint &aPosition, bool aErase)
Function CallMouseCapture calls the mouse capture callback.
virtual bool HandleBlockEnd(wxDC *DC)
Handle the "end" of a block command, i.e.
void DisplayToolMsg(const wxString &msg)
void SetCommand(BLOCK_COMMAND_T aCommand)

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::SetMouseCapture(), BLOCK_SELECTOR::SetState(), and STATE_NO_BLOCK.

◆ DrawAndSizingBlockOutlines()

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 176 of file common/legacy_wx/block.cpp.

178 {
180 
181  block->SetMoveVector( wxPoint( 0, 0 ) );
182 
183  if( aErase && aDC ) // Erase current outline
184  block->Draw( aPanel, aDC, wxPoint( 0, 0 ), g_XorMode, block->GetColor() );
185 
186  block->SetLastCursorPosition( aPanel->GetParent()->GetCrossHairPosition() );
187  block->SetEnd( aPanel->GetParent()->GetCrossHairPosition() );
188 
189  if( aDC ) // Draw new outline
190  block->Draw( aPanel, aDC, wxPoint( 0, 0 ), g_XorMode, block->GetColor() );
191 
192  if( block->GetState() == STATE_BLOCK_INIT )
193  {
194  if( block->GetWidth() || block->GetHeight() )
195  // 2nd point exists: the rectangle is not surface anywhere
196  block->SetState( STATE_BLOCK_END );
197  }
198 }
virtual BASE_SCREEN * GetScreen()=0
GR_DRAWMODE g_XorMode
Definition: gr_basic.cpp:74
BLOCK_SELECTOR m_BlockLocate
Block description for block commands.
Definition: base_screen.h:214
virtual EDA_DRAW_FRAME * GetParent() const =0
Definition: solve.cpp:178
wxPoint GetCrossHairPosition(bool aInvertY=false) const
Return the current cross hair position in logical (drawing) coordinates.

References g_XorMode, EDA_DRAW_FRAME::GetCrossHairPosition(), EDA_DRAW_PANEL::GetParent(), EDA_DRAW_PANEL::GetScreen(), BASE_SCREEN::m_BlockLocate, STATE_BLOCK_END, and STATE_BLOCK_INIT.

Referenced by PCB_EDIT_FRAME::HandleBlockEnd().