GRAPHIC_EDIT_TOOL::OPERATION Struct Reference

What one edit operation gives the shared interactive loop. More...

Public Attributes
wxString	m_NoResult
wxString	m_CommitDescription
bool(*	m_Accepts )(const PCB_SHAPE &aShape)
	Which shapes may be the source. Anything else is not worth hovering.
std::set< SNAP_CANDIDATE_SUBTYPE >	m_SuppressedSnaps = {}
	Snap kinds this operation cannot use.
int	m_PreviewLayer
	The colour role the preview borrows. Trim marks a removal, extend an addition.
BOX2I(*	m_QueryBounds )(const BOARD_ITEM &aSource, const VECTOR2I &aPointer, const BOX2I &aWorldBounds)
	Null bounds the search by the source's own extent, which only cuts what it crosses.
GRAPHIC_EDIT_RESULT(*	m_Plan )(const BOARD_ITEM &aSource, const VECTOR2I &aPointer, const std::vector< const BOARD_ITEM * > &aBoundaries)

Detailed Description

What one edit operation gives the shared interactive loop.

The loop owns the pointer. It picks a source from under the cursor on every motion, so the operation only has to say which shapes it takes and what to do with one.

Definition at line 47 of file graphic_edit_tool.h.

Member Data Documentation

m_Accepts

bool(* GRAPHIC_EDIT_TOOL::OPERATION::m_Accepts) (const PCB_SHAPE &aShape)

Which shapes may be the source. Anything else is not worth hovering.

Definition at line 53 of file graphic_edit_tool.h.

Referenced by GRAPHIC_EDIT_TOOL::runInteractive().

m_CommitDescription

wxString GRAPHIC_EDIT_TOOL::OPERATION::m_CommitDescription

Definition at line 50 of file graphic_edit_tool.h.

Referenced by GRAPHIC_EDIT_TOOL::runInteractive().

m_NoResult

wxString GRAPHIC_EDIT_TOOL::OPERATION::m_NoResult

Definition at line 49 of file graphic_edit_tool.h.

Referenced by GRAPHIC_EDIT_TOOL::runInteractive().

m_Plan

GRAPHIC_EDIT_RESULT(* GRAPHIC_EDIT_TOOL::OPERATION::m_Plan) (const BOARD_ITEM &aSource, const VECTOR2I &aPointer, const std::vector< const BOARD_ITEM * > &aBoundaries)

Definition at line 65 of file graphic_edit_tool.h.

Referenced by GRAPHIC_EDIT_TOOL::runInteractive().

m_PreviewLayer

int GRAPHIC_EDIT_TOOL::OPERATION::m_PreviewLayer

The colour role the preview borrows. Trim marks a removal, extend an addition.

Definition at line 61 of file graphic_edit_tool.h.

Referenced by GRAPHIC_EDIT_TOOL::runInteractive().

m_QueryBounds

BOX2I(* GRAPHIC_EDIT_TOOL::OPERATION::m_QueryBounds) (const BOARD_ITEM &aSource, const VECTOR2I &aPointer, const BOX2I &aWorldBounds)

Null bounds the search by the source's own extent, which only cuts what it crosses.

Definition at line 64 of file graphic_edit_tool.h.

Referenced by GRAPHIC_EDIT_TOOL::runInteractive().

m_SuppressedSnaps

std::set<SNAP_CANDIDATE_SUBTYPE> GRAPHIC_EDIT_TOOL::OPERATION::m_SuppressedSnaps = {}

Snap kinds this operation cannot use.

Trim reads which side of a crossing the pointer is on, so a snap derived from one leaves the question no answer. Empty unless the operation says otherwise.

Definition at line 58 of file graphic_edit_tool.h.

Referenced by GRAPHIC_EDIT_TOOL::runInteractive().

---

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

• graphic_edit_tool.h