KiCad PCB EDA Suite
INTERACTIVE_PLACER_BASE Struct Referenceabstract

#include <pcb_tool_base.h>

Public Member Functions

virtual ~INTERACTIVE_PLACER_BASE ()
 
virtual std::unique_ptr< BOARD_ITEMCreateItem ()=0
 
virtual void SnapItem (BOARD_ITEM *aItem)
 
virtual bool PlaceItem (BOARD_ITEM *aItem, BOARD_COMMIT &aCommit)
 

Public Attributes

PCB_BASE_EDIT_FRAMEm_frame
 
BOARDm_board
 
int m_modifiers
 

Detailed Description

Definition at line 52 of file pcb_tool_base.h.

Constructor & Destructor Documentation

◆ ~INTERACTIVE_PLACER_BASE()

virtual INTERACTIVE_PLACER_BASE::~INTERACTIVE_PLACER_BASE ( )
inlinevirtual

Definition at line 54 of file pcb_tool_base.h.

55  {
56  }

Member Function Documentation

◆ CreateItem()

virtual std::unique_ptr<BOARD_ITEM> INTERACTIVE_PLACER_BASE::CreateItem ( )
pure virtual

◆ PlaceItem()

bool INTERACTIVE_PLACER_BASE::PlaceItem ( BOARD_ITEM aItem,
BOARD_COMMIT aCommit 
)
virtual

Definition at line 297 of file pcb_tool_base.cpp.

298 {
299  aCommit.Add( aItem );
300  return true;
301 }
COMMIT & Add(EDA_ITEM *aItem)
Adds a new item to the model
Definition: commit.h:78

References COMMIT::Add().

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement().

◆ SnapItem()

void INTERACTIVE_PLACER_BASE::SnapItem ( BOARD_ITEM aItem)
virtual

Definition at line 291 of file pcb_tool_base.cpp.

292 {
293  // Base implementation performs no snapping
294 }

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement().

Member Data Documentation

◆ m_board

BOARD* INTERACTIVE_PLACER_BASE::m_board

Definition at line 63 of file pcb_tool_base.h.

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement().

◆ m_frame

PCB_BASE_EDIT_FRAME* INTERACTIVE_PLACER_BASE::m_frame

Definition at line 62 of file pcb_tool_base.h.

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement().

◆ m_modifiers

int INTERACTIVE_PLACER_BASE::m_modifiers

Definition at line 64 of file pcb_tool_base.h.

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement().


The documentation for this struct was generated from the following files: